javafx.scene.control.cell

Class ChoiceBoxListCell<T>

java.lang.Object

<any>

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

Type Parameters:

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

public class ChoiceBoxListCell<T>
extends <any>

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

By default, the ChoiceBoxListCell 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 list cell.

To create a ChoiceBoxListCell, 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 ListView items sequence, such that upon selection, they replace the existing value in the items list.

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 <any>	items * Fields * *

Constructor Summary

Constructors

Constructor and Description
ChoiceBoxListCell() Creates a default ChoiceBoxListCell with an empty items list.
ChoiceBoxListCell(<any> items) Creates a default ChoiceBoxListCell instance with the given items being used to populate the ChoiceBox when it is shown.
ChoiceBoxListCell(<any> converter, <any> items) Creates a ChoiceBoxListCell 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.
ChoiceBoxListCell(<any> converter, T... items) Creates a ChoiceBoxListCell 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.
ChoiceBoxListCell(T... items) Creates a default ChoiceBoxListCell 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>	forListView(<any> items) Creates a ChoiceBox cell factory for use in ListView controls.
static <T> <any>	forListView(<any> converter, <any> items) Creates a ChoiceBox cell factory for use in ListView controls.
static <T> <any>	forListView(<any> converter, T... items) Creates a ChoiceBox cell factory for use in ListView controls.
static <T> <any>	forListView(T... items) Creates a ChoiceBox cell factory for use in ListView 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.
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 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

converter

private <any> converter

* Properties * *

Constructor Detail

ChoiceBoxListCell

public ChoiceBoxListCell()

Creates a default ChoiceBoxListCell with an empty items list.

ChoiceBoxListCell

@SafeVarargs
public ChoiceBoxListCell(T... items)

Creates a default ChoiceBoxListCell 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.

ChoiceBoxListCell

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

Creates a ChoiceBoxListCell 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 StringConverter 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.

ChoiceBoxListCell

public ChoiceBoxListCell(<any> items)

Creates a default ChoiceBoxListCell 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.

ChoiceBoxListCell

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

Creates a ChoiceBoxListCell 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 StringConverter 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

forListView

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

Creates a ChoiceBox cell factory for use in ListView 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 list cell.

Type Parameters:

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

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 ListView items list, such that upon selection, they replace the existing value in the items list.

Returns:

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

forListView

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

Creates a ChoiceBox cell factory for use in ListView 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 list cell.

Type Parameters:

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

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 ListView items list, such that upon selection, they replace the existing value in the items list.

Returns:

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

forListView

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

Creates a ChoiceBox cell factory for use in ListView 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 list cell.

Type Parameters:

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

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 ListView items sequence, such that upon selection, they replace the existing value in the items list.

Returns:

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

forListView

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

Creates a ChoiceBox cell factory for use in ListView 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 list cell.

Type Parameters:

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

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 ListView items sequence, such that upon selection, they replace the existing value in the items list.

Returns:

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

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)