Module com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Class 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

All Implemented Interfaces:

InputControl<Path>, Styleable, EventTarget, Skinnable

public class FileInput
extends CustomControl<HBox>
implements InputControl<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.

Property Summary

Properties

Type	Property	Description
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<Path>	value	Provides the property representing the value of this input control.

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

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

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.dua3.utility.fx.controls.InputControl

InputControl.State<R>

Field Summary

Fields inherited from class com.dua3.utility.fx.controls.CustomControl

container

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Function<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<Path>	valueProperty()	Provides the property representing the value of this input control.

Methods inherited from class com.dua3.utility.fx.controls.CustomControl

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

Methods inherited from class javafx.scene.control.Control

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

Methods inherited from class 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

Methods inherited from class javafx.scene.Parent

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

Methods inherited from class 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, 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, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dua3.utility.fx.controls.InputControl

get, init, isValid, set

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

value

public Property<Path> valueProperty

Specified by:

valueProperty in interface InputControl<Path>

Returns:

the property containing the current value

valid

public ReadOnlyBooleanProperty validProperty

Specified by:

validProperty in interface InputControl<Path>

Returns:

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

error

public ReadOnlyStringProperty errorProperty

Specified by:

errorProperty in interface InputControl<Path>

Returns:

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

Constructor Details

FileInput

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

Constructs a FileInput instance with specified parameters.

Parameters:

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

Method Details

defaultValidate

public static Function<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.

Parameters:

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

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

Returns:

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()

Description copied from interface: InputControl

Get the Node for this input element.

Specified by:

node in interface InputControl<Path>

Returns:

the node

reset

public void reset()

Description copied from interface: InputControl

Reset value to default

Specified by:

reset in interface InputControl<Path>

valueProperty

public Property<Path> valueProperty()

Description copied from interface: InputControl

Provides the property representing the value of this input control.

Specified by:

valueProperty in interface InputControl<Path>

Returns:

the property containing the current value

validProperty

public ReadOnlyBooleanProperty validProperty()

Description copied from interface: InputControl

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

Specified by:

validProperty in interface InputControl<Path>

Returns:

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

errorProperty

public ReadOnlyStringProperty errorProperty()

Description copied from interface: 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.

Specified by:

errorProperty in interface InputControl<Path>

Returns:

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