T
- The type of the elements contained within the TableColumn.public class ComboBoxTableCell<S,T> extends TableCell<S,T>
TableCell
implementation that draws a
ComboBox
node inside the cell.
By default, the ComboBoxTableCell 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 ComboBoxTableCell, 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 TableColumn.
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. |
tableColumn, tableRow, tableView
index
alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText
contextMenu, skin, tooltip
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
needsLayout
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, 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, visible
USE_COMPUTED_SIZE, USE_PREF_SIZE
BASELINE_OFFSET_SAME_AS_HEIGHT
Constructor and Description |
---|
ComboBoxTableCell()
Creates a default ComboBoxTableCell with an empty items list.
|
ComboBoxTableCell(ObservableList<T> items)
Creates a default
ComboBoxTableCell instance with the given items
being used to populate the ComboBox when it is shown. |
ComboBoxTableCell(StringConverter<T> converter,
ObservableList<T> items)
Creates a
ComboBoxTableCell 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. |
ComboBoxTableCell(StringConverter<T> converter,
T... items)
Creates a
ComboBoxTableCell 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. |
ComboBoxTableCell(T... items)
Creates a default
ComboBoxTableCell instance with the given items
being used to populate the ComboBox when it is shown. |
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 <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> |
forTableColumn(ObservableList<T> items)
Creates a ComboBox cell factory for use in
TableColumn controls. |
static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> |
forTableColumn(StringConverter<T> converter,
ObservableList<T> items)
Creates a ComboBox cell factory for use in
TableColumn controls. |
static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> |
forTableColumn(StringConverter<T> converter,
T... items)
Creates a ComboBox cell factory for use in
TableColumn controls. |
static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> |
forTableColumn(T... items)
Creates a ComboBox cell factory for use in
TableColumn 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)
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.
|
commitEdit, createDefaultSkin, executeAccessibleAction, getTableColumn, getTableRow, getTableView, layoutChildren, queryAccessibleAttribute, tableColumnProperty, tableRowProperty, tableViewProperty, updateSelected, updateTableColumn, updateTableRow, updateTableView
getIndex, indexProperty, updateIndex
editableProperty, editingProperty, emptyProperty, getItem, isEditable, isEditing, isEmpty, isItemChanged, isSelected, itemProperty, selectedProperty, setEditable, setItem
alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, 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, toString, underlineProperty, wrapTextProperty
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
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, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, 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, 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, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, 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, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty
public final ObjectProperty<StringConverter<T>> converterProperty
StringConverter
property.public final BooleanProperty comboBoxEditableProperty
isComboBoxEditable()
,
setComboBoxEditable(boolean)
public ComboBoxTableCell()
@SafeVarargs public ComboBoxTableCell(T... items)
ComboBoxTableCell
instance with the given items
being used to populate the ComboBox
when it is shown.items
- The items to show in the ComboBox popup menu when selected
by the user.@SafeVarargs public ComboBoxTableCell(StringConverter<T> converter, T... items)
ComboBoxTableCell
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.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.public ComboBoxTableCell(ObservableList<T> items)
ComboBoxTableCell
instance with the given items
being used to populate the ComboBox
when it is shown.items
- The items to show in the ComboBox popup menu when selected
by the user.public ComboBoxTableCell(StringConverter<T> converter, ObservableList<T> items)
ComboBoxTableCell
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.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.@SafeVarargs public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(T... items)
TableColumn
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.T
- The type of the elements contained within the TableColumn.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 TableColumn. Note that it is up to the developer to set
event handlers
to listen to edit events in the
TableColumn, and react accordingly. Methods of interest include
setOnEditStart
,
setOnEditCommit
,
and setOnEditCancel
.Callback
that will return a TableCell that is able to
work on the type of element contained within the TableColumn.@SafeVarargs public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(StringConverter<T> converter, T... items)
TableColumn
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.T
- The type of the elements contained within the TableColumn.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 TableColumn. Note that it is up to the developer to set
event handlers
to listen to edit events in the
TableColumn, and react accordingly. Methods of interest include
setOnEditStart
,
setOnEditCommit
,
and setOnEditCancel
.Callback
that will return a TableCell that is able to
work on the type of element contained within the TableColumn.public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(ObservableList<T> items)
TableColumn
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.T
- The type of the elements contained within the TableColumn.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 TableColumn. Note that it is up to the developer to set
event handlers
to listen to edit events in the
TableColumn, and react accordingly. Methods of interest include
setOnEditStart
,
setOnEditCommit
,
and setOnEditCancel
.Callback
that will return a TableCell that is able to
work on the type of element contained within the TableColumn.public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(StringConverter<T> converter, ObservableList<T> items)
TableColumn
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.T
- The type of the elements contained within the TableColumn.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 TableColumn. Note that it is up to the developer to set
event handlers
to listen to edit events in the
TableColumn, and react accordingly. Methods of interest include
setOnEditStart
,
setOnEditCommit
,
and setOnEditCancel
.Callback
that will return a TableCell that is able to
work on the type of element contained within the TableColumn.public final ObjectProperty<StringConverter<T>> converterProperty()
StringConverter
property.public final void setConverter(StringConverter<T> value)
StringConverter
to be used in this cell.public final StringConverter<T> getConverter()
StringConverter
used in this cell.public final BooleanProperty comboBoxEditableProperty()
isComboBoxEditable()
,
setComboBoxEditable(boolean)
public final void setComboBoxEditable(boolean value)
public final boolean isComboBoxEditable()
public ObservableList<T> getItems()
public void startEdit()
public void cancelEdit()
cancelEdit
in class TableCell<S,T>
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:
empty
condition, 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.updateItem
in class Cell<T>
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.Copyright (c) 2008, 2015, Oracle and/or its affiliates. All rights reserved.