T
- The type of the TreeItems contained within the TreeView.public class ComboBoxTreeCell<T> extends TreeCell<T>
TreeCell
implementation that draws a
ComboBox
node inside the cell.
By default, the ComboBoxTreeCell 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 tree cell.
To create a ComboBoxTreeCell, 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 TreeView TreeItems, such
that upon selection, they replace the existing value in the
TreeItem.valueProperty()
.
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. |
disclosureNode, treeItem, treeView
index
alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText
contextMenu, height, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skinClassName, skin, tooltip, width
needsLayout
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
USE_COMPUTED_SIZE, USE_PREF_SIZE
Constructor and Description |
---|
ComboBoxTreeCell()
Creates a default ComboBoxTreeCell with an empty items list.
|
ComboBoxTreeCell(ObservableList<T> items)
Creates a default
ComboBoxTreeCell instance with the given items
being used to populate the ComboBox when it is shown. |
ComboBoxTreeCell(StringConverter<T> converter,
ObservableList<T> items)
Creates a
ComboBoxTreeCell 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. |
ComboBoxTreeCell(StringConverter<T> converter,
T... items)
Creates a
ComboBoxTreeCell 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. |
ComboBoxTreeCell(T... items)
Creates a default
ComboBoxTreeCell 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 <T> Callback<TreeView<T>,TreeCell<T>> |
forTreeView(ObservableList<T> items)
Creates a ComboBox cell factory for use in
TreeView controls. |
static <T> Callback<TreeView<T>,TreeCell<T>> |
forTreeView(StringConverter<T> converter,
ObservableList<T> items)
Creates a ComboBox cell factory for use in
TreeView controls. |
static <T> Callback<TreeView<T>,TreeCell<T>> |
forTreeView(StringConverter<T> converter,
T... items)
Creates a ComboBox cell factory for use in
TreeView controls. |
static <T> Callback<TreeView<T>,TreeCell<T>> |
forTreeView(T... items)
Creates a ComboBox cell factory for use in
TreeView 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.
|
commitEdit, disclosureNodeProperty, getDisclosureNode, getTreeItem, getTreeView, setDisclosureNode, treeItemProperty, treeViewProperty, updateTreeItem, updateTreeView
getIndex, indexProperty, updateIndex
editableProperty, editingProperty, emptyProperty, getItem, isEditable, isEditing, isEmpty, isSelected, itemProperty, selectedProperty, setEditable, setItem, updateSelected
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
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
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayout
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
public final ObjectProperty<StringConverter<T>> converterProperty
StringConverter
property.getConverter()
,
setConverter(StringConverter)
public final BooleanProperty comboBoxEditableProperty
public ComboBoxTreeCell()
public ComboBoxTreeCell(T... items)
ComboBoxTreeCell
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 ComboBoxTreeCell(StringConverter<T> converter, T... items)
ComboBoxTreeCell
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 ComboBoxTreeCell(ObservableList<T> items)
ComboBoxTreeCell
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 ComboBoxTreeCell(StringConverter<T> converter, ObservableList<T> items)
ComboBoxTreeCell
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 static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView(T... items)
TreeView
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 tree cell.T
- The type of the elements contained within the TreeView.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 TreeViewvalue
property.Callback
that will return a TreeCell that is able to
work on the type of element contained within the TreeView.public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView(ObservableList<T> items)
TreeView
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 tree cell, excluding the space
allocated to the tree cell indentation and disclosure node(i.e. the arrow).T
- The type of the TreeItem
elements contained within the
TreeView.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 TreeView generic type,
such that upon selection, they replace the existing value in the
TreeItem
that is being edited (as noted in the
TreeView.editingItemProperty()
.Callback
that will return a TreeCell that is able to
work on the type of element contained within the TreeView.public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView(StringConverter<T> converter, T... items)
TreeView
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 tree cell.T
- The type of the elements contained within the TreeView.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 TreeViewvalue
property.Callback
that will return a TreeCell that is able to
work on the type of element contained within the TreeView.public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView(StringConverter<T> converter, ObservableList<T> items)
TreeView
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 tree cell.T
- The type of the elements contained within the TreeView.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 TreeView generic type,
such that upon selection, they replace the existing value in the
TreeItem
that is being edited (as noted in the
TreeView.editingItemProperty()
.Callback
that will return a TreeCell that is able to
work on the type of element contained within the TreeView.public final ObjectProperty<StringConverter<T>> converterProperty()
StringConverter
property.getConverter()
,
setConverter(StringConverter)
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()
public final void setComboBoxEditable(boolean value)
public final boolean isComboBoxEditable()
public ObservableList<T> getItems()
public void startEdit()
public void cancelEdit()
cancelEdit
in class TreeCell<T>
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
.
updateItem
in class Cell<T>
item
- The new item for the cellempty
- 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, 2014, Oracle and/or its affiliates. All rights reserved.