Top Description Inners Fields Constructors Methods
com.dlsc.pickerfx

public abstract Class Picker<T>

extends Control
Class Inheritance
Known Direct Subclasses
com.dlsc.pickerfx.DurationPicker, com.dlsc.pickerfx.IntegerPicker, com.dlsc.pickerfx.ItemPicker, com.dlsc.pickerfx.LocalDatePicker, com.dlsc.pickerfx.LocalDateTimePicker, com.dlsc.pickerfx.LocalTimePicker
Type Parameters
<T>
the type of the items displayed by the picker.
Imports
com.dlsc.pickerfx.util.ControlsUtil, javafx.beans.property.BooleanProperty, .DoubleProperty, .ObjectProperty, .ReadOnlyBooleanProperty, .ReadOnlyBooleanWrapper, .SimpleBooleanProperty, .SimpleObjectProperty, javafx.collections.MapChangeListener, javafx.css.CssMetaData, .PseudoClass, .Styleable, .StyleableDoubleProperty, .StyleableObjectProperty, .StyleableProperty, javafx.css.converter.EnumConverter, .SizeConverter, javafx.geometry.Orientation, javafx.scene.control.Control, javafx.scene.layout.Region, java.util.ArrayList, .Collections, .List, .Objects
The base class of all picker controls.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
Picker.StyleableProperties

Field Summary

Modifier and TypeField and Description
private DoubleProperty
cellSize

private DoubleProperty
indicatorSize

Specifies the height / width of the indicator glass node.

private final ReadOnlyBooleanWrapper
invalid

A flag used to signal whether the current settings made by the user define a valid or invalid value.

private ObjectProperty<Orientation>
orientation

Controls the orientation of the picker (horizontal, vertical).

private static final PseudoClass
PSEUDO_CLASS_HORIZONTAL

private static final PseudoClass
PSEUDO_CLASS_VERTICAL

private final BooleanProperty
readOnly

A flag used to mark the picker as a "read-only" picker.

private final BooleanProperty
showIndicator

Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.

private final ObjectProperty<T>
value

The value currently specified by the picker.

Constructor Summary

AccessConstructor and Description
protected
Picker()

Method Summary

Modifier and TypeMethod and Description
public final DoubleProperty

Returns:

the cell size
cellSizeProperty()

Controls the width / height of the picker cells.

public final double
getCellSize()

public static List<CssMetaData<? extends Styleable, ?>>
getClassCssMetaData()

Hides javafx.scene.control.Control.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

public List<CssMetaData<? extends Styleable, ?>>
getControlCssMetaData()

Overrides javafx.scene.control.Control.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

public final double
getIndicatorSize()

public final Orientation
getOrientation()

public final T
getValue()

public final DoubleProperty
indicatorSizeProperty()

public final ReadOnlyBooleanProperty
invalidProperty()

public final boolean
isInvalid()

public final boolean
isReadOnly()

public boolean
isShowIndicator()

private void
listenForInvalidChanges()

public final ObjectProperty<Orientation>
orientationProperty()

public final BooleanProperty
readOnlyProperty()

public final void
setCellSize(double value)

public final void
setIndicatorSize(double value)

private void
setInvalid(boolean invalid)

public final void
setOrientation(Orientation value)

public final void
setReadOnly(boolean readOnly)

public void
setShowIndicator(boolean showIndicator)

public final void
setValue(T value)

public BooleanProperty
showIndicatorProperty()

public final ObjectProperty<T>
valueProperty()

Inherited from javafx.scene.control.Control:
computeMaxHeightcomputeMaxWidthcomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthcontextMenuPropertycreateDefaultSkinexecuteAccessibleActiongetBaselineOffsetgetContextMenugetCssMetaDatagetInitialFocusTraversablegetSkingetTooltipisResizablelayoutChildrenqueryAccessibleAttributesetContextMenusetSkinsetTooltipskinPropertytooltipProperty

Field Detail

cellSizeback to summary
private DoubleProperty cellSize
indicatorSizeback to summary
private DoubleProperty indicatorSize

Specifies the height / width of the indicator glass node.

invalidback to summary
private final ReadOnlyBooleanWrapper invalid

A flag used to signal whether the current settings made by the user define a valid or invalid value. E.g. in the LocalDatePicker the date set by the user could be February 30th, hence "invalid" as this date never exists.

See Also
LocalDatePicker
orientationback to summary
private ObjectProperty<Orientation> orientation

Controls the orientation of the picker (horizontal, vertical).

PSEUDO_CLASS_HORIZONTALback to summary
private static final PseudoClass PSEUDO_CLASS_HORIZONTAL
PSEUDO_CLASS_VERTICALback to summary
private static final PseudoClass PSEUDO_CLASS_VERTICAL
readOnlyback to summary
private final BooleanProperty readOnly

A flag used to mark the picker as a "read-only" picker. The user will not be able to change the value.

showIndicatorback to summary
private final BooleanProperty showIndicator

Controls whether the picker will display the "indicator" area, which is the "glass" that marks the currently selected value.

valueback to summary
private final ObjectProperty<T> value

The value currently specified by the picker.

Constructor Detail

Pickerback to summary
protected Picker()

Method Detail

cellSizePropertyback to summary
public final DoubleProperty cellSizeProperty()

Controls the width / height of the picker cells.

Returns:DoubleProperty

the cell size

getCellSizeback to summary
public final double getCellSize()
getClassCssMetaDataback to summary
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.Control.getClassCssMetaData.

Doc from javafx.scene.control.Control.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>

the CssMetaData

getControlCssMetaDataback to summary
public List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Overrides javafx.scene.control.Control.getControlCssMetaData.

Doc from javafx.scene.control.Control.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

Returns:List<CssMetaData<? extends Styleable, ?>>

the unmodifiable list of the control's CSS-styleable properties

Annotations
@Override
getIndicatorSizeback to summary
public final double getIndicatorSize()
getOrientationback to summary
public final Orientation getOrientation()
getValueback to summary
public final T getValue()
indicatorSizePropertyback to summary
public final DoubleProperty indicatorSizeProperty()
invalidPropertyback to summary
public final ReadOnlyBooleanProperty invalidProperty()
isInvalidback to summary
public final boolean isInvalid()
isReadOnlyback to summary
public final boolean isReadOnly()
isShowIndicatorback to summary
public boolean isShowIndicator()
listenForInvalidChangesback to summary
private void listenForInvalidChanges()
orientationPropertyback to summary
public final ObjectProperty<Orientation> orientationProperty()
readOnlyPropertyback to summary
public final BooleanProperty readOnlyProperty()
setCellSizeback to summary
public final void setCellSize(double value)
setIndicatorSizeback to summary
public final void setIndicatorSize(double value)
setInvalidback to summary
private void setInvalid(boolean invalid)
setOrientationback to summary
public final void setOrientation(Orientation value)
setReadOnlyback to summary
public final void setReadOnly(boolean readOnly)
setShowIndicatorback to summary
public void setShowIndicator(boolean showIndicator)
setValueback to summary
public final void setValue(T value)
showIndicatorPropertyback to summary
public BooleanProperty showIndicatorProperty()
valuePropertyback to summary
public final ObjectProperty<T> valueProperty()
com.dlsc.pickerfx back to summary

private Class Picker.StyleableProperties

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final CssMetaData<Picker<T>, Number>
CELL_SIZE

private static final CssMetaData<Picker<T>, Number>
INDICATOR_SIZE

private static final CssMetaData<Picker<?>, Orientation>
ORIENTATION

private static final List<CssMetaData<? extends Styleable, ?>>
STYLEABLES

Constructor Summary

AccessConstructor and Description
private
StyleableProperties()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CELL_SIZEback to summary
private static final CssMetaData<Picker<T>, Number> CELL_SIZE
INDICATOR_SIZEback to summary
private static final CssMetaData<Picker<T>, Number> INDICATOR_SIZE
ORIENTATIONback to summary
private static final CssMetaData<Picker<?>, Orientation> ORIENTATION
STYLEABLESback to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

Constructor Detail

StyleablePropertiesback to summary
private StyleableProperties()