Module javafx.controls
Package javafx.scene.control

Class TreeCell<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.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:
TreeView, TreeItem

  • 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.
      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 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:
      getDisclosureNode(), setDisclosureNode(Node)

    • 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:
      getTreeView()

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

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

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