T
- The type of the TreeItems contained within the TreeView.public class ComboBoxTreeCell<T> extends DefaultTreeCell<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.
|
<any> |
converter
The
StringConverter property. |
Modifier and Type | Field and Description |
---|---|
private <any> |
comboBox |
private BooleanProperty |
comboBoxEditable |
private <any> |
converter
*
Properties *
*
|
private HBox |
hbox |
private <any> |
items
*
Fields *
*
|
Constructor and Description |
---|
ComboBoxTreeCell()
Creates a default ComboBoxTreeCell with an empty items list.
|
ComboBoxTreeCell(<any> items)
Creates a default
ComboBoxTreeCell instance with the given items
being used to populate the ComboBox when it is shown. |
ComboBoxTreeCell(<any> converter,
<any> 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(<any> 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() |
BooleanProperty |
comboBoxEditableProperty()
A property representing whether the ComboBox, when shown to the user,
is editable or not.
|
<any> |
converterProperty()
The
StringConverter property. |
static <T> <any> |
forTreeView(<any> items)
Creates a ComboBox cell factory for use in
TreeView controls. |
static <T> <any> |
forTreeView(<any> converter,
<any> items)
Creates a ComboBox cell factory for use in
TreeView controls. |
static <T> <any> |
forTreeView(<any> converter,
T... items)
Creates a ComboBox cell factory for use in
TreeView controls. |
static <T> <any> |
forTreeView(T... items)
Creates a ComboBox cell factory for use in
TreeView controls. |
<any> |
getConverter()
Returns the
StringConverter used in this cell. |
<any> |
getItems()
Returns the items to be displayed in the ComboBox 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(<any> value)
Sets the
StringConverter to be used in this cell. |
void |
startEdit() |
void |
updateItem(T item,
boolean empty) |
updateDisplay
public final <any> converterProperty
StringConverter
property.StringConverter
propertypublic final BooleanProperty comboBoxEditableProperty
isComboBoxEditable()
,
setComboBoxEditable(boolean)
private final <any> items
private <any> comboBox
private HBox hbox
private <any> converter
private BooleanProperty comboBoxEditable
public ComboBoxTreeCell()
@SafeVarargs 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.@SafeVarargs public ComboBoxTreeCell(<any> 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(<any> 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(<any> converter, <any> 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.@SafeVarargs public static <T> <any> 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 TreeView<T>, such that upon selection, they replace the
existing value in the TreeItem value
property.Callback
that will return a TreeCell that is able to
work on the type of element contained within the TreeView.public static <T> <any> forTreeView(<any> 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.@SafeVarargs public static <T> <any> forTreeView(<any> 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 TreeView<T>, such that upon selection, they replace the
existing value in the TreeItem value
property.Callback
that will return a TreeCell that is able to
work on the type of element contained within the TreeView.public static <T> <any> forTreeView(<any> converter, <any> 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 <any> converterProperty()
StringConverter
property.StringConverter
propertypublic final void setConverter(<any> value)
StringConverter
to be used in this cell.value
- the StringConverter
to be used in this cellpublic final <any> getConverter()
StringConverter
used in this cell.StringConverter
used in this cellpublic final BooleanProperty comboBoxEditableProperty()
isComboBoxEditable()
,
setComboBoxEditable(boolean)
public final void setComboBoxEditable(boolean value)
value
- the editable value to be set for this ComboBoxpublic final boolean isComboBoxEditable()
public <any> getItems()
public void startEdit()
public void cancelEdit()
public void updateItem(T item, boolean empty)
updateItem
in class DefaultTreeCell<T>