JavaFX 24 · javafx.scene.control.TableCell · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final InvalidationListener	columnIdListener
private int	columnIndex
private ListChangeListener<String>	columnStyleClassListener
private final InvalidationListener	columnStyleListener
private ObservableValue<T>	currentObservableValue
private static final String	DEFAULT_STYLE_CLASS Hides javafx.scene.control.IndexedCell.DEFAULT_STYLE_CLASS.
private TablePosition<S, T>	editingCellAtStartEdit
private final InvalidationListener	editingListener
private final InvalidationListener	focusedListener
private boolean	isFirstRun
private boolean	isLastVisibleColumn
private boolean	itemDirty Hides javafx.scene.control.Cell.itemDirty.
private WeakReference<S>	oldRowItemRef
private static final PseudoClass	PSEUDO_CLASS_LAST_VISIBLE
private ListChangeListener<TablePosition<S, T>>	selectedListener
private ReadOnlyObjectWrapper<TableColumn<S, T>>	tableColumn
private ReadOnlyObjectWrapper<TableRow<S>>	tableRow The TableRow that this TableCell currently finds itself placed within.
private final InvalidationListener	tableRowUpdateObserver
private ReadOnlyObjectWrapper<TableView<S>>	tableView
private boolean	updateEditingIndex
private ListChangeListener<TableColumn<S, ?>>	visibleLeafColumnsListener
private final WeakInvalidationListener	weakColumnIdListener
private final WeakListChangeListener<String>	weakColumnStyleClassListener
private final WeakInvalidationListener	weakColumnStyleListener
private final WeakInvalidationListener	weakEditingListener
private final WeakInvalidationListener	weakFocusedListener
private final WeakListChangeListener<TablePosition<S, T>>	weakSelectedListener
private final WeakInvalidationListener	weaktableRowUpdateObserver
private final WeakListChangeListener<TableColumn<S, ?>>	weakVisibleLeafColumnsListener

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

Method Summary

Modifier and Type	Method and Description
public void	cancelEdit() Overrides javafx.scene.control.Cell.cancelEdit. Cancels an edit to the value of the cell.
private void	cleanUpTableViewListeners(TableView<S> tableView)
public void	commitEdit(T 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 newValue) Overrides javafx.scene.control.Cell.commitEdit. Commits an edit to the value of the cell.
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
private void	doCancelEdit() Switches an editing cell into not editing without changing control's editing state.
public void	executeAccessibleAction(AccessibleAction the action to execute action, Object... optional list of parameters parameters) Overrides javafx.scene.control.Control.executeAccessibleAction. This method is called by the assistive technology to request the action indicated by the argument should be executed.
pack-priv TablePosition<S, T>	getEditingCellAtStartEdit()
public final TableColumn<S, T>	getTableColumn()
public final TableRow<S>	getTableRow()
public final TableView<S>	getTableView()
pack-priv void	indexChanged(int the old index oldIndex, int the new index newIndex) Overrides javafx.scene.control.IndexedCell.indexChanged. This method is called whenever the index is changed, regardless of whether the new index is the same as the old index.
private boolean	isInCellSelectionMode()
protected void	layoutChildren() Overrides javafx.scene.control.Cell.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
private boolean	match(TablePosition<S, ?> pos)
private void	possiblySetId(String idCandidate)
private void	possiblySetStyle(String styleCandidate)
public Object	queryAccessibleAttribute(AccessibleAttribute the requested attribute attribute, Object... optional list of parameters parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
private void	setTableColumn(TableColumn<S, T> value)
private void	setTableRow(TableRow<S> value)
private void	setTableView(TableView<S> value)
public void	startEdit() Overrides javafx.scene.control.Cell.startEdit. Starts an edit to the value of the cell.
public final ReadOnlyObjectProperty<TableColumn<S, T>>	Returns: the TableColumn instance that backs this TableCell tableColumnProperty() The TableColumn instance that backs this TableCell.
public final ReadOnlyObjectProperty<TableRow<S>>	tableRowProperty()
public final ReadOnlyObjectProperty<TableView<S>>	Returns: the TableView associated with this TableCell tableViewProperty() The TableView associated with this TableCell.
private ReadOnlyObjectWrapper<TableView<S>>	tableViewPropertyImpl()
private void	updateColumnIndex()
private void	updateEditing()
private void	updateFocus()
private void	updateItem(int oldIndex)
public void	updateSelected(boolean whether or not to select this cell. selected) Overrides javafx.scene.control.Cell.updateSelected. Updates whether this cell is in a selected state or not.
private void	updateSelection()
public final void	updateTableColumn(TableColumn<S, T> the TableColumn associated with this TableCell col) Updates the TableColumn associated with this TableCell.
public final void	updateTableRow(TableRow<T> the TableRow associated with this TableCell tableRow) Updates the TableRow associated with this TableCell.
public final void	updateTableView(TableView<S> the TableView associated with this TableCell tv) Updates the TableView associated with this TableCell.

Inherited from javafx.scene.control.IndexedCell:: getIndex indexProperty updateIndex

Field Detail

columnIdListener	back to summary
private final InvalidationListener columnIdListener

columnIndex	back to summary
private int columnIndex

columnStyleClassListener	back to summary
private ListChangeListener<String> columnStyleClassListener

columnStyleListener	back to summary
private final InvalidationListener columnStyleListener

currentObservableValue	back to summary
private ObservableValue<T> currentObservableValue

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS Hides javafx.scene.control.IndexedCell.DEFAULT_STYLE_CLASS.

editingCellAtStartEdit	back to summary
private TablePosition<S, T> editingCellAtStartEdit

editingListener	back to summary
private final InvalidationListener editingListener

focusedListener	back to summary
private final InvalidationListener focusedListener

isFirstRun	back to summary
private boolean isFirstRun

isLastVisibleColumn	back to summary
private boolean isLastVisibleColumn

itemDirty	back to summary
private boolean itemDirty Hides javafx.scene.control.Cell.itemDirty.

oldRowItemRef	back to summary
private WeakReference<S> oldRowItemRef

PSEUDO_CLASS_LAST_VISIBLE	back to summary
private static final PseudoClass PSEUDO_CLASS_LAST_VISIBLE

selectedListener	back to summary
private ListChangeListener<TablePosition<S, T>> selectedListener

tableColumn	back to summary
private ReadOnlyObjectWrapper<TableColumn<S, T>> tableColumn

tableRow	back to summary
private ReadOnlyObjectWrapper<TableRow<S>> tableRow 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.

tableRowUpdateObserver	back to summary
private final InvalidationListener tableRowUpdateObserver

tableView	back to summary
private ReadOnlyObjectWrapper<TableView<S>> tableView

updateEditingIndex	back to summary
private boolean updateEditingIndex

visibleLeafColumnsListener	back to summary
private ListChangeListener<TableColumn<S, ?>> visibleLeafColumnsListener

weakColumnIdListener	back to summary
private final WeakInvalidationListener weakColumnIdListener

weakColumnStyleClassListener	back to summary
private final WeakListChangeListener<String> weakColumnStyleClassListener

weakColumnStyleListener	back to summary
private final WeakInvalidationListener weakColumnStyleListener

weakEditingListener	back to summary
private final WeakInvalidationListener weakEditingListener

weakFocusedListener	back to summary
private final WeakInvalidationListener weakFocusedListener

weakSelectedListener	back to summary
private final WeakListChangeListener<TablePosition<S, T>> weakSelectedListener

weaktableRowUpdateObserver	back to summary
private final WeakInvalidationListener weaktableRowUpdateObserver

weakVisibleLeafColumnsListener	back to summary
private final WeakListChangeListener<TableColumn<S, ?>> weakVisibleLeafColumnsListener

Constructor Detail

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

Method Detail

cancelEdit	back to summary
public void cancelEdit() Overrides javafx.scene.control.Cell.cancelEdit. Doc from javafx.scene.control.Cell.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. Annotations @Override

cancelEdit

back to summary

public void cancelEdit()

Overrides javafx.scene.control.Cell.cancelEdit.

Doc from javafx.scene.control.Cell.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.

Annotations

@Override

cleanUpTableViewListeners	back to summary
private void cleanUpTableViewListeners(TableView<S> tableView)

commitEdit back to summary

commitEdit	back to summary
public void commitEdit(T newValue) Overrides javafx.scene.control.Cell.commitEdit. Doc from javafx.scene.control.Cell.commitEdit. 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: 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. 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()));` Parameters newValue:T 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 Annotations @Override

public void commitEdit(T newValue)

Overrides javafx.scene.control.Cell.commitEdit.

Doc from javafx.scene.control.Cell.commitEdit.

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:

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.
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()));

Parameters

newValue:T: 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

Annotations

@Override

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.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(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.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(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

doCancelEdit	back to summary
private void doCancelEdit() Switches an editing cell into not editing without changing control's editing state.

executeAccessibleAction	back to summary
public void executeAccessibleAction(AccessibleAction action, Object... parameters) Overrides javafx.scene.control.Control.executeAccessibleAction. Doc from javafx.scene.control.Control.executeAccessibleAction. 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. Parameters action:AccessibleAction Doc from javafx.scene.Node.executeAccessibleAction. the action to execute parameters:Object[] Doc from javafx.scene.Node.executeAccessibleAction. optional list of parameters Annotations @Override

executeAccessibleAction

back to summary

public void executeAccessibleAction(AccessibleAction action, Object... parameters)

Overrides javafx.scene.control.Control.executeAccessibleAction.

Doc from javafx.scene.control.Control.executeAccessibleAction.

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.

Parameters

action:AccessibleAction

Doc from javafx.scene.Node.executeAccessibleAction.

the action to execute

parameters:Object[]

Doc from javafx.scene.Node.executeAccessibleAction.

optional list of parameters

Annotations

@Override

getEditingCellAtStartEdit	back to summary
pack-priv TablePosition<S, T> getEditingCellAtStartEdit()

getTableColumn	back to summary
public final TableColumn<S, T> getTableColumn()

getTableRow	back to summary
public final TableRow<S> getTableRow()

getTableView	back to summary
public final TableView<S> getTableView()

indexChanged	back to summary
pack-priv void indexChanged(int oldIndex, int newIndex) Overrides javafx.scene.control.IndexedCell.indexChanged. Doc from javafx.scene.control.IndexedCell.indexChanged. This method is called whenever the index is changed, regardless of whether the new index is the same as the old index. Parameters oldIndex:int the old index newIndex:int the new index Annotations @Override

indexChanged

back to summary

pack-priv void indexChanged(int oldIndex, int newIndex)

Overrides javafx.scene.control.IndexedCell.indexChanged.

Doc from javafx.scene.control.IndexedCell.indexChanged.

This method is called whenever the index is changed, regardless of whether the new index is the same as the old index.

Parameters

oldIndex:int: the old index
newIndex:int: the new index

Annotations

@Override

isInCellSelectionMode	back to summary
private boolean isInCellSelectionMode()

layoutChildren back to summary

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.control.Cell.layoutChildren. Doc from javafx.scene.control.Cell.layoutChildren. 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. Annotations @Override

protected void layoutChildren()

Overrides javafx.scene.control.Cell.layoutChildren.

Doc from javafx.scene.control.Cell.layoutChildren.

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.

Annotations

@Override

match	back to summary
private boolean match(TablePosition<S, ?> pos)

possiblySetId	back to summary
private void possiblySetId(String idCandidate)

possiblySetStyle	back to summary
private void possiblySetStyle(String styleCandidate)

queryAccessibleAttribute	back to summary
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. Doc from javafx.scene.control.Control.queryAccessibleAttribute. 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. Parameters attribute:AccessibleAttribute Doc from javafx.scene.Node.queryAccessibleAttribute. the requested attribute parameters:Object[] Doc from javafx.scene.Node.queryAccessibleAttribute. optional list of parameters Returns:Object Doc from javafx.scene.Node.queryAccessibleAttribute. the value for the requested attribute Annotations @Override

queryAccessibleAttribute

back to summary

public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.Control.queryAccessibleAttribute.

Doc from javafx.scene.control.Control.queryAccessibleAttribute.

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.

Parameters

attribute:AccessibleAttribute

Doc from javafx.scene.Node.queryAccessibleAttribute.

the requested attribute

parameters:Object[]

Doc from javafx.scene.Node.queryAccessibleAttribute.

optional list of parameters

Returns:Object

Doc from javafx.scene.Node.queryAccessibleAttribute.

the value for the requested attribute

Annotations

@Override

setTableColumn	back to summary
private void setTableColumn(TableColumn<S, T> value)

setTableRow	back to summary
private void setTableRow(TableRow<S> value)

setTableView	back to summary
private void setTableView(TableView<S> value)

startEdit

back to summary

public void startEdit()

Overrides javafx.scene.control.Cell.startEdit.

Doc from javafx.scene.control.Cell.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.

Annotations

@Override

tableColumnProperty

back to summary

public final ReadOnlyObjectProperty<TableColumn<S, T>> tableColumnProperty()

The TableColumn instance that backs this TableCell.

Returns:ReadOnlyObjectProperty<TableColumn<S, T>>: the TableColumn instance that backs this TableCell

tableRowProperty	back to summary
public final ReadOnlyObjectProperty<TableRow<S>> tableRowProperty()

tableViewProperty

back to summary

public final ReadOnlyObjectProperty<TableView<S>> tableViewProperty()

The TableView associated with this TableCell.

Returns:ReadOnlyObjectProperty<TableView<S>>: the TableView associated with this TableCell

tableViewPropertyImpl	back to summary
private ReadOnlyObjectWrapper<TableView<S>> tableViewPropertyImpl()

updateColumnIndex	back to summary
private void updateColumnIndex()

updateEditing	back to summary
private void updateEditing()

updateFocus	back to summary
private void updateFocus()

updateItem	back to summary
private void updateItem(int oldIndex)

updateSelected

back to summary

public void updateSelected(boolean selected)

Overrides javafx.scene.control.Cell.updateSelected.

Doc from javafx.scene.control.Cell.updateSelected.

Updates whether this cell is in a selected state or not.

Parameters

selected:boolean: whether or not to select this cell.

Annotations

@Override

updateSelection	back to summary
private void updateSelection()

updateTableColumn

back to summary

public final void updateTableColumn(TableColumn<S, T> 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:TableColumn<S, T>: the TableColumn associated with this TableCell

updateTableRow

back to summary

public final void updateTableRow(TableRow<T> 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:TableRow<T>: the TableRow associated with this TableCell

updateTableView

back to summary

public final void updateTableView(TableView<S> 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:TableView<S>: the TableView associated with this TableCell

public Class TableCell<S, T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail