javafx.scene.control.cell

Class ComboBoxListCell<T>

java.lang.Object

<any>

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

Type Parameters:

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

public class ComboBoxListCell<T>
extends <any>

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

By default, the ComboBoxListCell 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.

To create a ComboBoxListCell, 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 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
BooleanProperty	comboBoxEditable A property representing whether the ComboBox, when shown to the user, is editable or not.
<any>	converter The StringConverter property.

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	comboBox
private BooleanProperty	comboBoxEditable
private <any>	converter * Properties * *
private <any>	items * Fields * *

Constructor Summary

Constructors

Constructor and Description
ComboBoxListCell() Creates a default ComboBoxListCell with an empty items list.
ComboBoxListCell(<any> items) Creates a default ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown.
ComboBoxListCell(<any> converter, <any> items) Creates a ComboBoxListCell 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.
ComboBoxListCell(<any> converter, T... items) Creates a ComboBoxListCell 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.
ComboBoxListCell(T... items) Creates a default ComboBoxListCell instance with the given items being used to populate the ComboBox when it is shown.

Method Summary

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>	forListView(<any> items) Creates a ComboBox cell factory for use in ListView controls.
static <T> <any>	forListView(<any> converter, <any> items) Creates a ComboBox cell factory for use in ListView controls.
static <T> <any>	forListView(<any> converter, T... items) Creates a ComboBox cell factory for use in ListView controls.
static <T> <any>	forListView(T... items) Creates a ComboBox 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.
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)

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

comboBoxEditable

public final BooleanProperty comboBoxEditableProperty

A property representing whether the ComboBox, when shown to the user, is editable or not.

See Also:

isComboBoxEditable(), setComboBoxEditable(boolean)

Field Detail

items

private final <any> items

* Fields * *

comboBox

private <any> comboBox

converter

private <any> converter

* Properties * *

comboBoxEditable

private BooleanProperty comboBoxEditable

Constructor Detail

ComboBoxListCell

public ComboBoxListCell()

Creates a default ComboBoxListCell with an empty items list.

ComboBoxListCell

@SafeVarargs
public ComboBoxListCell(T... items)

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

Parameters:

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

ComboBoxListCell

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

Creates a ComboBoxListCell 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.

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 ComboBox popup menu.

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

ComboBoxListCell

public ComboBoxListCell(<any> items)

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

Parameters:

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

ComboBoxListCell

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

Creates a ComboBoxListCell 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.

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 ComboBox popup menu.

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

Method Detail

forListView

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

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

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 ComboBox 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 ComboBox cell factory for use in ListView 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.

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 ComboBox 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 ComboBox cell factory for use in ListView 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.

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 ComboBox 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 ComboBox cell factory for use in ListView 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.

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 ComboBox 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

comboBoxEditableProperty

public final BooleanProperty comboBoxEditableProperty()

A property representing whether the ComboBox, when shown to the user, is editable or not.

See Also:

isComboBoxEditable(), setComboBoxEditable(boolean)

setComboBoxEditable

public final void setComboBoxEditable(boolean value)

Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list).

Parameters:

value - the editable value for this ComboBox

isComboBoxEditable

public final boolean isComboBoxEditable()

Returns true if the ComboBox is editable.

Returns:

true if the ComboBox is editable

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)