Module javafx.controls
Package javafx.scene.control

Class TableCell<S,​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.TableCell<S,​T>
Type Parameters:
S - The type of the TableView generic type (i.e. S == TableView<S>). This should also match with the first generic type in TableColumn.
T - The type of the item contained within the Cell.
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
Direct Known Subclasses:
CheckBoxTableCell, ChoiceBoxTableCell, ComboBoxTableCell, ProgressBarTableCell, TextFieldTableCell
public class TableCell<S,​T>
extends IndexedCell<T>
Represents a single row/column intersection in a TableView. To represent this intersection, a TableCell contains an index property, as well as a tableColumn property. In addition, a TableCell instance knows what TableRow it exists in.

A note about selection: A TableCell visually shows it is selected when two conditions are met:

  1. The TableSelectionModel.isSelected(int, TableColumnBase) method returns true for the row / column that this cell represents, and
  2. The cell selection mode property is set to true (to represent that it is allowable to select individual cells (and not just rows of cells)).
Since:
JavaFX 2.0
See Also:
TableView, TableColumn, Cell, IndexedCell, TableRow

  • Property Details

    • tableColumn

      public final ReadOnlyObjectProperty<TableColumn<S,​T>> tableColumnProperty
      The TableColumn instance that backs this TableCell.
      Returns:
      the TableColumn instance that backs this TableCell

    • tableView

      public final ReadOnlyObjectProperty<TableView<S>> tableViewProperty
      The TableView associated with this TableCell.
      See Also:
      getTableView()

    • tableRow

      public final ReadOnlyObjectProperty<TableRow<S>> tableRowProperty
      The TableRow that this TableCell currently finds itself placed within. The TableRow may be null early in the TableCell lifecycle, in the period between the TableCell being instantiated and being set into an owner TableRow.
      See Also:
      getTableRow()

  • Constructor Details

    • TableCell

      public TableCell()
      Constructs a default TableCell instance with a style class of 'table-cell'

  • Method Details

    • tableColumnProperty

      public final ReadOnlyObjectProperty<TableColumn<S,​T>> tableColumnProperty()
      The TableColumn instance that backs this TableCell.
      Returns:
      the TableColumn instance that backs this TableCell

    • getTableColumn

      public final TableColumn<S,​T> getTableColumn()
      Gets the value of the property tableColumn.
      Property description:
      * Properties * *

    • getTableView

      public final TableView<S> getTableView()
      Gets the value of the property tableView.
      Property description:
      The TableView associated with this TableCell.

    • tableViewProperty

      public final ReadOnlyObjectProperty<TableView<S>> tableViewProperty()
      The TableView associated with this TableCell.
      See Also:
      getTableView()

    • getTableRow

      public final TableRow<S> getTableRow()
      Gets the value of the property tableRow.
      Property description:
      The TableRow that this TableCell currently finds itself placed within. The TableRow may be null early in the TableCell lifecycle, in the period between the TableCell being instantiated and being set into an owner TableRow.

    • tableRowProperty

      public final ReadOnlyObjectProperty<TableRow<S>> tableRowProperty()
      The TableRow that this TableCell currently finds itself placed within. The TableRow may be null early in the TableCell lifecycle, in the period between the TableCell being instantiated and being set into an owner TableRow.
      See Also:
      getTableRow()

    • startEdit

      public void startEdit()
      Starts an edit to the value of the cell. 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 Cell<T>

    • commitEdit

      public void commitEdit​(T newValue)
      Commits an edit to the value of the cell. Call this function when appropriate (based on the user interaction requirements of your cell editing user interface) to do two things:
      1. Fire the appropriate events back to the backing UI control (e.g., ListView). This will begin the process of pushing this edit back to the relevant data source / property (although it does not guarantee that this will be successful - that is dependent upon the specific edit commit handler being used). Refer to the UI control class javadoc for more detail.
      2. Begin the transition from an editing state into a non-editing state.

      In general there is no need to override this method in custom cell implementations - it should be sufficient to simply call this method when appropriate (e.g., when the user pressed the Enter key, you may do something like cell.commitEdit(converter.fromString(textField.getText()));

      Overrides:
      commitEdit in class Cell<T>
      Parameters:
      newValue - the value as input by the end user, which should be persisted in the relevant way given the data source underpinning the user interface and the install edit commit handler of the UI control

    • cancelEdit

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

    • updateSelected

      public void updateSelected​(boolean selected)
      Updates whether this cell is in a selected state or not.
      Overrides:
      updateSelected in class Cell<T>
      Parameters:
      selected - whether or not to select this cell.

    • createDefaultSkin

      protected Skin<?> createDefaultSkin()
      Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).
      Overrides:
      createDefaultSkin in class Control
      Returns:
      new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

    • layoutChildren

      protected void layoutChildren()
      Description copied from class: Cell
      Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

      Subclasses should override this function to layout content as needed.

      Overrides:
      layoutChildren in class Cell<T>

    • updateTableView

      public final void updateTableView​(TableView tv)
      Updates the TableView associated with this TableCell. This is typically only done once when the TableCell is first added to the TableView. Note: This function is intended to be used by experts, primarily by those implementing new Skins. It is not common for developers or designers to access this function directly.
      Parameters:
      tv - the TableView associated with this TableCell

    • updateTableRow

      public final void updateTableRow​(TableRow tableRow)
      Updates the TableRow associated with this TableCell. Note: This function is intended to be used by experts, primarily by those implementing new Skins. It is not common for developers or designers to access this function directly.
      Parameters:
      tableRow - the TableRow associated with this TableCell

    • updateTableColumn

      public final void updateTableColumn​(TableColumn col)
      Updates the TableColumn associated with this TableCell. Note: This function is intended to be used by experts, primarily by those implementing new Skins. It is not common for developers or designers to access this function directly.
      Parameters:
      col - the TableColumn associated with this TableCell

    • queryAccessibleAttribute

      public Object queryAccessibleAttribute​(AccessibleAttribute attribute, Object... parameters)
      This method is called by the assistive technology to request the value for an attribute.

      This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
      If a particular attribute is not handled, the superclass implementation must be called.

      Overrides:
      queryAccessibleAttribute in class Control
      Parameters:
      attribute - the requested attribute
      parameters - optional list of parameters
      Returns:
      the value for the requested attribute
      See Also:
      AccessibleAttribute

    • executeAccessibleAction

      public void executeAccessibleAction​(AccessibleAction action, Object... parameters)
      This method is called by the assistive technology to request the action indicated by the argument should be executed.

      This method is commonly overridden by subclasses to implement action that are required for a specific role.
      If a particular action is not handled, the superclass implementation must be called.

      Overrides:
      executeAccessibleAction in class Control
      Parameters:
      action - the action to execute
      parameters - optional list of parameters
      See Also:
      AccessibleAction