javafx.scene.control

Class TreeCell<T>

java.lang.Object

Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.Cell<T>

javafx.scene.control.IndexedCell<T>

javafx.scene.control.TreeCell<T>

Type Parameters:

T - The type of the value contained within the TreeItem property.

All Implemented Interfaces:

Skinnable

public class TreeCell<T>
extends IndexedCell<T>

The Cell type used with the TreeView control. In addition to the API defined on IndexedCell, the TreeCell exposes additional states and pseudo classes for use by CSS.

A TreeCell watches the selection model of the TreeView for which it is associated, ensuring that it visually indicates to the user whether it is selected. When a TreeCell is selected, this is exposed both via the selected property, as well as via the 'selected' CSS pseudo class state.

Due to the fact that TreeCell extends from IndexedCell, each TreeCell also provides an index property. The index will be updated as cells are expanded and collapsed, and therefore should be considered a view index rather than a model index.

Finally, each TreeCell also has a reference back to the TreeView that it is being used with. Each TreeCell belongs to one and only one TreeView.

Since:

JavaFX 2.0

See Also:

TreeView, TreeItem

Property Summary

Type	Property and Description
<any>	disclosureNode 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.
<any>	treeItem Each TreeCell represents at most a single TreeItem, which is represented by this property.
<any>	treeView A TreeCell is explicitly linked to a single TreeView instance, which is represented by this property.

Properties inherited from class javafx.scene.control.IndexedCell

indexProperty

Properties inherited from class javafx.scene.control.Cell

editableProperty, editingProperty, emptyProperty, itemProperty, selectedProperty

Properties inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, graphicProperty, graphicTextGapProperty, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Field Summary

Fields

Modifier and Type	Field and Description
private static PseudoClass	COLLAPSED_PSEUDOCLASS_STATE
private static java.lang.String	DEFAULT_STYLE_CLASS * Stylesheet Handling * *
private <any>	disclosureNode
private InvalidationListener	editingListener
private static PseudoClass	EXPANDED_PSEUDOCLASS_STATE
private InvalidationListener	focusedListener
private <any>	focusModelPropertyListener Listens to the focusModel property on the TreeView.
private boolean	isFirstRun
private InvalidationListener	leafListener
private boolean	oldIsExpanded
private InvalidationListener	rootPropertyListener
private <any>	selectedListener * Callbacks and events * *
private <any>	selectionModelPropertyListener Listens to the selectionModel property on the TreeView.
private <any>	treeItem * Properties * *
private InvalidationListener	treeItemExpandedInvalidationListener
private <any>	treeView
private boolean	updateEditingIndex
private WeakInvalidationListener	weakEditingListener
private WeakInvalidationListener	weakFocusedListener
private <any>	weakFocusModelPropertyListener
private WeakInvalidationListener	weakLeafListener
private WeakInvalidationListener	weakRootPropertyListener
private <any>	weakSelectedListener
private <any>	weakSelectionModelPropertyListener
private WeakInvalidationListener	weakTreeItemExpandedInvalidationListener

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cancelEdit() Call this function to transition from an editing state into a non-editing state, without saving any user input.
void	commitEdit(T newValue) 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.
protected Skin<?>	createDefaultSkin() Create a new instance of the default skin for this control.
<any>	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.
void	executeAccessibleAction(AccessibleAction action, java.lang.Object... parameters)
Node	getDisclosureNode() Returns the current disclosure node set in this TreeCell.
TreeItem<T>	getTreeItem() Returns the TreeItem currently set in this TreeCell.
TreeView<T>	getTreeView() Returns the TreeView associated with this TreeCell.
(package private) void	indexChanged(int oldIndex, int newIndex) This method is called whenever the index is changed, regardless of whether the new index is the same as the old index.
java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
void	setDisclosureNode(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)
void	startEdit() Call this function to transition from a non-editing state into an editing state, if the cell is editable.
<any>	treeItemProperty() Each TreeCell represents at most a single TreeItem, which is represented by this property.
<any>	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()
void	updateTreeItem(TreeItem<T> treeItem) Updates the TreeItem associated with this TreeCell.
void	updateTreeView(TreeView<T> tree) Updates the TreeView associated with this TreeCell.

Methods inherited from class javafx.scene.control.IndexedCell

getIndex, indexProperty, updateIndex

Methods inherited from class javafx.scene.control.Cell

editableProperty, editingProperty, emptyProperty, getInitialFocusTraversable, getItem, isEditable, isEditing, isEmpty, isItemChanged, isSelected, itemProperty, layoutChildren, selectedProperty, setEditable, setItem, setSelected, updateItem, updateSelected

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getSkin, getTooltip, isResizable, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

treeItem

public final <any> treeItemProperty

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

Returns:

the TreeItem property representing this TreeCell

disclosureNode

public final <any> 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.

See Also:

getDisclosureNode(), setDisclosureNode(Node)

treeView

public final <any> treeViewProperty

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

See Also:

getTreeView()

Field Detail

selectedListener

private final <any> selectedListener

* Callbacks and events * *

selectionModelPropertyListener

private final <any> 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.

focusedListener

private final InvalidationListener focusedListener

focusModelPropertyListener

private final <any> 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.

editingListener

private final InvalidationListener editingListener

leafListener

private final InvalidationListener leafListener

oldIsExpanded

private boolean oldIsExpanded

treeItemExpandedInvalidationListener

private final InvalidationListener treeItemExpandedInvalidationListener

rootPropertyListener

private final InvalidationListener rootPropertyListener

weakSelectedListener

private final <any> weakSelectedListener

weakSelectionModelPropertyListener

private final <any> weakSelectionModelPropertyListener

weakFocusedListener

private final WeakInvalidationListener weakFocusedListener

weakFocusModelPropertyListener

private final <any> weakFocusModelPropertyListener

weakEditingListener

private final WeakInvalidationListener weakEditingListener

weakLeafListener

private final WeakInvalidationListener weakLeafListener

weakTreeItemExpandedInvalidationListener

private final WeakInvalidationListener weakTreeItemExpandedInvalidationListener

weakRootPropertyListener

private final WeakInvalidationListener weakRootPropertyListener

treeItem

private <any> treeItem

* Properties * *

disclosureNode

private <any> disclosureNode

treeView

private <any> treeView

isFirstRun

private boolean isFirstRun

updateEditingIndex

private boolean updateEditingIndex

DEFAULT_STYLE_CLASS

private static final java.lang.String DEFAULT_STYLE_CLASS

* Stylesheet Handling * *

See Also:

Constant Field Values

EXPANDED_PSEUDOCLASS_STATE

private static final PseudoClass EXPANDED_PSEUDOCLASS_STATE

COLLAPSED_PSEUDOCLASS_STATE

private static final PseudoClass COLLAPSED_PSEUDOCLASS_STATE

Constructor Detail

TreeCell

public TreeCell()

Creates a default TreeCell instance.

Method Detail

setTreeItem

private void setTreeItem(TreeItem<T> value)

getTreeItem

public final TreeItem<T> getTreeItem()

Returns the TreeItem currently set in this TreeCell.

Returns:

the TreeItem currently set in this TreeCell

treeItemProperty

public final <any> treeItemProperty()

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

Returns:

the TreeItem property representing this TreeCell

setDisclosureNode

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 - the disclosure node

getDisclosureNode

public final Node getDisclosureNode()

Returns the current disclosure node set in this TreeCell.

Returns:

the current disclosure node set in this TreeCell

disclosureNodeProperty

public final <any> 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.

See Also:

getDisclosureNode(), setDisclosureNode(Node)

setTreeView

private void setTreeView(TreeView<T> value)

getTreeView

public final TreeView<T> getTreeView()

Returns the TreeView associated with this TreeCell.

Returns:

the TreeView associated with this TreeCell

treeViewProperty

public final <any> treeViewProperty()

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

See Also:

getTreeView()

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 Cell<T>

commitEdit

public void commitEdit(T newValue)

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

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>

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.

indexChanged

void indexChanged(int oldIndex,
                  int newIndex)

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

Overrides:

indexChanged in class IndexedCell<T>

updateItem

private void updateItem(int oldIndex)

updateSelection

private void updateSelection()

updateFocus

private void updateFocus()

updateEditing

private void updateEditing()

updateTreeView

public final void updateTreeView(TreeView<T> tree)

Updates the TreeView associated with this TreeCell.

Parameters:

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

updateTreeItem

public final void updateTreeItem(TreeItem<T> treeItem)

Updates the TreeItem associated with this TreeCell.

Parameters:

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

queryAccessibleAttribute

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

Overrides:

queryAccessibleAttribute in class Control

executeAccessibleAction

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

Overrides:

executeAccessibleAction in class Control