jfxtras.scene.control

Class ListSpinner<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

jfxtras.scene.control.ListSpinner<T>

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class ListSpinner<T>
extends javafx.scene.control.Control

This is a spinner, showing one value at a time from a list. This value is set and retrieved through the value property. Basically a spinner shows a list of values and can do a "next" or "previous".

A spinner can be editable, the user can then type a value instead of selecting it. If the value exists in the list, the spinner will simply jump to it. If the value does not exist, the AddCallback is called if defined.

• If the AddCallback returns null, spinner will only refresh the current index.

• If the AddCallback returns an Integer, spinner will jump to that index (usually the index where the new value was added to the list).

In the default skin you can style the text in the control using CSS like so:

.ListSpinner .value {
    -fx-font-weight: bold;
}

The "value" class applies to the text in both readonly and editable spinners, use the "readonly" or "editable" class to style either mode specifically. There is a left-arrow, right-arrow, up-arrow and down-arrow class that uses a SVG path to draw the arrow, this can be overridden with another SVG to draw a different shape.

The default skin has a number of styleable properies which use the text representation of an enum for their value:

.ListSpinner {
    -fxx-arrow-position: {LEADING, TRAILING, SPLIT}
    -fxx-arrow-direction: {VERTICAL, HORIZONTAL}
    -fxx-value-alignment: see javafx.geometry.Pos (https://docs.oracle.com/javase/8/javafx/api/javafx/geometry/Pos.html)
}

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<javafx.util.Callback<T,java.lang.Integer>>	addCallback AddCallback: this callback is called in editable mode when a value is entered that is not found in the list.
javafx.beans.property.ObjectProperty<javafx.util.Callback<ListSpinner<T>,javafx.scene.Node>>	cellFactory CellFactory: generate the cell to render a value
javafx.beans.property.ObjectProperty<java.lang.Boolean>	cyclic Cyclic: what happens at the beginning or end of the list, stop or cycle to the other end.
javafx.beans.property.ObjectProperty<java.lang.Boolean>	editable Editable: is the listspinner editable.
javafx.beans.property.ObjectProperty<java.lang.Integer>	index Index: the currently show index in the list.
javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<T>>	items Items: the list.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<ListSpinner.CycleEvent>>	onCycle OnCycle: callback for when the list cycles to the other end in cyclic mode (for example to increase a year when a month ListSpinner skips from December to January)
javafx.beans.property.ObjectProperty<java.lang.String>	postfix Postfix: a string to be placed after the value, this can for example be a unit like "kg"
javafx.beans.property.ObjectProperty<java.lang.String>	prefix Prefix: a string to be placed before the list value, this can for example be a currency
javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>>	stringConverter StringConverter<T>: convert a value in the list to its string representation and (when in edit mode) vice versa.
javafx.beans.property.ObjectProperty<T>	value Value: the currently show value of the list.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListSpinner.CycleDirection
static class	ListSpinner.CycleEvent CycleEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ONCYCLE_PROPERTY_ID

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 and Description
ListSpinner()
ListSpinner(int from, int to)
ListSpinner(int from, int to, int step)
ListSpinner(java.util.List<T> list)
ListSpinner(javafx.collections.ObservableList<T> items)
ListSpinner(javafx.collections.ObservableList<T> items, T startValue)
ListSpinner(T... list)

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<javafx.util.Callback<T,java.lang.Integer>>	addCallbackProperty() AddCallback: this callback is called in editable mode when a value is entered that is not found in the list.
javafx.beans.property.ObjectProperty<javafx.util.Callback<ListSpinner<T>,javafx.scene.Node>>	cellFactoryProperty() CellFactory: generate the cell to render a value
javafx.scene.control.Skin<?>	createDefaultSkin()
javafx.beans.property.ObjectProperty<java.lang.Boolean>	cyclicProperty() Cyclic: what happens at the beginning or end of the list, stop or cycle to the other end.
void	decrement()
javafx.beans.property.ObjectProperty<java.lang.Boolean>	editableProperty() Editable: is the listspinner editable.
static boolean	equals(java.lang.Object o1, java.lang.Object o2) Does a o1.equals(o2) but also checks if o1 or o2 are null.
void	fireCycleEvent(ListSpinner.CycleDirection cycleDirection) we’re cycling, fire the event
void	first()
javafx.util.Callback<T,java.lang.Integer>	getAddCallback()
javafx.util.Callback<ListSpinner<T>,javafx.scene.Node>	getCellFactory()
java.lang.Integer	getIndex()
javafx.collections.ObservableList<T>	getItems()
javafx.event.EventHandler<ListSpinner.CycleEvent>	getOnCycle()
java.lang.String	getPostfix()
java.lang.String	getPrefix()
javafx.util.StringConverter<T>	getStringConverter()
java.lang.String	getUserAgentStylesheet() Return the path to the CSS file so things are setup right
T	getValue()
void	increment()
javafx.beans.property.ObjectProperty<java.lang.Integer>	indexProperty() Index: the currently show index in the list.
java.lang.Boolean	isCyclic()
java.lang.Boolean	isEditable()
javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<T>>	itemsProperty() Items: the list.
void	last() Get the last index; if the data provide is endless, this method mail fail!
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<ListSpinner.CycleEvent>>	onCycleProperty() OnCycle: callback for when the list cycles to the other end in cyclic mode (for example to increase a year when a month ListSpinner skips from December to January)
javafx.beans.property.ObjectProperty<java.lang.String>	postfixProperty() Postfix: a string to be placed after the value, this can for example be a unit like "kg"
javafx.beans.property.ObjectProperty<java.lang.String>	prefixProperty() Prefix: a string to be placed before the list value, this can for example be a currency
void	setAddCallback(javafx.util.Callback<T,java.lang.Integer> value)
void	setCellFactory(javafx.util.Callback<ListSpinner<T>,javafx.scene.Node> value)
void	setCyclic(java.lang.Boolean value)
void	setEditable(java.lang.Boolean value)
void	setIndex(java.lang.Integer value)
void	setItems(javafx.collections.ObservableList<T> value)
void	setOnCycle(javafx.event.EventHandler<ListSpinner.CycleEvent> value)
void	setPostfix(java.lang.String value)
void	setPrefix(java.lang.String value)
void	setStringConverter(javafx.util.StringConverter<T> value)
void	setValue(T value)
javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>>	stringConverterProperty() StringConverter<T>: convert a value in the list to its string representation and (when in edit mode) vice versa.
javafx.beans.property.ObjectProperty<T>	valueProperty() Value: the currently show value of the list.
ListSpinner<T>	withAddCallback(javafx.util.Callback<T,java.lang.Integer> value)
ListSpinner<T>	withCellFactory(javafx.util.Callback<ListSpinner<T>,javafx.scene.Node> value)
ListSpinner<T>	withCyclic(java.lang.Boolean value)
ListSpinner<T>	withEditable(java.lang.Boolean value)
ListSpinner<T>	withId(java.lang.String value) Id
ListSpinner<T>	withIndex(java.lang.Integer value)
ListSpinner<T>	withItems(javafx.collections.ObservableList<T> value)
ListSpinner<T>	withOnCycle(javafx.event.EventHandler<ListSpinner.CycleEvent> value)
ListSpinner<T>	withPostfix(java.lang.String value)
ListSpinner<T>	withPrefix(java.lang.String value)
ListSpinner<T>	withStringConverter(javafx.util.StringConverter<T> value)
ListSpinner<T>	withValue(T value)

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, 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, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, screenToLocal, screenToLocal, screenToLocal, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

value

public javafx.beans.property.ObjectProperty<T> valueProperty

Value: the currently show value of the list.

See Also:

getValue(), setValue(T)

index

public javafx.beans.property.ObjectProperty<java.lang.Integer> indexProperty

Index: the currently show index in the list.

See Also:

getIndex(), setIndex(Integer)

cyclic

public javafx.beans.property.ObjectProperty<java.lang.Boolean> cyclicProperty

Cyclic: what happens at the beginning or end of the list, stop or cycle to the other end.

See Also:

setCyclic(Boolean)

editable

public javafx.beans.property.ObjectProperty<java.lang.Boolean> editableProperty

Editable: is the listspinner editable. It allows the user to type a value instead of only navigating to it, and if the AddCallback is defined, possibly also adding values.

See Also:

setEditable(Boolean)

postfix

public javafx.beans.property.ObjectProperty<java.lang.String> postfixProperty

Postfix: a string to be placed after the value, this can for example be a unit like "kg"

See Also:

getPostfix(), setPostfix(String)

prefix

public javafx.beans.property.ObjectProperty<java.lang.String> prefixProperty

Prefix: a string to be placed before the list value, this can for example be a currency

See Also:

getPrefix(), setPrefix(String)

items

public javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<T>> itemsProperty

Items: the list.

See Also:

getItems(), setItems(ObservableList)

cellFactory

public javafx.beans.property.ObjectProperty<javafx.util.Callback<ListSpinner<T>,javafx.scene.Node>> cellFactoryProperty

CellFactory: generate the cell to render a value

See Also:

getCellFactory(), setCellFactory(Callback)

stringConverter

public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>> stringConverterProperty

StringConverter<T>: convert a value in the list to its string representation and (when in edit mode) vice versa.

See Also:

getStringConverter(), setStringConverter(StringConverter)

addCallback

public javafx.beans.property.ObjectProperty<javafx.util.Callback<T,java.lang.Integer>> addCallbackProperty

AddCallback: this callback is called in editable mode when a value is entered that is not found in the list. It is up to the coder to added it to the list or not.

See Also:

getAddCallback(), setAddCallback(Callback)

onCycle

public javafx.beans.property.ObjectProperty<javafx.event.EventHandler<ListSpinner.CycleEvent>> onCycleProperty

OnCycle: callback for when the list cycles to the other end in cyclic mode (for example to increase a year when a month ListSpinner skips from December to January)

See Also:

getOnCycle(), setOnCycle(EventHandler)

Field Detail

ONCYCLE_PROPERTY_ID

public static final java.lang.String ONCYCLE_PROPERTY_ID

See Also:

Constant Field Values

Constructor Detail

ListSpinner

public ListSpinner()

ListSpinner

public ListSpinner(javafx.collections.ObservableList<T> items)

Parameters:

items - The item list used to populate the spinner.

ListSpinner

public ListSpinner(javafx.collections.ObservableList<T> items,
                   T startValue)

Parameters:

items - The item list used to populate the spinner.

startValue - The initial value of the spinner (one of the items).

ListSpinner

public ListSpinner(java.util.List<T> list)

Parameters:

list -

ListSpinner

public ListSpinner(T... list)

Parameters:

list -

ListSpinner

public ListSpinner(int from,
                   int to)

Parameters:

from -

to -

ListSpinner

public ListSpinner(int from,
                   int to,
                   int step)

Parameters:

from -

to -

step -

Method Detail

getUserAgentStylesheet

public java.lang.String getUserAgentStylesheet()

Return the path to the CSS file so things are setup right

Overrides:

getUserAgentStylesheet in class javafx.scene.control.Control

createDefaultSkin

public javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.Control

withId

public ListSpinner<T> withId(java.lang.String value)

Id

valueProperty

public javafx.beans.property.ObjectProperty<T> valueProperty()

Value: the currently show value of the list.

See Also:

getValue(), setValue(T)

getValue

public T getValue()

setValue

public void setValue(T value)

withValue

public ListSpinner<T> withValue(T value)

indexProperty

public javafx.beans.property.ObjectProperty<java.lang.Integer> indexProperty()

Index: the currently show index in the list.

See Also:

getIndex(), setIndex(Integer)

getIndex

public java.lang.Integer getIndex()

setIndex

public void setIndex(java.lang.Integer value)

withIndex

public ListSpinner<T> withIndex(java.lang.Integer value)

cyclicProperty

public javafx.beans.property.ObjectProperty<java.lang.Boolean> cyclicProperty()

Cyclic: what happens at the beginning or end of the list, stop or cycle to the other end.

See Also:

setCyclic(Boolean)

isCyclic

public java.lang.Boolean isCyclic()

setCyclic

public void setCyclic(java.lang.Boolean value)

withCyclic

public ListSpinner<T> withCyclic(java.lang.Boolean value)

editableProperty

public javafx.beans.property.ObjectProperty<java.lang.Boolean> editableProperty()

Editable: is the listspinner editable. It allows the user to type a value instead of only navigating to it, and if the AddCallback is defined, possibly also adding values.

See Also:

setEditable(Boolean)

isEditable

public java.lang.Boolean isEditable()

setEditable

public void setEditable(java.lang.Boolean value)

withEditable

public ListSpinner<T> withEditable(java.lang.Boolean value)

postfixProperty

public javafx.beans.property.ObjectProperty<java.lang.String> postfixProperty()

Postfix: a string to be placed after the value, this can for example be a unit like "kg"

See Also:

getPostfix(), setPostfix(String)

getPostfix

public java.lang.String getPostfix()

setPostfix

public void setPostfix(java.lang.String value)

withPostfix

public ListSpinner<T> withPostfix(java.lang.String value)

prefixProperty

public javafx.beans.property.ObjectProperty<java.lang.String> prefixProperty()

Prefix: a string to be placed before the list value, this can for example be a currency

See Also:

getPrefix(), setPrefix(String)

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String value)

withPrefix

public ListSpinner<T> withPrefix(java.lang.String value)

itemsProperty

public javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<T>> itemsProperty()

Items: the list.

See Also:

getItems(), setItems(ObservableList)

getItems

public javafx.collections.ObservableList<T> getItems()

setItems

public void setItems(javafx.collections.ObservableList<T> value)

withItems

public ListSpinner<T> withItems(javafx.collections.ObservableList<T> value)

cellFactoryProperty

public javafx.beans.property.ObjectProperty<javafx.util.Callback<ListSpinner<T>,javafx.scene.Node>> cellFactoryProperty()

CellFactory: generate the cell to render a value

See Also:

getCellFactory(), setCellFactory(Callback)

getCellFactory

public javafx.util.Callback<ListSpinner<T>,javafx.scene.Node> getCellFactory()

setCellFactory

public void setCellFactory(javafx.util.Callback<ListSpinner<T>,javafx.scene.Node> value)

withCellFactory

public ListSpinner<T> withCellFactory(javafx.util.Callback<ListSpinner<T>,javafx.scene.Node> value)

stringConverterProperty

public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>> stringConverterProperty()

StringConverter<T>: convert a value in the list to its string representation and (when in edit mode) vice versa.

See Also:

getStringConverter(), setStringConverter(StringConverter)

getStringConverter

public javafx.util.StringConverter<T> getStringConverter()

setStringConverter

public void setStringConverter(javafx.util.StringConverter<T> value)

withStringConverter

public ListSpinner<T> withStringConverter(javafx.util.StringConverter<T> value)

addCallbackProperty

public javafx.beans.property.ObjectProperty<javafx.util.Callback<T,java.lang.Integer>> addCallbackProperty()

AddCallback: this callback is called in editable mode when a value is entered that is not found in the list. It is up to the coder to added it to the list or not.

See Also:

getAddCallback(), setAddCallback(Callback)

getAddCallback

public javafx.util.Callback<T,java.lang.Integer> getAddCallback()

setAddCallback

public void setAddCallback(javafx.util.Callback<T,java.lang.Integer> value)

withAddCallback

public ListSpinner<T> withAddCallback(javafx.util.Callback<T,java.lang.Integer> value)

onCycleProperty

public javafx.beans.property.ObjectProperty<javafx.event.EventHandler<ListSpinner.CycleEvent>> onCycleProperty()

OnCycle: callback for when the list cycles to the other end in cyclic mode (for example to increase a year when a month ListSpinner skips from December to January)

See Also:

getOnCycle(), setOnCycle(EventHandler)

getOnCycle

public javafx.event.EventHandler<ListSpinner.CycleEvent> getOnCycle()

setOnCycle

public void setOnCycle(javafx.event.EventHandler<ListSpinner.CycleEvent> value)

withOnCycle

public ListSpinner<T> withOnCycle(javafx.event.EventHandler<ListSpinner.CycleEvent> value)

fireCycleEvent

public void fireCycleEvent(ListSpinner.CycleDirection cycleDirection)

we’re cycling, fire the event

first

public void first()

decrement

public void decrement()

increment

public void increment()

last

public void last()

Get the last index; if the data provide is endless, this method mail fail!

equals

public static boolean equals(java.lang.Object o1,
                             java.lang.Object o2)

Does a o1.equals(o2) but also checks if o1 or o2 are null.

Parameters:

o1 -

o2 -

Returns:

True if the two values are equal, false otherwise.