Class TreeCell<T>

Type Parameters:
T - The type of the value contained within the TreeItem property.
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
Direct Known Subclasses:
CheckBoxTreeCell, ChoiceBoxTreeCell, ComboBoxTreeCell, TextFieldTreeCell

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:
  • Property Details

  • Constructor Details

    • TreeCell

      public TreeCell()
      Creates a default TreeCell instance.
  • Method Details

    • 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 ReadOnlyObjectProperty<TreeItem<T>> treeItemProperty()
      Each TreeCell represents at most a single TreeItem, which is represented by this property.
      See Also:
    • 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 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.
      See Also:
    • getTreeView

      public final TreeView<T> getTreeView()
      Returns the TreeView associated with this TreeCell.
      Returns:
      the TreeView associated with this TreeCell
    • treeViewProperty

      public final ReadOnlyObjectProperty<TreeView<T>> treeViewProperty()
      A TreeCell is explicitly linked to a single TreeView instance, which is represented by this property.
      See Also:
    • 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.