javafx.scene.control.cell

Class TextFieldListCell<T>

java.lang.Object

<any>

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

Type Parameters:

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

public class TextFieldListCell<T>
extends <any>

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

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

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>	converter * Properties * *
private TextField	textField * Fields * *

Constructor Summary

Constructors

Constructor and Description
TextFieldListCell() Creates a default TextFieldListCell with a null converter.
TextFieldListCell(<any> converter) Creates a TextFieldListCell that provides a TextField when put into editing mode that allows editing of the cell content.

Method Summary

Modifier and Type	Method and Description
void	cancelEdit()
<any>	converterProperty() The StringConverter property.
static <any>	forListView() Provides a TextField that allows editing of the cell content when the cell is double-clicked, or when ListView#edit(int) is called.
static <T> <any>	forListView(<any> converter) Provides a TextField that allows editing of the cell content when the cell is double-clicked, or when ListView#edit(int) is called.
<any>	getConverter() Returns the StringConverter used in this cell.
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

textField

private TextField textField

* Fields * *

converter

private <any> converter

* Properties * *

Constructor Detail

TextFieldListCell

public TextFieldListCell()

Creates a default TextFieldListCell with a null converter. Without a StringConverter specified, this cell will not be able to accept input from the TextField (as it will not know how to convert this back to the domain object). It is therefore strongly encouraged to not use this constructor unless you intend to set the converter separately.

TextFieldListCell

public TextFieldListCell(<any> converter)

Creates a TextFieldListCell that provides a TextField when put into editing mode that allows editing of the cell content. This method will work on any ListView instance, regardless of its generic type. However, to enable this, a StringConverter must be provided that will convert the given String (from what the user typed in) into an instance of type T. This item will then be passed along to the ListView#onEditCommitProperty() callback.

Parameters:

converter - A converter that can convert the given String (from what the user typed in) into an instance of type T.

Method Detail

forListView

public static <any> forListView()

Provides a TextField that allows editing of the cell content when the cell is double-clicked, or when ListView#edit(int) is called. This method will only work on ListView instances which are of type String.

Returns:

A Callback that can be inserted into the cell factory property of a ListView, that enables textual editing of the content.

forListView

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

Provides a TextField that allows editing of the cell content when the cell is double-clicked, or when ListView#edit(int) is called. This method will work on any ListView instance, regardless of its generic type. However, to enable this, a StringConverter must be provided that will convert the given String (from what the user typed in) into an instance of type T. This item will then be passed along to the ListView#onEditCommitProperty() callback.

Type Parameters:

T - The type of the item contained within the Cell

Parameters:

converter - A StringConverter that can convert the given String (from what the user typed in) into an instance of type T.

Returns:

A Callback that can be inserted into the cell factory property of a ListView, that enables textual editing of the content.

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

startEdit

public void startEdit()

cancelEdit

public void cancelEdit()

updateItem

public void updateItem(T item,
                       boolean empty)