javafx.scene.control.cell

Class ComboBoxListCell<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.Cell<T>

javafx.scene.control.IndexedCell<T>

javafx.scene.control.ListCell<T>

javafx.scene.control.cell.ComboBoxListCell<T>

Type Parameters:

T - The type of the elements contained within the ListView.

All Implemented Interfaces:

EventTarget, Skinnable

public class ComboBoxListCell<T>
extends ListCell<T>

A class containing a ListCell implementation that draws a ComboBox node inside the cell.

By default, the ComboBoxListCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell.

To create a ComboBoxListCell, it is necessary to provide zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the ListView items sequence, such that upon selection, they replace the existing value in the items list.

Since:

2.2

Property Summary

Properties

Type	Property and Description
BooleanProperty	comboBoxEditable A property representing whether the ComboBox, when shown to the user, is editable or not.
ObjectProperty<StringConverter<T>>	converter The StringConverter property.

Properties inherited from class javafx.scene.control.ListCell

listView

Properties inherited from class javafx.scene.control.IndexedCell

index

Properties inherited from class javafx.scene.control.Cell

editable, editing, empty, item, selected

Properties inherited from class javafx.scene.control.Labeled

alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

Properties inherited from class javafx.scene.control.Control

contextMenu, height, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skinClassName, skin, tooltip, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, 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, visible

Field Summary

Fields inherited from class javafx.scene.control.Control

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
ComboBoxListCell() Creates a default ComboBoxListCell with an empty items list.
ComboBoxListCell(ObservableList<T> items) Creates a default ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown.
ComboBoxListCell(StringConverter<T> converter, ObservableList<T> items) Creates a ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form.
ComboBoxListCell(StringConverter<T> converter, T... items) Creates a ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form.
ComboBoxListCell(T... items) Creates a default ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelEdit() Call this function to transition from an editing state into a non-editing state, without saving any user input.
BooleanProperty	comboBoxEditableProperty() A property representing whether the ComboBox, when shown to the user, is editable or not.
ObjectProperty<StringConverter<T>>	converterProperty() The StringConverter property.
static <T> Callback<ListView<T>,ListCell<T>>	forListView(ObservableList<T> items) Creates a ComboBox cell factory for use in ListView controls.
static <T> Callback<ListView<T>,ListCell<T>>	forListView(StringConverter<T> converter, ObservableList<T> items) Creates a ComboBox cell factory for use in ListView controls.
static <T> Callback<ListView<T>,ListCell<T>>	forListView(StringConverter<T> converter, T... items) Creates a ComboBox cell factory for use in ListView controls.
static <T> Callback<ListView<T>,ListCell<T>>	forListView(T... items) Creates a ComboBox cell factory for use in ListView controls.
StringConverter<T>	getConverter() Returns the StringConverter used in this cell.
ObservableList<T>	getItems() Returns the items to be displayed in the ChoiceBox when it is showing.
boolean	isComboBoxEditable() Returns true if the ComboBox is editable.
void	setComboBoxEditable(boolean value) Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list).
void	setConverter(StringConverter<T> value) Sets the StringConverter to be used in this cell.
void	startEdit() Call this function to transition from a non-editing state into an editing state, if the cell is editable.
void	updateItem(T item, boolean empty) Updates the item associated with this Cell.

Methods inherited from class javafx.scene.control.ListCell

commitEdit, getListView, listViewProperty, updateListView

Methods inherited from class javafx.scene.control.IndexedCell

getIndex, indexProperty, updateIndex

Methods inherited from class javafx.scene.control.Cell

editableProperty, editingProperty, emptyProperty, getItem, isEditable, isEditing, isEmpty, isSelected, itemProperty, selectedProperty, setEditable, setItem, updateSelected

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getContentBias, getContentDisplay, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getLabelPadding, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getSkin, getTooltip, getUserAgentStylesheet, getWidth, heightProperty, intersects, isResizable, layoutChildren, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setContextMenu, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setSkinClassName, setTooltip, setWidth, skinClassNameProperty, skinProperty, tooltipProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, 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, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, 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, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, 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, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

converter

public final ObjectProperty<StringConverter<T>> converterProperty

The StringConverter property.

See Also:

getConverter(), setConverter(StringConverter)

comboBoxEditable

public final BooleanProperty comboBoxEditableProperty

A property representing whether the ComboBox, when shown to the user, is editable or not.

See Also:

isComboBoxEditable(), setComboBoxEditable(boolean)

Constructor Detail

ComboBoxListCell

public ComboBoxListCell()

Creates a default ComboBoxListCell with an empty items list.

ComboBoxListCell

public ComboBoxListCell(T... items)

Creates a default ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown.

Parameters:

items - The items to show in the ComboBox popup menu when selected by the user.

ComboBoxListCell

public ComboBoxListCell(StringConverter<T> converter,
                T... items)

Creates a ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form.

Parameters:

converter - A StringConverter that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu.

items - The items to show in the ComboBox popup menu when selected by the user.

ComboBoxListCell

public ComboBoxListCell(ObservableList<T> items)

Creates a default ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown.

Parameters:

items - The items to show in the ComboBox popup menu when selected by the user.

ComboBoxListCell

public ComboBoxListCell(StringConverter<T> converter,
                ObservableList<T> items)

Creates a ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form.

Parameters:

converter - A StringConverter that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu.

items - The items to show in the ComboBox popup menu when selected by the user.

Method Detail

forListView

public static <T> Callback<ListView<T>,ListCell<T>> forListView(T... items)

Creates a ComboBox cell factory for use in ListView controls. By default, the ComboBoxCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell.

Type Parameters:

T - The type of the elements contained within the ListView.

Parameters:

items - Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the ListView items list, such that upon selection, they replace the existing value in the items list.

Returns:

A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

forListView

public static <T> Callback<ListView<T>,ListCell<T>> forListView(StringConverter<T> converter,
                                                T... items)

Creates a ComboBox cell factory for use in ListView controls. By default, the ComboBoxCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell.

Type Parameters:

T - The type of the elements contained within the ListView.

Parameters:

converter - A StringConverter to convert the given item (of type T) to a String for displaying to the user.

items - Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the ListView items list, such that upon selection, they replace the existing value in the items list.

Returns:

A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

forListView

public static <T> Callback<ListView<T>,ListCell<T>> forListView(ObservableList<T> items)

Creates a ComboBox cell factory for use in ListView controls. By default, the ComboBoxCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell.

Type Parameters:

T - The type of the elements contained within the ListView.

Parameters:

items - An ObservableList containing zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the ListView items sequence, such that upon selection, they replace the existing value in the items list.

Returns:

A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

forListView

public static <T> Callback<ListView<T>,ListCell<T>> forListView(StringConverter<T> converter,
                                                ObservableList<T> items)

Creates a ComboBox cell factory for use in ListView controls. By default, the ComboBoxCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell.

Type Parameters:

T - The type of the elements contained within the ListView.

Parameters:

converter - A StringConverter to convert the given item (of type T) to a String for displaying to the user.

items - An ObservableList containing zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the ListView items sequence, such that upon selection, they replace the existing value in the items list.

Returns:

A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

converterProperty

public final ObjectProperty<StringConverter<T>> converterProperty()

The StringConverter property.

See Also:

getConverter(), setConverter(StringConverter)

setConverter

public final void setConverter(StringConverter<T> value)

Sets the StringConverter to be used in this cell.

getConverter

public final StringConverter<T> getConverter()

Returns the StringConverter used in this cell.

comboBoxEditableProperty

public final BooleanProperty comboBoxEditableProperty()

A property representing whether the ComboBox, when shown to the user, is editable or not.

See Also:

isComboBoxEditable(), setComboBoxEditable(boolean)

setComboBoxEditable

public final void setComboBoxEditable(boolean value)

Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list).

isComboBoxEditable

public final boolean isComboBoxEditable()

Returns true if the ComboBox is editable.

getItems

public ObservableList<T> getItems()

Returns the items to be displayed in the ChoiceBox when it is showing.

startEdit

public void startEdit()

Call this function to transition from a non-editing state into an editing state, if the cell is editable. If this cell is already in an editing state, it will stay in it.

Overrides:

startEdit in class ListCell<T>

cancelEdit

public void cancelEdit()

Call this function to transition from an editing state into a non-editing state, without saving any user input.

Overrides:

cancelEdit in class ListCell<T>

updateItem

public void updateItem(T item,
              boolean empty)

Updates the item associated with this Cell. This method should only be called by Skin implementations of ListView, TableView, TreeView, or other controls using Cells. It is not intended to be called by application developers.

Because null is a perfectly valid value in the application domain, Cell needs some way to distinguish whether or not the cell actually holds a value. The empty flag indicates this. It is an error to supply a non-null item but a true value for empty.

Overrides:

updateItem in class Cell<T>

Parameters:

item - The new item for the cell

empty - whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.