JavaFX 27 · javafx.scene.control.TreeCell · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final PseudoClass	COLLAPSED_PSEUDOCLASS_STATE
private static final String	DEFAULT_STYLE_CLASS Hides javafx.scene.control.IndexedCell.DEFAULT_STYLE_CLASS.
private ObjectProperty<Node>	disclosureNode
private final InvalidationListener	editingListener
private static final PseudoClass	EXPANDED_PSEUDOCLASS_STATE
private final InvalidationListener	focusedListener
private final ChangeListener<FocusModel<TreeItem<T>>>	focusModelPropertyListener Listens to the focusModel property on the TreeView.
private boolean	isFirstRun
private final InvalidationListener	leafListener
private boolean	oldIsExpanded
private final InvalidationListener	rootPropertyListener
private final ListChangeListener<Integer>	selectedListener
private final ChangeListener<MultipleSelectionModel<TreeItem<T>>>	selectionModelPropertyListener Listens to the selectionModel property on the TreeView.
private ReadOnlyObjectWrapper<TreeItem<T>>	treeItem
private TreeItem<T>	treeItemAtStartEdit
private final InvalidationListener	treeItemExpandedInvalidationListener
private ReadOnlyObjectWrapper<TreeView<T>>	treeView
private boolean	updateEditingIndex
private final WeakInvalidationListener	weakEditingListener
private final WeakInvalidationListener	weakFocusedListener
private final WeakChangeListener<FocusModel<TreeItem<T>>>	weakFocusModelPropertyListener
private final WeakInvalidationListener	weakLeafListener
private final WeakInvalidationListener	weakRootPropertyListener
private final WeakListChangeListener<Integer>	weakSelectedListener
private final WeakChangeListener<MultipleSelectionModel<TreeItem<T>>>	weakSelectionModelPropertyListener
private final WeakInvalidationListener	weakTreeItemExpandedInvalidationListener

Access	Constructor and Description
public	TreeCell() Creates a default TreeCell instance.

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.
public void	commitEdit(T 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.
public final ObjectProperty<Node>	Returns: the disclosure node disclosureNodeProperty() The disclosure node is commonly seen represented as a triangle that rotates on screen to indicate whether or not the TreeItem that it is placed beside is expanded or collapsed.
private void	doCancelEditing()
public void	executeAccessibleAction(AccessibleAction action, Object... 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.
public final Node	Returns: the current disclosure node set in this TreeCell getDisclosureNode() Returns the current disclosure node set in this TreeCell.
public final TreeItem<T>	Returns: the TreeItem currently set in this TreeCell getTreeItem() Returns the TreeItem currently set in this TreeCell.
public final TreeView<T>	Returns: the TreeView associated with this TreeCell getTreeView() Returns the TreeView associated with this TreeCell.
pack-priv void	indexChanged(int oldIndex, int 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.
public Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
public final void	setDisclosureNode(Node the disclosure node value) The node to use as the "disclosure" triangle, or toggle, used for expanding and collapsing items.
private void	setTreeItem(TreeItem<T> value)
private void	setTreeView(TreeView<T> value)
public void	startEdit() Overrides javafx.scene.control.Cell.startEdit. Starts an edit to the value of the cell.
public final ReadOnlyObjectProperty<TreeItem<T>>	Returns: the TreeItem property representing this TreeCell treeItemProperty() Each TreeCell represents at most a single `TreeItem`, which is represented by this property.
public final ReadOnlyObjectProperty<TreeView<T>>	Returns: the TreeView property of this TreeCell treeViewProperty() A TreeCell is explicitly linked to a single `TreeView` instance, which is represented by this property.
private void	updateEditing()
private void	updateFocus()
private void	updateItem(int oldIndex)
private void	updateSelection()
public final void	updateTreeItem(TreeItem<T> The new TreeItem that should be associated with this TreeCell. 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. treeItem) Updates the TreeItem associated with this TreeCell.
public final void	updateTreeView(TreeView<T> The new TreeView that should be associated with this TreeCell. 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. tree) Updates the TreeView associated with this TreeCell.

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

Field Detail

COLLAPSED_PSEUDOCLASS_STATE	back to summary
private static final PseudoClass COLLAPSED_PSEUDOCLASS_STATE

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

disclosureNode	back to summary
private ObjectProperty<Node> disclosureNode

editingListener	back to summary
private final InvalidationListener editingListener

EXPANDED_PSEUDOCLASS_STATE	back to summary
private static final PseudoClass EXPANDED_PSEUDOCLASS_STATE

focusedListener	back to summary
private final InvalidationListener focusedListener

focusModelPropertyListener	back to summary
private final ChangeListener<FocusModel<TreeItem<T>>> focusModelPropertyListener Listens to the focusModel property on the TreeView. Whenever the entire model is changed, we have to unhook the weakFocusedListener and update the focus.

isFirstRun	back to summary
private boolean isFirstRun

leafListener	back to summary
private final InvalidationListener leafListener

oldIsExpanded	back to summary
private boolean oldIsExpanded

rootPropertyListener	back to summary
private final InvalidationListener rootPropertyListener

selectedListener	back to summary
private final ListChangeListener<Integer> selectedListener

selectionModelPropertyListener	back to summary
private final ChangeListener<MultipleSelectionModel<TreeItem<T>>> selectionModelPropertyListener Listens to the selectionModel property on the TreeView. Whenever the entire model is changed, we have to unhook the weakSelectedListener and update the selection.

treeItem	back to summary
private ReadOnlyObjectWrapper<TreeItem<T>> treeItem

treeItemAtStartEdit	back to summary
private TreeItem<T> treeItemAtStartEdit

treeItemExpandedInvalidationListener	back to summary
private final InvalidationListener treeItemExpandedInvalidationListener

treeView	back to summary
private ReadOnlyObjectWrapper<TreeView<T>> treeView

updateEditingIndex	back to summary
private boolean updateEditingIndex

weakEditingListener	back to summary
private final WeakInvalidationListener weakEditingListener

weakFocusedListener	back to summary
private final WeakInvalidationListener weakFocusedListener

weakFocusModelPropertyListener	back to summary
private final WeakChangeListener<FocusModel<TreeItem<T>>> weakFocusModelPropertyListener

weakLeafListener	back to summary
private final WeakInvalidationListener weakLeafListener

weakRootPropertyListener	back to summary
private final WeakInvalidationListener weakRootPropertyListener

weakSelectedListener	back to summary
private final WeakListChangeListener<Integer> weakSelectedListener

weakSelectionModelPropertyListener	back to summary
private final WeakChangeListener<MultipleSelectionModel<TreeItem<T>>> weakSelectionModelPropertyListener

weakTreeItemExpandedInvalidationListener	back to summary
private final WeakInvalidationListener weakTreeItemExpandedInvalidationListener

Constructor Detail

TreeCell	back to summary
public TreeCell() Creates a default TreeCell instance.

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

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

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

Annotations

@Override

disclosureNodeProperty	back to summary
public final ObjectProperty<Node> disclosureNodeProperty() The disclosure node is commonly seen represented as a triangle that rotates on screen to indicate whether or not the TreeItem that it is placed beside is expanded or collapsed. Returns:ObjectProperty<Node> the disclosure node

disclosureNodeProperty

back to summary

public final ObjectProperty<Node> disclosureNodeProperty()

The disclosure node is commonly seen represented as a triangle that rotates on screen to indicate whether or not the TreeItem that it is placed beside is expanded or collapsed.

Returns:ObjectProperty<Node>: the disclosure node

doCancelEditing	back to summary
private void doCancelEditing()

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

Annotations

@Override

getDisclosureNode	back to summary
public final Node getDisclosureNode() Returns the current disclosure node set in this TreeCell. Returns:Node the current disclosure node set in this TreeCell

getDisclosureNode

back to summary

public final Node getDisclosureNode()

Returns the current disclosure node set in this TreeCell.

Returns:Node: the current disclosure node set in this TreeCell

getTreeItem	back to summary
public final TreeItem<T> getTreeItem() Returns the TreeItem currently set in this TreeCell. Returns:TreeItem<T> the TreeItem currently set in this TreeCell

getTreeItem

back to summary

public final TreeItem<T> getTreeItem()

Returns the TreeItem currently set in this TreeCell.

Returns:TreeItem<T>: the TreeItem currently set in this TreeCell

getTreeView	back to summary
public final TreeView<T> getTreeView() Returns the TreeView associated with this TreeCell. Returns:TreeView<T> the TreeView associated with this TreeCell

getTreeView

back to summary

public final TreeView<T> getTreeView()

Returns the TreeView associated with this TreeCell.

Returns:TreeView<T>: the TreeView associated with this TreeCell

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

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

Annotations

@Override

setDisclosureNode	back to summary
public final void setDisclosureNode(Node value) The node to use as the "disclosure" triangle, or toggle, used for expanding and collapsing items. This is only used in the case of an item in the tree which contains child items. If not specified, the TreeCell's Skin implementation is responsible for providing a default disclosure node. Parameters value:Node the disclosure node

setDisclosureNode

back to summary

public final void setDisclosureNode(Node value)

The node to use as the "disclosure" triangle, or toggle, used for expanding and collapsing items. This is only used in the case of an item in the tree which contains child items. If not specified, the TreeCell's Skin implementation is responsible for providing a default disclosure node.

Parameters

value:Node: the disclosure node

setTreeItem	back to summary
private void setTreeItem(TreeItem<T> value)

setTreeView	back to summary
private void setTreeView(TreeView<T> 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

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

treeItemProperty back to summary

treeItemProperty	back to summary
public final ReadOnlyObjectProperty<TreeItem<T>> treeItemProperty() Each TreeCell represents at most a single `TreeItem`, which is represented by this property. Returns:ReadOnlyObjectProperty<TreeItem<T>> the TreeItem property representing this TreeCell

public final ReadOnlyObjectProperty<TreeItem<T>> treeItemProperty()

Each TreeCell represents at most a single TreeItem, which is represented by this property.

Returns:ReadOnlyObjectProperty<TreeItem<T>>: the TreeItem property representing this TreeCell

treeViewProperty back to summary

treeViewProperty	back to summary
public final ReadOnlyObjectProperty<TreeView<T>> treeViewProperty() A TreeCell is explicitly linked to a single `TreeView` instance, which is represented by this property. Returns:ReadOnlyObjectProperty<TreeView<T>> the TreeView property of this TreeCell

public final ReadOnlyObjectProperty<TreeView<T>> treeViewProperty()

A TreeCell is explicitly linked to a single TreeView instance, which is represented by this property.

Returns:ReadOnlyObjectProperty<TreeView<T>>: the TreeView property of this TreeCell

updateEditing	back to summary
private void updateEditing()

updateFocus	back to summary
private void updateFocus()

updateItem	back to summary
private void updateItem(int oldIndex)

updateSelection	back to summary
private void updateSelection()

updateTreeItem

back to summary

public final void updateTreeItem(TreeItem<T> treeItem)

Updates the TreeItem associated with this TreeCell.

Parameters

treeItem:TreeItem<T>: The new TreeItem that should be associated with this TreeCell.
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.

updateTreeView

back to summary

public final void updateTreeView(TreeView<T> tree)

Updates the TreeView associated with this TreeCell.

Parameters

tree:TreeView<T>: The new TreeView that should be associated with this TreeCell.
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.

public Class TreeCell<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail