Module com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Class OptionsPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.GridPane

com.dua3.utility.fx.controls.OptionsPane

All Implemented Interfaces:

InputControl<com.dua3.utility.options.Arguments>, Styleable, EventTarget

public class OptionsPane
extends GridPane
implements InputControl<com.dua3.utility.options.Arguments>

OptionsPane is a custom JavaFX GridPane used as a control element for managing a collection of options represented by instances of the Option class. It implements the InputControl interface which allows it to handle input and provide output in the form of Arguments.

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<com.dua3.utility.options.Arguments>	value	Provides the property representing the value of this input control.

Properties inherited from class javafx.scene.layout.GridPane

alignment, gridLinesVisible, hgap, vgap

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

Modifier and Type	Field	Description
protected static final org.apache.logging.log4j.Logger	LOG	Logger

Fields inherited from class javafx.scene.layout.GridPane

REMAINING

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
OptionsPane(Collection<com.dua3.utility.options.Option<?>> optionSet, com.dua3.utility.options.Arguments currentValues)	Create new OptionsPane.
OptionsPane(Supplier<? extends Collection<com.dua3.utility.options.Option<?>>> options, Supplier<com.dua3.utility.options.Arguments> dflt)	Constructs a new OptionsPane with the given suppliers for options and default arguments.

Method Summary

Modifier and Type	Method	Description
ReadOnlyStringProperty	errorProperty()	Provides a read-only property representing the error message for this input control.
com.dua3.utility.options.Arguments	get()	Get value.
void	init()	Set/update control state.
Node	node()	Get the Node for this input element.
void	reset()	Reset value to default
void	set(com.dua3.utility.options.Arguments arg)	Set value.
ReadOnlyBooleanProperty	validProperty()	Provides a read-only property representing the validity of the input.
Property<com.dua3.utility.options.Arguments>	valueProperty()	Provides the property representing the value of this input control.

Methods inherited from class javafx.scene.layout.GridPane

add, add, addColumn, addRow, alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getCellBounds, getClassCssMetaData, getColumnConstraints, getColumnCount, getColumnIndex, getColumnSpan, getContentBias, getCssMetaData, getHalignment, getHgap, getHgrow, getMargin, getRowConstraints, getRowCount, getRowIndex, getRowSpan, getValignment, getVgap, getVgrow, gridLinesVisibleProperty, hgapProperty, isFillHeight, isFillWidth, isGridLinesVisible, layoutChildren, requestLayout, setAlignment, setColumnIndex, setColumnSpan, setConstraints, setConstraints, setConstraints, setConstraints, setConstraints, setFillHeight, setFillWidth, setGridLinesVisible, setHalignment, setHgap, setHgrow, setMargin, setRowIndex, setRowSpan, setValignment, setVgap, setVgrow, toString, vgapProperty

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, 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

getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, 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, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, 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, 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

isValid

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

value

public Property<com.dua3.utility.options.Arguments> valueProperty

Specified by:

valueProperty in interface InputControl<com.dua3.utility.options.Arguments>

valid

public ReadOnlyBooleanProperty validProperty

Specified by:

validProperty in interface InputControl<com.dua3.utility.options.Arguments>

See Also:

• InputControl.isValid()

error

public ReadOnlyStringProperty errorProperty

Specified by:

errorProperty in interface InputControl<com.dua3.utility.options.Arguments>

Field Details

LOG

protected static final org.apache.logging.log4j.Logger LOG

Logger

Constructor Details

OptionsPane

public OptionsPane(Collection<com.dua3.utility.options.Option<?>> optionSet,
 com.dua3.utility.options.Arguments currentValues)

Create new OptionsPane.

Parameters:

optionSet - the available options

currentValues - the current values

See Also:

• Option
• Arguments

OptionsPane

public OptionsPane(Supplier<? extends Collection<com.dua3.utility.options.Option<?>>> options,
 Supplier<com.dua3.utility.options.Arguments> dflt)

Constructs a new OptionsPane with the given suppliers for options and default arguments.

Parameters:

options - A supplier providing a collection of options.

dflt - A supplier providing the default arguments.

See Also:

• Option
• Arguments

Method Details

node

public Node node()

Description copied from interface: InputControl

Get the Node for this input element.

Specified by:

node in interface InputControl<com.dua3.utility.options.Arguments>

Returns:

the node

get

public com.dua3.utility.options.Arguments get()

Description copied from interface: InputControl

Get value.

Specified by:

get in interface InputControl<com.dua3.utility.options.Arguments>

Returns:

the current value

set

public void set(com.dua3.utility.options.Arguments arg)

Description copied from interface: InputControl

Set value.

Specified by:

set in interface InputControl<com.dua3.utility.options.Arguments>

Parameters:

arg - the value to set

init

public void init()

Description copied from interface: InputControl

Set/update control state.

Specified by:

init in interface InputControl<com.dua3.utility.options.Arguments>

reset

public void reset()

Description copied from interface: InputControl

Reset value to default

Specified by:

reset in interface InputControl<com.dua3.utility.options.Arguments>

valueProperty

public Property<com.dua3.utility.options.Arguments> valueProperty()

Description copied from interface: InputControl

Provides the property representing the value of this input control.

Specified by:

valueProperty in interface InputControl<com.dua3.utility.options.Arguments>

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<com.dua3.utility.options.Arguments>

See Also:

• InputControl.isValid()

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<com.dua3.utility.options.Arguments>