Class ComboBoxTreeTableCell<S,T>
- Type Parameters:
-
S- The type of the TreeTableView generic type -
T- The type of the elements contained within the TreeTableColumn.
- All Implemented Interfaces:
-
Styleable,EventTarget,Skinnable
public class ComboBoxTreeTableCell<S,T> extends TreeTableCell<S,T>
TreeTableCell implementation that draws a ComboBox node inside the cell. By default, the ComboBoxTreeTableCell 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 table cell.
To create a ComboBoxTreeTableCell, 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 TreeTableColumn.
- Since:
- JavaFX 8.0
Property Summary
| Type | Property | Description |
|---|---|---|
final BooleanProperty |
comboBoxEditable |
A property representing whether the ComboBox, when shown to the user, is editable or not. |
final ObjectProperty<StringConverter<T>> |
converter |
The StringConverter property. |
Properties declared in class javafx.scene.control.TreeTableCell
tableColumn, tableRow, treeTableView
Properties declared in class javafx.scene.control.IndexedCell
index
Properties declared in class javafx.scene.control.Labeled
alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText
Properties declared in class javafx.scene.control.Control
contextMenu, skin, tooltip
Properties declared in class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
Properties declared in class javafx.scene.Parent
needsLayout
Properties declared in 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 declared in class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
Fields declared in class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
Constructor Summary
| Constructor | Description |
|---|---|
ComboBoxTreeTableCell() |
Creates a default ComboBoxTreeTableCell with an empty items list. |
ComboBoxTreeTableCell |
Creates a default ComboBoxTreeTableCell instance with the given items being used to populate the ComboBox when it is shown. |
ComboBoxTreeTableCell |
Creates a ComboBoxTreeTableCell 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. |
ComboBoxTreeTableCell |
Creates a ComboBoxTreeTableCell 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. |
ComboBoxTreeTableCell |
Creates a default ComboBoxTreeTableCell instance with the given items being used to populate the ComboBox when it is shown. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
final BooleanProperty |
comboBoxEditableProperty() |
A property representing whether the ComboBox, when shown to the user, is editable or not. |
final ObjectProperty<StringConverter<T>> |
converterProperty() |
The StringConverter property. |
static <S, |
forTreeTableColumn |
Creates a ComboBox cell factory for use in TreeTableColumn controls. |
static <S, |
forTreeTableColumn |
Creates a ComboBox cell factory for use in TreeTableColumn controls. |
static <S, |
forTreeTableColumn |
Creates a ComboBox cell factory for use in TreeTableColumn controls. |
static <S, |
forTreeTableColumn |
Creates a ComboBox cell factory for use in TreeTableColumn controls. |
final StringConverter<T> |
getConverter() |
Returns the StringConverter used in this cell. |
ObservableList<T> |
getItems() |
Returns the items to be displayed in the ComboBox when it is showing. |
final boolean |
isComboBoxEditable() |
Returns true if the ComboBox is editable. |
final void |
setComboBoxEditable |
Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list). |
final void |
setConverter |
Sets the StringConverter to be used in this cell. |
void |
updateItem |
The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. |
Methods declared in class javafx.scene.control.TreeTableCell
getTableColumn, getTableRow, getTreeTableRow, getTreeTableView, tableColumnProperty, tableRowProperty, treeTableViewProperty, updateTableColumn, updateTableRow, updateTreeTableColumn, updateTreeTableRow, updateTreeTableView
Methods declared in class javafx.scene.control.IndexedCell
getIndex, indexProperty, updateIndex
Methods declared in class javafx.scene.control.Cell
cancelEdit, commitEdit, editableProperty, editingProperty, emptyProperty, getInitialFocusTraversable, getItem, isEditable, isEditing, isEmpty, isItemChanged, isSelected, itemProperty, selectedProperty, setEditable, setItem, startEdit, updateSelected
Methods declared in class javafx.scene.control.Labeled
alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty
Methods declared in class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, contextMenuProperty, createDefaultSkin, getContextMenu, getCssMetaData, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
Methods declared in class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
Methods declared in class javafx.scene.Parent
getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
Methods declared in 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, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, 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, lookup, 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, queryAccessibleAttribute, 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, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods declared in interface javafx.css.Styleable
getStyleableNode
Property Details
converter
public final ObjectProperty<StringConverter<T>> converterProperty
StringConverter property.comboBoxEditable
public final BooleanProperty comboBoxEditableProperty
Constructor Details
ComboBoxTreeTableCell
public ComboBoxTreeTableCell()
ComboBoxTreeTableCell
@SafeVarargs public ComboBoxTreeTableCell(T... items)
ComboBoxTreeTableCell 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.
ComboBoxTreeTableCell
@SafeVarargs public ComboBoxTreeTableCell(StringConverter<T> converter, T... items)
ComboBoxTreeTableCell 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- AStringConverterthat 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.
ComboBoxTreeTableCell
public ComboBoxTreeTableCell(ObservableList<T> items)
ComboBoxTreeTableCell 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.
ComboBoxTreeTableCell
public ComboBoxTreeTableCell(StringConverter<T> converter, ObservableList<T> items)
ComboBoxTreeTableCell 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- AStringConverterthat 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 Details
forTreeTableColumn
@SafeVarargs public static <S, T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn(T... items)
TreeTableColumn 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:
-
S- The type of the TreeTableView generic type -
T- The type of the elements contained within the TreeTableColumn. - Parameters:
-
items- Zero or more items that will be shown to the user when theComboBoxmenu is showing. These items must be of the same type as the TreeTableColumn. Note that it is up to the developer to setevent handlersto listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest includesetOnEditStart,setOnEditCommit, andsetOnEditCancel. - Returns:
- A
Callbackthat will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.
forTreeTableColumn
@SafeVarargs public static <S, T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn(StringConverter<T> converter, T... items)
TreeTableColumn 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:
-
S- The type of the TreeTableView generic type -
T- The type of the elements contained within the TreeTableColumn. - Parameters:
-
converter- AStringConverterto 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 theComboBoxmenu is showing. These items must be of the same type as the TreeTableColumn. Note that it is up to the developer to setevent handlersto listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest includesetOnEditStart,setOnEditCommit, andsetOnEditCancel. - Returns:
- A
Callbackthat will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.
forTreeTableColumn
public static <S, T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn(ObservableList<T> items)
TreeTableColumn 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:
-
S- The type of the TreeTableView generic type -
T- The type of the elements contained within the TreeTableColumn. - Parameters:
-
items- Zero or more items that will be shown to the user when theComboBoxmenu is showing. These items must be of the same type as the TreeTableColumn. Note that it is up to the developer to setevent handlersto listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest includesetOnEditStart,setOnEditCommit, andsetOnEditCancel. - Returns:
- A
Callbackthat will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.
forTreeTableColumn
public static <S, T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn(StringConverter<T> converter, ObservableList<T> items)
TreeTableColumn 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:
-
S- The type of the TreeTableView generic type -
T- The type of the elements contained within the TreeTableColumn. - Parameters:
-
converter- AStringConverterto 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 theComboBoxmenu is showing. These items must be of the same type as the TreeTableColumn. Note that it is up to the developer to setevent handlersto listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest includesetOnEditStart,setOnEditCommit, andsetOnEditCancel. - Returns:
- A
Callbackthat will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.
converterProperty
public final ObjectProperty<StringConverter<T>> converterProperty()
StringConverter property.- Returns:
- the string converter property
- See Also:
setConverter
public final void setConverter(StringConverter<T> value)
StringConverter to be used in this cell.- Parameters:
-
value- the string converter
getConverter
public final StringConverter<T> getConverter()
StringConverter used in this cell.- Returns:
- the string converter
comboBoxEditableProperty
public final BooleanProperty comboBoxEditableProperty()
- Returns:
- the property representing whether the ComboBox, when shown to the user, is editable or not
- See Also:
setComboBoxEditable
public final void setComboBoxEditable(boolean value)
- Parameters:
-
value- the editable value to be set for this ComboBox
isComboBoxEditable
public final boolean isComboBoxEditable()
- Returns:
- true if the ComboBox is editable
getItems
public ObservableList<T> getItems()
- Returns:
- the items to be displayed in this ComboBox when it is showing
updateItem
public void updateItem(T item, boolean empty)
ListView control) to call this method. However, the purpose of having the updateItem method is so that developers, when specifying custom cell factories (again, like the ListView cell factory), the updateItem method can be overridden to allow for complete customisation of the cell. It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method:
protected void updateItem(T item, boolean empty) {
super.updateItem(item, empty);
if (empty || item == null) {
setText(null);
setGraphic(null);
} else {
setText(item.toString());
}
}
Note in this code sample two important points:
- We call the super.updateItem(T, boolean) method. If this is not done, the item and empty properties are not correctly set, and you are likely to end up with graphical issues.
- We test for the
emptycondition, and if true, we set the text and graphic properties to null. If we do not do this, it is almost guaranteed that end users will see graphical artifacts in cells unexpectedly.
- Overrides:
-
updateItemin classCell<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.
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.