Module com.dlsc.pickerfx
Package com.dlsc.pickerfx

Class Picker<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.pickerfx.Picker<T>
Type Parameters:
T - the type of the items displayed by the picker.
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
Direct Known Subclasses:
DurationPicker, IntegerPicker, ItemPicker, LocalDatePicker, LocalDateTimePicker, LocalTimePicker
public abstract class Picker<T>
extends javafx.scene.control.Control
The base class of all picker controls.

  • Property Summary

    Properties 
    Type Property Description
    javafx.beans.property.DoubleProperty cellSize
    Controls the width / height of the picker cells.
    javafx.beans.property.DoubleProperty indicatorSize
    Specifies the height / width of the indicator glass node.
    javafx.beans.property.ReadOnlyBooleanProperty invalid
    A flag used to signal whether the current settings made by the user define a valid or invalid value.
    javafx.beans.property.ObjectProperty<javafx.geometry.Orientation> orientation
    Controls the orientation of the picker (horizontal, vertical).
    javafx.beans.property.BooleanProperty readOnly
    A flag used to mark the picker as a "read-only" picker.
    javafx.beans.property.BooleanProperty showIndicator
    Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.
    javafx.beans.property.ObjectProperty<T> value
    The value currently specified by the picker.

    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

  • Field Summary

    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 
    Modifier Constructor Description
    protected Picker()  

  • Method Summary

    Modifier and Type Method Description
    javafx.beans.property.DoubleProperty cellSizeProperty()
    Controls the width / height of the picker cells.
    double getCellSize()
    Gets the value of the property cellSize.
    static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getClassCssMetaData()  
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getControlCssMetaData()  
    double getIndicatorSize()
    Gets the value of the property indicatorSize.
    javafx.geometry.Orientation getOrientation()
    Gets the value of the property orientation.
    T getValue()
    Gets the value of the property value.
    javafx.beans.property.DoubleProperty indicatorSizeProperty()
    Specifies the height / width of the indicator glass node.
    javafx.beans.property.ReadOnlyBooleanProperty invalidProperty()
    A flag used to signal whether the current settings made by the user define a valid or invalid value.
    boolean isInvalid()
    Gets the value of the property invalid.
    boolean isReadOnly()
    Gets the value of the property readOnly.
    boolean isShowIndicator()
    Gets the value of the property showIndicator.
    javafx.beans.property.ObjectProperty<javafx.geometry.Orientation> orientationProperty()
    Controls the orientation of the picker (horizontal, vertical).
    javafx.beans.property.BooleanProperty readOnlyProperty()
    A flag used to mark the picker as a "read-only" picker.
    void setCellSize​(double value)
    Sets the value of the property cellSize.
    void setIndicatorSize​(double value)
    Sets the value of the property indicatorSize.
    void setOrientation​(javafx.geometry.Orientation value)
    Sets the value of the property orientation.
    void setReadOnly​(boolean readOnly)
    Sets the value of the property readOnly.
    void setShowIndicator​(boolean showIndicator)
    Sets the value of the property showIndicator.
    void setValue​(T value)
    Sets the value of the property value.
    javafx.beans.property.BooleanProperty showIndicatorProperty()
    Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.
    javafx.beans.property.ObjectProperty<T> valueProperty()
    The value currently specified by the picker.

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, executeAccessibleAction, getBaselineOffset, getContextMenu, 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 javafx.css.Styleable

    getStyleableNode

  • Property Details

    • value

      public final javafx.beans.property.ObjectProperty<T> valueProperty
      The value currently specified by the picker.
      See Also:
      getValue(), setValue(T)

    • invalid

      public final javafx.beans.property.ReadOnlyBooleanProperty invalidProperty
      A flag used to signal whether the current settings made by the user define a valid or invalid value. E.g. in the {@see LocalDatePicker} the date set by the user could be February 30th, hence "invalid" as this date never exists.
      See Also:
      isInvalid()

    • readOnly

      public final javafx.beans.property.BooleanProperty readOnlyProperty
      A flag used to mark the picker as a "read-only" picker. The user will not be able to change the value.
      See Also:
      isReadOnly(), setReadOnly(boolean)

    • showIndicator

      public javafx.beans.property.BooleanProperty showIndicatorProperty
      Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.
      See Also:
      isShowIndicator(), setShowIndicator(boolean)

    • indicatorSize

      public final javafx.beans.property.DoubleProperty indicatorSizeProperty
      Specifies the height / width of the indicator glass node.
      See Also:
      getIndicatorSize(), setIndicatorSize(double)

    • orientation

      public final javafx.beans.property.ObjectProperty<javafx.geometry.Orientation> orientationProperty
      Controls the orientation of the picker (horizontal, vertical).
      See Also:
      getOrientation(), setOrientation(Orientation)

    • cellSize

      public final javafx.beans.property.DoubleProperty cellSizeProperty
      Controls the width / height of the picker cells.
      See Also:
      getCellSize(), setCellSize(double)

  • Constructor Details

  • Method Details

    • valueProperty

      public final javafx.beans.property.ObjectProperty<T> valueProperty()
      The value currently specified by the picker.
      See Also:
      getValue(), setValue(T)

    • getValue

      public final T getValue()
      Gets the value of the property value.
      Property description:
      The value currently specified by the picker.

    • setValue

      public final void setValue​(T value)
      Sets the value of the property value.
      Property description:
      The value currently specified by the picker.

    • invalidProperty

      public final javafx.beans.property.ReadOnlyBooleanProperty invalidProperty()
      A flag used to signal whether the current settings made by the user define a valid or invalid value. E.g. in the {@see LocalDatePicker} the date set by the user could be February 30th, hence "invalid" as this date never exists.
      See Also:
      isInvalid()

    • isInvalid

      public final boolean isInvalid()
      Gets the value of the property invalid.
      Property description:
      A flag used to signal whether the current settings made by the user define a valid or invalid value. E.g. in the {@see LocalDatePicker} the date set by the user could be February 30th, hence "invalid" as this date never exists.

    • readOnlyProperty

      public final javafx.beans.property.BooleanProperty readOnlyProperty()
      A flag used to mark the picker as a "read-only" picker. The user will not be able to change the value.
      See Also:
      isReadOnly(), setReadOnly(boolean)

    • isReadOnly

      public final boolean isReadOnly()
      Gets the value of the property readOnly.
      Property description:
      A flag used to mark the picker as a "read-only" picker. The user will not be able to change the value.

    • setReadOnly

      public final void setReadOnly​(boolean readOnly)
      Sets the value of the property readOnly.
      Property description:
      A flag used to mark the picker as a "read-only" picker. The user will not be able to change the value.

    • isShowIndicator

      public boolean isShowIndicator()
      Gets the value of the property showIndicator.
      Property description:
      Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.

    • showIndicatorProperty

      public javafx.beans.property.BooleanProperty showIndicatorProperty()
      Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.
      See Also:
      isShowIndicator(), setShowIndicator(boolean)

    • setShowIndicator

      public void setShowIndicator​(boolean showIndicator)
      Sets the value of the property showIndicator.
      Property description:
      Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.

    • indicatorSizeProperty

      public final javafx.beans.property.DoubleProperty indicatorSizeProperty()
      Specifies the height / width of the indicator glass node.
      See Also:
      getIndicatorSize(), setIndicatorSize(double)

    • setIndicatorSize

      public final void setIndicatorSize​(double value)
      Sets the value of the property indicatorSize.
      Property description:
      Specifies the height / width of the indicator glass node.

    • getIndicatorSize

      public final double getIndicatorSize()
      Gets the value of the property indicatorSize.
      Property description:
      Specifies the height / width of the indicator glass node.

    • setOrientation

      public final void setOrientation​(javafx.geometry.Orientation value)
      Sets the value of the property orientation.
      Property description:
      Controls the orientation of the picker (horizontal, vertical).

    • getOrientation

      public final javafx.geometry.Orientation getOrientation()
      Gets the value of the property orientation.
      Property description:
      Controls the orientation of the picker (horizontal, vertical).

    • orientationProperty

      public final javafx.beans.property.ObjectProperty<javafx.geometry.Orientation> orientationProperty()
      Controls the orientation of the picker (horizontal, vertical).
      See Also:
      getOrientation(), setOrientation(Orientation)

    • cellSizeProperty

      public final javafx.beans.property.DoubleProperty cellSizeProperty()
      Controls the width / height of the picker cells.
      See Also:
      getCellSize(), setCellSize(double)

    • setCellSize

      public final void setCellSize​(double value)
      Sets the value of the property cellSize.
      Property description:
      Controls the width / height of the picker cells.

    • getCellSize

      public final double getCellSize()
      Gets the value of the property cellSize.
      Property description:
      Controls the width / height of the picker cells.

    • getClassCssMetaData

      public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getClassCssMetaData()

    • getControlCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class javafx.scene.control.Control