javafx.scene.control.cell

Class ChoiceBoxTreeCell<T>

java.lang.Object

<any>

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

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

Type Parameters:

T - The type of the TreeItems contained within the TreeView.

public class ChoiceBoxTreeCell<T>
extends DefaultTreeCell<T>

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

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

To create a ChoiceBoxTreeCell, it is necessary to provide zero or more items that will be shown to the user when the ChoiceBox 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().

Since:

JavaFX 2.2

Property Summary

Type	Property and Description
<any>	converter The StringConverter property.

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	choiceBox
private <any>	converter * Properties * *
private HBox	hbox
private <any>	items * Fields * *

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cancelEdit()
<any>	converterProperty() The StringConverter property.
static <T> <any>	forTreeView(<any> items) Creates a ChoiceBox cell factory for use in TreeView controls.
static <T> <any>	forTreeView(<any> converter, <any> items) Creates a ChoiceBox cell factory for use in TreeView controls.
static <T> <any>	forTreeView(<any> converter, T... items) Creates a ChoiceBox cell factory for use in TreeView controls.
static <T> <any>	forTreeView(T... items) Creates a ChoiceBox 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 ChoiceBox when it is showing.
private Node	getTreeItemGraphic() * Private Implementation * *
void	setConverter(<any> value) Sets the StringConverter to be used in this cell.
void	startEdit()
void	updateItem(T item, boolean empty)

Methods inherited from class javafx.scene.control.cell.DefaultTreeCell

updateDisplay

Methods inherited from class java.lang.Object

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

Property Detail

converter

public final <any> converterProperty

The StringConverter property.

Returns:

the StringConverter property

Field Detail

items

private final <any> items

* Fields * *

choiceBox

private <any> choiceBox

hbox

private HBox hbox

converter

private <any> converter

* Properties * *

Constructor Detail

ChoiceBoxTreeCell

public ChoiceBoxTreeCell()

Creates a default ChoiceBoxTreeCell with an empty items list.

ChoiceBoxTreeCell

@SafeVarargs
public ChoiceBoxTreeCell(T... items)

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

Parameters:

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

ChoiceBoxTreeCell

@SafeVarargs
public ChoiceBoxTreeCell(<any> converter,
                                      T... items)

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

Parameters:

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

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

ChoiceBoxTreeCell

public ChoiceBoxTreeCell(<any> items)

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

Parameters:

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

ChoiceBoxTreeCell

public ChoiceBoxTreeCell(<any> converter,
                         <any> items)

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

Parameters:

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

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

Method Detail

forTreeView

@SafeVarargs
public static <T> <any> forTreeView(T... items)

Creates a ChoiceBox cell factory for use in TreeView controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire tree cell.

Type Parameters:

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

Parameters:

items - Zero or more items that will be shown to the user when the ChoiceBox 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.

Returns:

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

forTreeView

public static <T> <any> forTreeView(<any> items)

Creates a ChoiceBox cell factory for use in TreeView controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox 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).

Type Parameters:

T - The type of the TreeItem elements contained within the TreeView.

Parameters:

items - An ObservableList containing zero or more items that will be shown to the user when the ChoiceBox 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().

Returns:

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

forTreeView

@SafeVarargs
public static <T> <any> forTreeView(<any> converter,
                                                 T... items)

Creates a ChoiceBox cell factory for use in TreeView controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire tree cell.

Type Parameters:

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

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 ChoiceBox 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.

Returns:

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

forTreeView

public static <T> <any> forTreeView(<any> converter,
                                    <any> items)

Creates a ChoiceBox cell factory for use in TreeView controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire tree cell.

Type Parameters:

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

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 ChoiceBox 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().

Returns:

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

converterProperty

public final <any> converterProperty()

The StringConverter property.

Returns:

the StringConverter property

setConverter

public final void setConverter(<any> value)

Sets the StringConverter to be used in this cell.

Parameters:

value - the StringConverter to be used in this cell

getConverter

public final <any> getConverter()

Returns the StringConverter used in this cell.

Returns:

the StringConverter used in this cell

getItems

public <any> getItems()

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

Returns:

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

startEdit

public void startEdit()

cancelEdit

public void cancelEdit()

updateItem

public void updateItem(T item,
                       boolean empty)

Overrides:

updateItem in class DefaultTreeCell<T>

getTreeItemGraphic

private Node getTreeItemGraphic()

* Private Implementation * *