Package pamViewFX.fxNodes.picker

Class NumberSpinner

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.TextInputControl
javafx.scene.control.TextField
pamViewFX.fxNodes.picker.NumberSpinner
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public final class NumberSpinner extends javafx.scene.control.TextField
The number spinner allows users to select a number by spinning through a range of numbers.

The range of numbers can be limited by a min and max value.

Screenshots

Sample Usage

 
 NumberSpinner numberSpinner = new NumberSpinner();
 numberSpinner.setMaxValue(100);
 numberSpinner.setMinValue(-100);
 numberSpinner.setStepWidth(0.1);
 numberSpinner.setAlignment(Pos.CENTER_RIGHT);
Author:
Christian Schudt

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ObjectProperty<javafx.geometry.HPos>
    hAlignment
    The horizontal alignment of the text field.
    final javafx.beans.property.ObjectProperty<Number>
    maxValue
    The max value property.
    final javafx.beans.property.ObjectProperty<Number>
    minValue
    The min value property.
    final javafx.beans.property.ObjectProperty<javafx.util.converter.NumberStringConverter>
    numberStringConverter
    The number string converter property.
    final javafx.beans.property.ObjectProperty<Number>
    stepWidth
    The step width property.
    final javafx.beans.property.ObjectProperty<Number>
    value
    The value property.

    Properties inherited from class javafx.scene.control.TextField

    alignment, onAction, prefColumnCount

    Properties inherited from class javafx.scene.control.TextInputControl

    anchor, caretPosition, editable, font, length, promptText, redoable, selectedText, selection, textFormatter, text, undoable

    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, 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

  • Field Summary

    Fields inherited from class javafx.scene.control.TextField

    DEFAULT_PREF_COLUMN_COUNT

    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
    NumberSpinner()
    Default constructor.
    NumberSpinner(Number minValue, Number maxValue)
    Creates the number spinner with a min and max value.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    decrement()
    Decrements the value by the value specified by stepWidthProperty().
    javafx.geometry.HPos
    getHAlignment()
    Gets the horizontal alignment of the text field.
    final Number
    getMaxValue()
    Gets the max value.
    final Number
    getMinValue()
    Gets the min value.
    final javafx.util.converter.NumberStringConverter
    getNumberStringConverter()
    Gets the number string converter.
    final Number
    getStepWidth()
    Gets the step width.
    String
    getUserAgentStylesheet()
     
    final Number
    getValue()
    Gets the value.
    javafx.beans.property.ObjectProperty<javafx.geometry.HPos>
    hAlignmentProperty()
    The horizontal alignment of the text field.
    void
    increment()
    Increments the value by the value specified by stepWidthProperty().
    final javafx.beans.property.ObjectProperty<Number>
    maxValueProperty()
    The max value property.
    final javafx.beans.property.ObjectProperty<Number>
    minValueProperty()
    The min value property.
    final javafx.beans.property.ObjectProperty<javafx.util.converter.NumberStringConverter>
    numberStringConverterProperty()
    The number string converter property.
    void
    setHAlignment(javafx.geometry.HPos hAlignment)
    The horizontal alignment of the text field.
    final void
    setMaxValue(Number maxValue)
    Sets the max value.
    final void
    setMinValue(Number minValue)
    Sets the min value.
    final void
    setNumberStringConverter(javafx.util.converter.NumberStringConverter numberStringConverter)
    Sets the number format.
    final void
    setStepWidth(Number stepWidth)
    Sets the step width.
    final void
    setValue(Number value)
    Sets the value.
    final javafx.beans.property.ObjectProperty<Number>
    stepWidthProperty()
    The step width property.
    final javafx.beans.property.ObjectProperty<Number>
    valueProperty()
    The value property.

    Methods inherited from class javafx.scene.control.TextField

    alignmentProperty, getAlignment, getCharacters, getClassCssMetaData, getControlCssMetaData, getOnAction, getPrefColumnCount, onActionProperty, prefColumnCountProperty, setAlignment, setOnAction, setPrefColumnCount

    Methods inherited from class javafx.scene.control.TextInputControl

    anchorProperty, appendText, backward, cancelEdit, caretPositionProperty, clear, commitValue, copy, cut, deleteNextChar, deletePreviousChar, deleteText, deleteText, deselect, editableProperty, end, endOfNextWord, executeAccessibleAction, extendSelection, fontProperty, forward, getAnchor, getCaretPosition, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, getTextFormatter, home, insertText, isEditable, isRedoable, isUndoable, lengthProperty, nextWord, paste, positionCaret, previousWord, promptTextProperty, queryAccessibleAttribute, redo, redoableProperty, replaceSelection, replaceText, replaceText, selectAll, selectBackward, selectedTextProperty, selectEnd, selectEndOfNextWord, selectForward, selectHome, selectionProperty, selectNextWord, selectPositionCaret, selectPreviousWord, selectRange, setEditable, setFont, setPromptText, setText, setTextFormatter, textFormatterProperty, textProperty, undo, undoableProperty

    Methods inherited from class javafx.scene.control.Control

    contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, isResizable, 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, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPositionX, snapPositionY, snapSizeX, snapSizeY, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getChildrenUnmodifiable, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout

    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, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, setEffect, setEventDispatcher, setFocusTraversable, 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, 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

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • Constructor Details

    • NumberSpinner

      public NumberSpinner()
      Default constructor. It aligns the text right and set a default StringConverter.

    • NumberSpinner

      public NumberSpinner(Number minValue, Number maxValue)
      Creates the number spinner with a min and max value.
      Parameters:
      minValue - The min value.
      maxValue - The max value.

  • Method Details

    • valueProperty

      public final javafx.beans.property.ObjectProperty<Number> valueProperty()
      The value property. The value can also be null or Double.NaN or other non-finite values, in order to empty the text field.
      Returns:
      The value property.
      See Also:

    • getValue

      public final Number getValue()
      Gets the value.
      Returns:
      The value.
      See Also:

    • setValue

      public final void setValue(Number value)
      Sets the value.
      Parameters:
      value - The value.
      See Also:

    • maxValueProperty

      public final javafx.beans.property.ObjectProperty<Number> maxValueProperty()
      The max value property.
      Returns:
      The property.
      See Also:

    • getMaxValue

      public final Number getMaxValue()
      Gets the max value.
      Returns:
      The max value.
      See Also:

    • setMaxValue

      public final void setMaxValue(Number maxValue)
      Sets the max value.
      Parameters:
      maxValue - The max value.
      Throws:
      IllegalArgumentException - If the max value is smaller than the min value.
      See Also:

    • minValueProperty

      public final javafx.beans.property.ObjectProperty<Number> minValueProperty()
      The min value property.
      Returns:
      The property.
      See Also:

    • getMinValue

      public final Number getMinValue()
      Gets the min value.
      Returns:
      The min value.
      See Also:

    • setMinValue

      public final void setMinValue(Number minValue)
      Sets the min value.
      Parameters:
      minValue - The min value.
      Throws:
      IllegalArgumentException - If the min value is greater than the max value.
      See Also:

    • stepWidthProperty

      public final javafx.beans.property.ObjectProperty<Number> stepWidthProperty()
      The step width property. Specifies the interval by which the value is incremented or decremented.
      Returns:
      The step width property.
      See Also:

    • getStepWidth

      public final Number getStepWidth()
      Gets the step width.
      Returns:
      The step width.
      See Also:

    • setStepWidth

      public final void setStepWidth(Number stepWidth)
      Sets the step width.
      Parameters:
      stepWidth - The step width.
      See Also:

    • numberStringConverterProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.converter.NumberStringConverter> numberStringConverterProperty()
      The number string converter property.
      Returns:
      The number string converter property.
      See Also:

    • getNumberStringConverter

      public final javafx.util.converter.NumberStringConverter getNumberStringConverter()
      Gets the number string converter.
      Returns:
      The number string converter.
      See Also:

    • setNumberStringConverter

      public final void setNumberStringConverter(javafx.util.converter.NumberStringConverter numberStringConverter)
      Sets the number format.
      Parameters:
      numberStringConverter - The number format.
      See Also:

    • hAlignmentProperty

      public javafx.beans.property.ObjectProperty<javafx.geometry.HPos> hAlignmentProperty()
      The horizontal alignment of the text field. It can either be aligned left or right to the buttons or in between them (center).
      Returns:
      The property.
      See Also:

    • getHAlignment

      public javafx.geometry.HPos getHAlignment()
      Gets the horizontal alignment of the text field.
      Returns:
      The alignment.
      See Also:

    • setHAlignment

      public void setHAlignment(javafx.geometry.HPos hAlignment)
      The horizontal alignment of the text field.
      Parameters:
      hAlignment - The alignment.
      See Also:

    • increment

      public void increment()
      Increments the value by the value specified by stepWidthProperty().

    • decrement

      public void decrement()
      Decrements the value by the value specified by stepWidthProperty().

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region