GemsFX 3.10.1 · com.dlsc.gemsfx.SelectionBox · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	SelectionBox.StyleableProperties

Modifier and Type	Field and Description
private BooleanProperty	animationEnabled
private BooleanProperty	autoHideOnSelection
private final ObjectProperty<Node>	bottom Hides javafx.scene.Parent.bottom.
private final ReadOnlyObjectWrapper<SelectionMode>	currentSelectionMode
private static final boolean	DEFAULT_ANIMATION_ENABLED
private static final boolean	DEFAULT_READ_ONLY
private static final String	DEFAULT_STYLE_CLASS
private ObjectProperty<Node>	graphic
private ObjectProperty<StringConverter<T>>	itemConverter
private final ListProperty<T>	items
private final ObjectProperty<Node>	left Hides javafx.scene.Parent.left.
private ObjectProperty<EventHandler<WindowEvent>>	onHidden
private ObjectProperty<EventHandler<WindowEvent>>	onHiding
private ObjectProperty<EventHandler<WindowEvent>>	onShowing
private ObjectProperty<EventHandler<WindowEvent>>	onShown
private final ObjectProperty<Node>	placeholder
private StringProperty	promptText
private BooleanProperty	readOnly
private final ObjectProperty<Node>	right Hides javafx.scene.Parent.right.
private ObjectProperty<StringConverter<List<T>>>	selectedItemsConverter
private final ObjectProperty<MultipleSelectionModel<T>>	selectionModel
private final ObjectProperty<Node>	top Hides javafx.scene.Parent.top.

Access	Constructor and Description
public	SelectionBox() Constructs a new SelectionBox instance.
public	SelectionBox(Collection<T> the collection of items to populate the SelectionBox items) Constructs a new selection box with the specified collection of items.
public	SelectionBox(T... The initial items to populate the selection box. These items will be added to the selection box's list of choices. items) Constructs a new selection box and populates it with the provided items.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	animationEnabledProperty()
public final BooleanProperty	Returns: a BooleanProperty to control the auto-hide behavior of the popup. autoHideOnSelectionProperty() Controls whether the popup should auto-hide when an item or the extra button is clicked.
public final ObjectProperty<Node>	bottomProperty()
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public Button	Returns: the created Button instance createExtraButton(String the text to be displayed on the button text, Runnable the action to be executed when the button is clicked action) Creates an extra button with the specified text and action.
public Button	Returns: the created Button instance createExtraButton(String the text to be displayed on the button text, Node the graphic node to be displayed on the button graphic, Runnable the action to be executed when the button is clicked action) Creates an extra button with the specified text, graphic, and action.
private Node	createExtraButtonsBox()
public final ReadOnlyObjectProperty<SelectionMode>	Returns: a read-only `SelectionMode` property currentSelectionModeProperty() Provides a read-only property that directly exposes the current `SelectionMode` of this control without requiring multilevel checks on the underlying `javafx.scene.control.MultipleSelectionModel`.
public final Node	getBottom()
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 SelectionMode	getCurrentSelectionMode()
private ObjectBinding<SelectionMode>	Returns: an `ObjectBinding` that provides the current `SelectionMode` of the `MultipleSelectionModel`, or `null` if no selection model is set getCurrentSelectionModeBinding() Creates and returns an `ObjectBinding` that observes changes to the `selectionModelProperty()` and its associated `selectionModeProperty()`.
public final Node	getGraphic()
public final StringConverter<T>	getItemConverter()
public final ObservableList<T>	getItems()
public final Node	getLeft()
public final EventHandler<WindowEvent>	getOnHidden()
public final EventHandler<WindowEvent>	getOnHiding()
public final EventHandler<WindowEvent>	getOnShowing()
public final EventHandler<WindowEvent>	getOnShown()
public final Node	getPlaceholder()
public final String	getPromptText()
public final Node	getRight()
public final StringConverter<List<T>>	getSelectedItemsConverter()
public final MultipleSelectionModel<T>	getSelectionModel()
public final Node	getTop()
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final ObjectProperty<Node>	Returns: the ObjectProperty containing the graphical Node. graphicProperty() Returns the graphic property of this ChoicePicker.
public final void	hide() Hides the popup by setting the "showPopup" property to false on the component's properties.
public final boolean	isAnimationEnabled()
public final boolean	isAutoHideOnSelection()
public final boolean	isReadOnly()
public final ObjectProperty<StringConverter<T>>	Returns: the property object for the string converter used to format individual items. itemConverterProperty() Retrieves the property object for the string converter that formats the display of individual items.
public final ListProperty<T>	Returns: the list property containing the items itemsProperty() The list of items to be displayed in the SelectionBox.
public final ObjectProperty<Node>	leftProperty()
public final ObjectProperty<EventHandler<WindowEvent>>	Returns: the property holding the handler invoked after the popup is hidden onHiddenProperty() The event handler property invoked after the SelectionPopup has been hidden.
public final ObjectProperty<EventHandler<WindowEvent>>	Returns: the property holding the handler invoked before the popup is hidden onHidingProperty() The event handler property invoked before the SelectionPopup is hidden.
public final ObjectProperty<EventHandler<WindowEvent>>	Returns: the property holding the handler invoked before showing the popup onShowingProperty() The event handler property invoked before the SelectionPopup is shown.
public final ObjectProperty<EventHandler<WindowEvent>>	Returns: the property holding the handler invoked after the popup is shown onShownProperty() The event handler property invoked after the SelectionPopup has been shown.
public final ObjectProperty<Node>	Returns: the placeholder property placeholderProperty() Returns the property holding the placeholder node, which is displayed when there are no items.
public final StringProperty	Returns: the StringProperty containing the prompt text. promptTextProperty() Returns the prompt text property of this SelectionBox.
public final BooleanProperty	Returns: the BooleanProperty controlling the read-only state of the SelectionBox. readOnlyProperty() Returns the BooleanProperty that controls the read-only state of the SelectionBox.
public final ObjectProperty<Node>	rightProperty()
public final ObjectProperty<StringConverter<List<T>>>	Returns: the property object for the string converter that formats the display of selected items. selectedItemsConverterProperty() Retrieves the property object for a string converter used to format the display of selected items.
public final ObjectProperty<MultipleSelectionModel<T>>	Returns: the ObjectProperty containing the selection model. selectionModelProperty() Returns the property object for the selection model used by this SelectionBox.
public final void	setAnimationEnabled(boolean value)
public final void	setAutoHideOnSelection(boolean autoHideOnSelection)
public final void	setBottom(Node bottom)
public final void	setGraphic(Node graphic)
public final void	setItemConverter(StringConverter<T> itemConverter)
public final void	setItems(ObservableList<T> items)
public final void	setLeft(Node left)
public final void	setOnHidden(EventHandler<WindowEvent> value)
public final void	setOnHiding(EventHandler<WindowEvent> value)
public final void	setOnShowing(EventHandler<WindowEvent> value)
public final void	setOnShown(EventHandler<WindowEvent> value)
public final void	setPlaceholder(Node placeholder)
public final void	setPromptText(String promptText)
public final void	setReadOnly(boolean readOnly)
public final void	setRight(Node right)
public final void	setSelectedItemsConverter(StringConverter<List<T>> selectedItemsConverter)
public final void	setSelectionModel(MultipleSelectionModel<T> selectionModel)
public final void	setTop(Node top)
public final void	show() Displays the popup by setting the "showPopup" property to true on the component's properties.
public final ObjectProperty<Node>	topProperty()

public Class SelectionBox<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary