Module javafx.controls
Package javafx.scene.control.cell

Class TextFieldListCell<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
javafx.scene.control.Cell<T>
javafx.scene.control.IndexedCell<T>
javafx.scene.control.ListCell<T>
javafx.scene.control.cell.TextFieldListCell<T>
Type Parameters:
T - The type of the elements contained within the ListView.
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
public class TextFieldListCell<T>
extends ListCell<T>
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 Details

  • Constructor Details

    • 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​(StringConverter<T> 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 Details

    • forListView

      public static Callback<ListView<String>,​ListCell<String>> 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> Callback<ListView<T>,​ListCell<T>> forListView​(StringConverter<T> 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 ObjectProperty<StringConverter<T>> converterProperty()
      The StringConverter property.
      Returns:
      the StringConverter property

    • setConverter

      public final void setConverter​(StringConverter<T> value)
      Sets the StringConverter to be used in this cell.
      Parameters:
      value - the StringConverter to be used in this cell

    • getConverter

      public final StringConverter<T> getConverter()
      Returns the StringConverter used in this cell.
      Returns:
      the StringConverter used in this cell

    • startEdit

      public void startEdit()
      Call this function to transition from a non-editing state into an editing state, if the cell is editable. If this cell is already in an editing state, it will stay in it.
      Overrides:
      startEdit in class ListCell<T>

    • cancelEdit

      public void cancelEdit()
      Call this function to transition from an editing state into a non-editing state, without saving any user input.
      Overrides:
      cancelEdit in class ListCell<T>

    • updateItem

      public void updateItem​(T item, boolean empty)
      The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. To clarify, developers should never call this method in their code (they should leave it up to the UI control, such as the ListView control) to call this method. However, the purpose of having the updateItem method is so that developers, when specifying custom cell factories (again, like the ListView cell factory), the updateItem method can be overridden to allow for complete customisation of the cell.

      It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method: 

       protected void updateItem(T item, boolean empty) {
     super.updateItem(item, empty);

     if (empty || item == null) {
         setText(null);
         setGraphic(null);
     } else {
         setText(item.toString());
     }
 }

      Note in this code sample two important points:

      1. We call the super.updateItem(T, boolean) method. If this is not done, the item and empty properties are not correctly set, and you are likely to end up with graphical issues.
      2. We test for the empty condition, and if true, we set the text and graphic properties to null. If we do not do this, it is almost guaranteed that end users will see graphical artifacts in cells unexpectedly.
      Overrides:
      updateItem in class Cell<T>
      Parameters:
      item - The new item for the cell.
      empty - whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.