Modul com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Klasse FileInput

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

com.dua3.utility.fx.controls.CustomControl<HBox>

com.dua3.utility.fx.controls.FileInput

Alle implementierten Schnittstellen:

InputControl<@Nullable Path>, Styleable, EventTarget, Skinnable

public class FileInput
extends CustomControl<HBox>
implements InputControl<@Nullable Path>

FileInput is a custom control for selecting files using a FileChooser dialog. It is composed of a TextField that contains the file path and a button that opens a FileChooser to select a file.

The control can operate in different modes: OPEN, SAVE, or DIRECTORY, as specified by the FileDialogMode.

The control also includes properties for error messages and validation status. These properties are updated based on the path selected by the user and the specified validation function.

Eigenschaftsübersicht

Eigenschaften

Typ	Eigenschaft	Beschreibung
ReadOnlyStringProperty	error	Provides a read-only property representing the error message for this input control.
ReadOnlyBooleanProperty	valid	Provides a read-only property representing the validity of the input.
Property<@Nullable Path>	value	Provides the property representing the value of this input control.

Von Klasse geerbte Eigenschaften javafx.scene.control.Control

contextMenu, skin, tooltip

Von Klasse geerbte Eigenschaften javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Von Klasse geerbte Eigenschaften javafx.scene.Parent

needsLayout

Von Klasse geerbte Eigenschaften javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen com.dua3.utility.fx.controls.InputControl

InputControl.State<R>

Feldübersicht

Von Klasse geerbte Felder com.dua3.utility.fx.controls.CustomControl

container

Von Klasse geerbte Felder javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Von Klasse geerbte Felder javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
FileInput(FileDialogMode mode, boolean existingOnly, Supplier<Path> dflt, Collection<FileChooser.ExtensionFilter> filters, Function<@Nullable Path,Optional<String>> validate)	Constructs a FileInput instance with specified parameters.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static Function<@Nullable Path,Optional<String>>	defaultValidate(FileDialogMode mode, boolean existingOnly)	Returns a function object that validates the file selection based on the specified file dialog mode and whether only existing files or directories are allowed.
ReadOnlyStringProperty	errorProperty()	Provides a read-only property representing the error message for this input control.
Node	node()	Get the Node for this input element.
void	reset()	Reset value to default
ReadOnlyBooleanProperty	validProperty()	Provides a read-only property representing the validity of the input.
Property<@Nullable Path>	valueProperty()	Provides the property representing the value of this input control.

Von Klasse geerbte Methoden com.dua3.utility.fx.controls.CustomControl

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, createDefaultSkin

Von Klasse geerbte Methoden javafx.scene.control.Control

contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Von Klasse geerbte Methoden javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Von Klasse geerbte Methoden javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Von Klasse geerbte Methoden javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden com.dua3.utility.fx.controls.InputControl

get, init, isValid, set

Von Schnittstelle geerbte Methoden javafx.css.Styleable

getStyleableNode

Eigenschaftsdetails

value

public Property<@Nullable Path> valueProperty

Angegeben von:

valueProperty in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

the property containing the current value

Siehe auch:

• valueProperty()

valid

public ReadOnlyBooleanProperty validProperty

Angegeben von:

validProperty in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

a ReadOnlyBooleanProperty that is true if the input is valid and false otherwise

Siehe auch:

• validProperty()

error

public ReadOnlyStringProperty errorProperty

Angegeben von:

errorProperty in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

a ReadOnlyStringProperty containing the error message if there is a validation error, otherwise empty

Siehe auch:

• errorProperty()

Konstruktordetails

FileInput

public FileInput(FileDialogMode mode,
 boolean existingOnly,
 Supplier<Path> dflt,
 Collection<FileChooser.ExtensionFilter> filters,
 Function<@Nullable Path,Optional<String>> validate)

Constructs a FileInput instance with specified parameters.

Parameter:

mode - the mode of the file dialog, which can be OPEN, SAVE, or DIRECTORY

existingOnly - boolean indicating whether only existing files or directories should be selectable

dflt - a supplier providing the default path

filters - collection of file extension filters to apply in the file chooser

validate - a function to validate the selected file path, returning an optional error message

Methodendetails

defaultValidate

public static Function<@Nullable Path,Optional<String>> defaultValidate(FileDialogMode mode,
 boolean existingOnly)

Returns a function object that validates the file selection based on the specified file dialog mode and whether only existing files or directories are allowed.

The returned function object is for example used in InputBuilder.chooseFile(String, String, Supplier, FileDialogMode, boolean, Collection) to add validation.

Parameter:

mode - the mode of the file dialog; can be OPEN, SAVE, or DIRECTORY

existingOnly - indicates whether only existing files or directories should be selectable

Gibt zurück:

a function that takes a Path and returns an Optional containing an error message if validation fails, or an empty Optional if validation succeeds

node

public Node node()

Beschreibung aus Schnittstelle kopiert: InputControl

Get the Node for this input element.

Angegeben von:

node in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

the node

reset

public void reset()

Beschreibung aus Schnittstelle kopiert: InputControl

Reset value to default

Angegeben von:

reset in Schnittstelle InputControl<@Nullable Path>

valueProperty

public Property<@Nullable Path> valueProperty()

Beschreibung aus Schnittstelle kopiert: InputControl

Provides the property representing the value of this input control.

Angegeben von:

valueProperty in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

die Eigenschaft value

validProperty

public ReadOnlyBooleanProperty validProperty()

Beschreibung aus Schnittstelle kopiert: InputControl

Provides a read-only property representing the validity of the input.

Angegeben von:

validProperty in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

die Eigenschaft valid

errorProperty

public ReadOnlyStringProperty errorProperty()

Beschreibung aus Schnittstelle kopiert: InputControl

Provides a read-only property representing the error message for this input control.

This property contains an error message if the input is invalid, otherwise it is empty.

Angegeben von:

errorProperty in Schnittstelle InputControl<@Nullable Path>

Gibt zurück:

die Eigenschaft error