Class TreeTableView<S>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.TreeTableView<S>
Type Parameters:
S - The type of the TreeItem instances used in this TreeTableView.
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
@DefaultProperty("root") public class TreeTableView<S> extends Control
The TreeTableView control is designed to visualize an unlimited number of rows of data, broken out into columns. The TreeTableView control is conceptually very similar to the TreeView and TableView controls, and as you read on you'll come to see the APIs are largely the same. However, to give a high-level overview, you'll note that the TreeTableView uses the same TreeItem API as TreeView, and that you therefore are required to simply set the root node in the TreeTableView. Similarly, the TreeTableView control makes use of the same TableColumn-based approach that the TableView control uses, except instead of using the TableView-specific TableColumn class, you should instead use the TreeTableView-specific TreeTableColumn class instead. For an example on how to create a TreeTableView instance, refer to the 'Creating a TreeTableView' control section below.

As with the TableView control, the TreeTableView control has a number of features, including:

Creating a TreeTableView

Creating a TreeTableView is a multi-step process, and also depends on the underlying data model needing to be represented. For this example we'll use the TreeTableView to visualise a file system, and will therefore make use of an imaginary (and vastly simplified) File class as defined below: 

 public class File {
     private StringProperty name;
     public void setName(String value) { nameProperty().set(value); }
     public String getName() { return nameProperty().get(); }
     public StringProperty nameProperty() {
         if (name == null) name = new SimpleStringProperty(this, "name");
         return name;
     }

     private LongProperty lastModified;
     public void setLastModified(long value) { lastModifiedProperty().set(value); }
     public long getLastModified() { return lastModifiedProperty().get(); }
     public LongProperty lastModifiedProperty() {
         if (lastModified == null) lastModified = new SimpleLongProperty(this, "lastModified");
         return lastModified;
     }

     public File(String name, long size) {
         setName(name);
         setSize(size);
     }
 }

The data we will use for this example is a single root with 3 files: 

 File rootFile = new File("Images", 900);
 List<File> files = List.of(
     new File("Cat.png", 300),
     new File("Dog.png", 500),
     new File("Bird.png", 100));

Firstly, we need to create a data model. As mentioned, for this example, we'll be representing a file system using File instances. To do this, we need to define the root node of the tree table and its hierarchy: 

 TreeItem<File> root = new TreeItem<>(rootFile);
 files.forEach(file -> root.getChildren().add(new TreeItem<>(file)));

Then we create a TreeTableView instance: 

 TreeTableView<File> treeTable = new TreeTableView<>(root);

With the root set as such, the TreeTableView will automatically update whenever the children of the root change.

At this point we have a TreeTableView hooked up to observe the root TreeItem instance. The missing ingredient now is the means of splitting out the data contained within the model and representing it in one or more TreeTableColumn instances. To create a two-column TreeTableView to show the file name and size properties, we write: 

 TreeTableColumn<File, String> fileNameCol = new TreeTableColumn<>("Filename");
 TreeTableColumn<File, Long> sizeCol = new TreeTableColumn<>("Size");

 treeTable.getColumns().setAll(fileNameCol, sizeCol);

With the code shown above we have nearly fully defined the minimum properties required to create a TreeTableView instance. The only thing missing is the cell value factories for the two columns - it is these that are responsible for determining the value of a cell in a given row. Commonly these can be specified using the TreeItemPropertyValueFactory class, but failing that you can also create an anonymous inner class and do whatever is necessary. For example, using TreeItemPropertyValueFactory you would do the following: 

 fileNameCol.setCellValueFactory(new TreeItemPropertyValueFactory(rootFile.nameProperty().getName()));
 sizeCol.setCellValueFactory(new TreeItemPropertyValueFactory(rootFile.sizeProperty().getName()));
Image of the TreeTableView control

Running this code will result in a TreeTableView as shown above with two columns for name and size. Any other properties the File class might have will not be shown, as no TreeTableColumns are defined for them.

TreeTableView support for classes that don't contain properties

The code shown above is the shortest possible code for creating a TreeTableView when the domain objects are designed with JavaFX properties in mind (additionally, TreeItemPropertyValueFactory supports normal JavaBean properties too, although there is a caveat to this, so refer to the class documentation for more information). When this is not the case, it is necessary to provide a custom cell value factory. More information about cell value factories can be found in the TreeTableColumn API documentation, but briefly, here is how a TreeTableColumns could be specified: 

 firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
     public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
         // p.getValue() returns the TreeItem<Person> instance for a particular TreeTableView row,
         // p.getValue().getValue() returns the Person instance inside the TreeItem<Person>
         return p.getValue().getValue().firstNameProperty();
     }
 });

 // or with a lambda expression:
 firstNameCol.setCellValueFactory(p -> p.getValue().getValue().firstNameProperty());

TreeTableView Selection / Focus APIs

To track selection and focus, it is necessary to become familiar with the SelectionModel and FocusModel classes. A TreeTableView has at most one instance of each of these classes, available from selectionModel and focusModel properties, respectively. Whilst it is possible to use this API to set a new selection model, in most circumstances this is not necessary - the default selection and focus models should work in most circumstances.

The default SelectionModel used when instantiating a TreeTableView is an implementation of the MultipleSelectionModel abstract class. However, as noted in the API documentation for the selectionMode property, the default value is SelectionMode.SINGLE. To enable multiple selection in a default TreeTableView instance, it is therefore necessary to do the following: 

 treeTableView.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);

Customizing TreeTableView Visuals

The visuals of the TreeTableView can be entirely customized by replacing the default row factory. A row factory is used to generate TreeTableRow instances, which are used to represent an entire row in the TreeTableView.

In many cases, this is not what is desired however, as it is more commonly the case that cells be customized on a per-column basis, not a per-row basis. It is therefore important to note that a TreeTableRow is not a TreeTableCell. A TreeTableRow is simply a container for zero or more TreeTableCell, and in most circumstances it is more likely that you'll want to create custom TreeTableCells, rather than TreeTableRows. The primary use case for creating custom TreeTableRow instances would most probably be to introduce some form of column spanning support.

You can create custom TreeTableCell instances per column by assigning the appropriate function to the TreeTableColumns cell factory property.

See the Cell class documentation for a more complete description of how to write custom Cells.

Warning: Nodes should not be inserted directly into the TreeTableView cells

TreeTableView allows for it's cells to contain elements of any type, including Node instances. Putting nodes into the TreeTableView cells is strongly discouraged, as it can lead to unexpected results.

Important points to note:

  • Avoid inserting Node instances directly into the TreeTableView cells or its data model.
  • The recommended approach is to put the relevant information into the items list, and provide a custom cell factory to create the nodes for a given cell and update them on demand using the data stored in the item for that cell.
  • Avoid creating new Nodes in the updateItem method of a custom cell factory.

The following minimal example shows how to create a custom cell factory for TreeTableView containing Nodes: 

 
  class ColorModel {
    private SimpleObjectProperty<Color> color;
    private StringProperty name;

    public ColorModel (String name, Color col) {
      this.color = new SimpleObjectProperty<Color>(col);
      this.name = new SimpleStringProperty(name);
    }

    public Color getColor() { return color.getValue(); }
    public void setColor(Color c) { color.setValue(c); }
    public SimpleObjectProperty<Color> colorProperty() { return color; }

    public String getName() { return name.getValue(); }
    public void setName(String s) { name.setValue(s); }
    public StringProperty nameProperty() { return name; }
  }

  ColorModel rootModel = new ColorModel("Color", Color.WHITE);
  TreeItem<ColorModel> treeRoot = new TreeItem<ColorModel>(rootModel);
  treeRoot.setExpanded(true);
  treeRoot.getChildren().addAll(
      new TreeItem<ColorModel>(new ColorModel("Red", Color.RED)),
      new TreeItem<ColorModel>(new ColorModel("Green", Color.GREEN)),
      new TreeItem<ColorModel>(new ColorModel("Blue", Color.BLUE)));

  TreeTableView<ColorModel> treeTable = new TreeTableView<ColorModel>(treeRoot);

  TreeTableColumn<ColorModel, String> nameCol = new TreeTableColumn<>("Color Name");
  TreeTableColumn<ColorModel, Color> colorCol = new TreeTableColumn<>("Color");

  treeTable.getColumns().setAll(nameCol, colorCol);

  colorCol.setCellValueFactory(p -> p.getValue().getValue().colorProperty());
  nameCol.setCellValueFactory(p -> p.getValue().getValue().nameProperty());

  colorCol.setCellFactory(p -> {
      return new TreeTableCell<ColorModel, Color> () {
          private final Rectangle rectangle;
          {
              setContentDisplay(ContentDisplay.GRAPHIC_ONLY);
              rectangle = new Rectangle(10, 10);
          }

          @Override
          protected void updateItem(Color item, boolean empty) {
              super.updateItem(item, empty);

              if (item == null || empty) {
                  setGraphic(null);
              } else {
                  rectangle.setFill(item);
                  setGraphic(rectangle);
              }
          }
      };
  });

This example has an anonymous custom TreeTableCell class in the custom cell factory. Note that the Rectangle (Node) object needs to be created in the instance initialization block or the constructor of the custom TreeTableCell class and updated/used in its updateItem method.

Editing

This control supports inline editing of values, and this section attempts to give an overview of the available APIs and how you should use them.

Firstly, cell editing most commonly requires a different user interface than when a cell is not being edited. This is the responsibility of the Cell implementation being used. For TreeTableView, it is highly recommended that editing be per-TreeTableColumn, rather than per row, as more often than not you want users to edit each column value differently, and this approach allows for editors specific to each column. It is your choice whether the cell is permanently in an editing state (e.g. this is common for CheckBox cells), or to switch to a different UI when editing begins (e.g. when a double-click is received on a cell).

To know when editing has been requested on a cell, simply override the Cell.startEdit() method, and update the cell text and graphic properties as appropriate (e.g. set the text to null and set the graphic to be a TextField). Additionally, you should also override Cell.cancelEdit() to reset the UI back to its original visual state when the editing concludes. In both cases it is important that you also ensure that you call the super method to have the cell perform all duties it must do to enter or exit its editing mode.

Once your cell is in an editing state, the next thing you are most probably interested in is how to commit or cancel the editing that is taking place. This is your responsibility as the cell factory provider. Your cell implementation will know when the editing is over, based on the user input (e.g. when the user presses the Enter or ESC keys on their keyboard). When this happens, it is your responsibility to call Cell.commitEdit(Object) or Cell.cancelEdit(), as appropriate.

When you call Cell.commitEdit(Object) an event is fired to the TreeTableView, which you can observe by adding an EventHandler via TreeTableColumn.setOnEditCommit(javafx.event.EventHandler). Similarly, you can also observe edit events for edit start and edit cancel.

By default the TreeTableColumn edit commit handler is non-null, with a default handler that attempts to overwrite the property value for the item in the currently-being-edited row. It is able to do this as the Cell.commitEdit(Object) method is passed in the new value, and this is passed along to the edit commit handler via the CellEditEvent that is fired. It is simply a matter of calling TreeTableColumn.CellEditEvent.getNewValue() to retrieve this value.

It is very important to note that if you call TreeTableColumn.setOnEditCommit(javafx.event.EventHandler) with your own EventHandler, then you will be removing the default handler. Unless you then handle the writeback to the property (or the relevant data source), nothing will happen. You can work around this by using the EventTarget.addEventHandler(javafx.event.EventType, javafx.event.EventHandler) method to add a TreeTableColumn.EDIT_COMMIT_EVENT EventType with your desired EventHandler as the second argument. Using this method, you will not replace the default implementation, but you will be notified when an edit commit has occurred.

Hopefully this summary answers some of the commonly asked questions. Fortunately, JavaFX ships with a number of pre-built cell factories that handle all the editing requirements on your behalf. You can find these pre-built cell factories in the javafx.scene.control.cell package.

Since:
JavaFX 8.0
See Also:

  • Property Details

  • Field Details

    • UNCONSTRAINED_RESIZE_POLICY

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> UNCONSTRAINED_RESIZE_POLICY

      Very simple resize policy that just resizes the specified column by the provided delta and shifts all other columns (to the right of the given column) further to the right (when the delta is positive) or to the left (when the delta is negative).

      It also handles the case where we have nested columns by sharing the new space, or subtracting the removed space, evenly between all immediate children columns. Of course, the immediate children may themselves be nested, and they would then use this policy on their children.

    • CONSTRAINED_RESIZE_POLICY_ALL_COLUMNS

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY_ALL_COLUMNS
      A resize policy that adjusts other columns in order to fit the tree table width. During UI adjustment, proportionately resizes all columns to preserve the total width.

      When column constraints make it impossible to fit all the columns into the allowed area, the columns are either clipped, or an empty space appears. This policy disables the horizontal scroll bar.

      Since:
      20

    • CONSTRAINED_RESIZE_POLICY_LAST_COLUMN

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY_LAST_COLUMN
      A resize policy that adjusts the last column in order to fit the tree table width. During UI adjustment, resizes the last column only to preserve the total width.

      When column constraints make it impossible to fit all the columns into the allowed area, the columns are either clipped, or an empty space appears. This policy disables the horizontal scroll bar.

      Since:
      20

    • CONSTRAINED_RESIZE_POLICY_NEXT_COLUMN

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY_NEXT_COLUMN
      A resize policy that adjusts the next column in order to fit the tree table width. During UI adjustment, resizes the next column the opposite way.

      When column constraints make it impossible to fit all the columns into the allowed area, the columns are either clipped, or an empty space appears. This policy disables the horizontal scroll bar.

      Since:
      20

    • CONSTRAINED_RESIZE_POLICY_SUBSEQUENT_COLUMNS

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY_SUBSEQUENT_COLUMNS
      A resize policy that adjusts subsequent columns in order to fit the tree table width. During UI adjustment, proportionally resizes subsequent columns to preserve the total width.

      When column constraints make it impossible to fit all the columns into the allowed area, the columns are either clipped, or an empty space appears. This policy disables the horizontal scroll bar.

      Since:
      20

    • CONSTRAINED_RESIZE_POLICY_FLEX_NEXT_COLUMN

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY_FLEX_NEXT_COLUMN
      A resize policy that adjusts columns, starting with the next one, in order to fit the tree table width. During UI adjustment, resizes the next column to preserve the total width. When the next column cannot be further resized due to a constraint, the following column gets resized, and so on.

      When column constraints make it impossible to fit all the columns into the allowed area, the columns are either clipped, or an empty space appears. This policy disables the horizontal scroll bar.

      Since:
      20

    • CONSTRAINED_RESIZE_POLICY_FLEX_LAST_COLUMN

      public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY_FLEX_LAST_COLUMN
      A resize policy that adjusts columns, starting with the last one, in order to fit the table width. During UI adjustment, resizes the last column to preserve the total width. When the last column cannot be further resized due to a constraint, the column preceding the last one gets resized, and so on.

      When column constraints make it impossible to fit all the columns into the allowed area, the columns are either clipped, or an empty space appears. This policy disables the horizontal scroll bar.

      Since:
      20

    • CONSTRAINED_RESIZE_POLICY

      @Deprecated(since="20") public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY
      Deprecated.
      Use CONSTRAINED_RESIZE_POLICY_FLEX_LAST_COLUMN instead.

      Simple policy that ensures the width of all visible leaf columns in this table sum up to equal the width of the table itself.

      When the user resizes a column width with this policy, the table automatically adjusts the width of the right hand side columns. When the user increases a column width, the table decreases the width of the rightmost column until it reaches its minimum width. Then it decreases the width of the second rightmost column until it reaches minimum width and so on. When all right hand side columns reach minimum size, the user cannot increase the size of resized column any more.

    • DEFAULT_SORT_POLICY

      public static final Callback<TreeTableView,Boolean> DEFAULT_SORT_POLICY
      The default sort policy that this TreeTableView will use if no other policy is specified. The sort policy is a simple Callback that accepts a TreeTableView as the sole argument and expects a Boolean response representing whether the sort succeeded or not. A Boolean response of true represents success, and a response of false (or null) will be considered to represent failure.

  • Constructor Details

    • TreeTableView

      public TreeTableView()
      Creates an empty TreeTableView.

      Refer to the TreeTableView class documentation for details on the default state of other properties.

    • TreeTableView

      public TreeTableView(TreeItem<S> root)
      Creates a TreeTableView with the provided root node.

      Refer to the TreeTableView class documentation for details on the default state of other properties.

      Parameters:
      root - The node to be the root in this TreeTableView.

  • Method Details

    • editAnyEvent

      public static <S> EventType<TreeTableView.EditEvent<S>> editAnyEvent()
      An EventType that indicates some edit event has occurred. It is the parent type of all other edit events: editStartEvent(), editCommitEvent() and editCancelEvent().
      Type Parameters:
      S - The type of the TreeItem instances used in this TreeTableView
      Returns:
      An EventType that indicates some edit event has occurred

    • editStartEvent

      public static <S> EventType<TreeTableView.EditEvent<S>> editStartEvent()
      An EventType used to indicate that an edit event has started within the TreeTableView upon which the event was fired.
      Type Parameters:
      S - The type of the TreeItem instances used in this TreeTableView
      Returns:
      An EventType used to indicate that an edit event has started

    • editCancelEvent

      public static <S> EventType<TreeTableView.EditEvent<S>> editCancelEvent()
      An EventType used to indicate that an edit event has just been canceled within the TreeTableView upon which the event was fired.
      Type Parameters:
      S - The type of the TreeItem instances used in this TreeTableView
      Returns:
      An EventType used to indicate that an edit event has just been canceled

    • editCommitEvent

      public static <S> EventType<TreeTableView.EditEvent<S>> editCommitEvent()
      An EventType that is used to indicate that an edit in a TreeTableView has been committed. This means that user has made changes to the data of a TreeItem, and that the UI should be updated.
      Type Parameters:
      S - The type of the TreeItem instances used in this TreeTableView
      Returns:
      An EventType that is used to indicate that an edit in a TreeTableView has been committed

    • getNodeLevel

      @Deprecated(since="8u20") public static int getNodeLevel(TreeItem<?> node)
      Deprecated.
      This method does not correctly calculate the distance from the given TreeItem to the root of the TreeTableView. As of JavaFX 8.0_20, the proper way to do this is via getTreeItemLevel(TreeItem)
      Returns the number of levels of 'indentation' of the given TreeItem, based on how many times TreeItem.getParent() can be recursively called. If the TreeItem does not have any parent set, the returned value will be zero. For each time getParent() is recursively called, the returned value is incremented by one.

      Important note: This method is deprecated as it does not consider the root node. This means that this method will iterate past the root node of the TreeTableView control, if the root node has a parent. If this is important, call getTreeItemLevel(TreeItem) instead.

      Parameters:
      node - The TreeItem for which the level is needed.
      Returns:
      An integer representing the number of parents above the given node, or -1 if the given TreeItem is null.

    • setRoot

      public final void setRoot(TreeItem<S> value)
      Sets the root node in this TreeTableView. See the TreeItem class level documentation for more details.
      Parameters:
      value - The TreeItem that will be placed at the root of the TreeTableView.

    • getRoot

      public final TreeItem<S> getRoot()
      Returns the current root node of this TreeTableView, or null if no root node is specified.
      Returns:
      The current root node, or null if no root node exists.

    • rootProperty

      public final ObjectProperty<TreeItem<S>> rootProperty()
      Property representing the root node of the TreeTableView.
      Returns:
      the root property
      See Also:

    • setShowRoot

      public final void setShowRoot(boolean value)
      Specifies whether the root TreeItem should be shown within this TreeTableView.
      Parameters:
      value - If true, the root TreeItem will be shown, and if false it will be hidden.

    • isShowRoot

      public final boolean isShowRoot()
      Returns true if the root of the TreeTableView should be shown, and false if it should not. By default, the root TreeItem is visible in the TreeTableView.
      Returns:
      true if the root of the TreeTableView should be shown

    • showRootProperty

      public final BooleanProperty showRootProperty()
      Property that represents whether or not the TreeTableView root node is visible.
      Returns:
      the show root property
      See Also:

    • treeColumnProperty

      public final ObjectProperty<TreeTableColumn<S,?>> treeColumnProperty()
      Property that represents which column should have the disclosure node shown in it (that is, the column with the arrow). By default this will be the left-most column if this property is null, otherwise it will be the specified column assuming it is non-null and contained within the visible leaf columns list.
      Returns:
      the tree column property
      See Also:

    • setTreeColumn

      public final void setTreeColumn(TreeTableColumn<S,?> value)
      Sets the value of the treeColumn property.
      Property description:
      Property that represents which column should have the disclosure node shown in it (that is, the column with the arrow). By default this will be the left-most column if this property is null, otherwise it will be the specified column assuming it is non-null and contained within the visible leaf columns list.
      Parameters:
      value - the value for the treeColumn property
      See Also:

    • getTreeColumn

      public final TreeTableColumn<S,?> getTreeColumn()
      Gets the value of the treeColumn property.
      Property description:
      Property that represents which column should have the disclosure node shown in it (that is, the column with the arrow). By default this will be the left-most column if this property is null, otherwise it will be the specified column assuming it is non-null and contained within the visible leaf columns list.
      Returns:
      the value of the treeColumn property
      See Also:

    • setSelectionModel

      public final void setSelectionModel(TreeTableView.TreeTableViewSelectionModel<S> value)
      Sets the MultipleSelectionModel to be used in the TreeTableView. Despite a TreeTableView requiring a MultipleSelectionModel, it is possible to configure it to only allow single selection (see MultipleSelectionModel.setSelectionMode(javafx.scene.control.SelectionMode) for more information).
      Parameters:
      value - the MultipleSelectionModel to be used

    • getSelectionModel

      public final TreeTableView.TreeTableViewSelectionModel<S> getSelectionModel()
      Returns the currently installed selection model.
      Returns:
      the currently installed selection model

    • selectionModelProperty

      public final ObjectProperty<TreeTableView.TreeTableViewSelectionModel<S>> selectionModelProperty()
      The SelectionModel provides the API through which it is possible to select single or multiple items within a TreeTableView, as well as inspect which rows have been selected by the user. Note that it has a generic type that must match the type of the TreeTableView itself.
      Returns:
      the selection model property
      See Also:

    • setFocusModel

      public final void setFocusModel(TreeTableView.TreeTableViewFocusModel<S> value)
      Sets the FocusModel to be used in the TreeTableView.
      Parameters:
      value - the FocusModel to be used

    • getFocusModel

      public final TreeTableView.TreeTableViewFocusModel<S> getFocusModel()
      Returns the currently installed FocusModel.
      Returns:
      the currently installed FocusModel

    • focusModelProperty

      public final ObjectProperty<TreeTableView.TreeTableViewFocusModel<S>> focusModelProperty()
      The FocusModel provides the API through which it is possible to control focus on zero or one rows of the TreeTableView. Generally the default implementation should be more than sufficient.
      Returns:
      the focus model property
      See Also:

    • expandedItemCountProperty

      public final ReadOnlyIntegerProperty expandedItemCountProperty()

      Represents the number of tree nodes presently able to be visible in the TreeTableView. This is essentially the count of all expanded tree items, and their children.

      For example, if just the root node is visible, the expandedItemCount will be one. If the root had three children and the root was expanded, the value will be four.

      Returns:
      the expandedItemCount property
      See Also:

    • getExpandedItemCount

      public final int getExpandedItemCount()
      Gets the value of the expandedItemCount property.
      Property description:

      Represents the number of tree nodes presently able to be visible in the TreeTableView. This is essentially the count of all expanded tree items, and their children.

      For example, if just the root node is visible, the expandedItemCount will be one. If the root had three children and the root was expanded, the value will be four.

      Returns:
      the value of the expandedItemCount property
      See Also:

    • setEditable

      public final void setEditable(boolean value)
      Sets the value of the editable property.
      Property description:
      Specifies whether this TreeTableView is editable - only if the TreeTableView and the TreeCells within it are both editable will a TreeCell be able to go into their editing state.
      Parameters:
      value - the value for the editable property
      See Also:

    • isEditable

      public final boolean isEditable()
      Gets the value of the editable property.
      Property description:
      Specifies whether this TreeTableView is editable - only if the TreeTableView and the TreeCells within it are both editable will a TreeCell be able to go into their editing state.
      Returns:
      the value of the editable property
      See Also:

    • editableProperty

      public final BooleanProperty editableProperty()
      Specifies whether this TreeTableView is editable - only if the TreeTableView and the TreeCells within it are both editable will a TreeCell be able to go into their editing state.
      Returns:
      the editable property
      See Also:

    • getEditingCell

      public final TreeTablePosition<S,?> getEditingCell()
      Gets the value of the editingCell property.
      Property description:
      Represents the current cell being edited, or null if there is no cell being edited.
      Returns:
      the value of the editingCell property
      See Also:

    • editingCellProperty

      public final ReadOnlyObjectProperty<TreeTablePosition<S,?>> editingCellProperty()
      Represents the current cell being edited, or null if there is no cell being edited.
      Returns:
      the editing cell property
      See Also:

    • tableMenuButtonVisibleProperty

      public final BooleanProperty tableMenuButtonVisibleProperty()
      This controls whether a menu button is available when the user clicks in a designated space within the TableView, within which is a radio menu item for each TreeTableColumn in this table. This menu allows for the user to show and hide all TreeTableColumns easily.
      Returns:
      the table menu button visible property
      See Also:

    • setTableMenuButtonVisible

      public final void setTableMenuButtonVisible(boolean value)
      Sets the value of the tableMenuButtonVisible property.
      Property description:
      This controls whether a menu button is available when the user clicks in a designated space within the TableView, within which is a radio menu item for each TreeTableColumn in this table. This menu allows for the user to show and hide all TreeTableColumns easily.
      Parameters:
      value - the value for the tableMenuButtonVisible property
      See Also:

    • isTableMenuButtonVisible

      public final boolean isTableMenuButtonVisible()
      Gets the value of the tableMenuButtonVisible property.
      Property description:
      This controls whether a menu button is available when the user clicks in a designated space within the TableView, within which is a radio menu item for each TreeTableColumn in this table. This menu allows for the user to show and hide all TreeTableColumns easily.
      Returns:
      the value of the tableMenuButtonVisible property
      See Also:

    • setColumnResizePolicy

      public final void setColumnResizePolicy(Callback<TreeTableView.ResizeFeatures,Boolean> callback)
      Sets the value of the columnResizePolicy property.
      Property description:
      This is the function called when the user completes a column-resize operation. The two most common policies are available as static functions in the TableView class: UNCONSTRAINED_RESIZE_POLICY and CONSTRAINED_RESIZE_POLICY.
      Parameters:
      callback - the value for the columnResizePolicy property
      See Also:

    • getColumnResizePolicy

      public final Callback<TreeTableView.ResizeFeatures,Boolean> getColumnResizePolicy()
      Gets the value of the columnResizePolicy property.
      Property description:
      This is the function called when the user completes a column-resize operation. The two most common policies are available as static functions in the TableView class: UNCONSTRAINED_RESIZE_POLICY and CONSTRAINED_RESIZE_POLICY.
      Returns:
      the value of the columnResizePolicy property
      See Also:

    • columnResizePolicyProperty

      public final ObjectProperty<Callback<TreeTableView.ResizeFeatures,Boolean>> columnResizePolicyProperty()
      This is the function called when the user completes a column-resize operation. The two most common policies are available as static functions in the TableView class: UNCONSTRAINED_RESIZE_POLICY and CONSTRAINED_RESIZE_POLICY.
      Returns:
      the column resize policy property
      See Also:

    • rowFactoryProperty

      public final ObjectProperty<Callback<TreeTableView<S>,TreeTableRow<S>>> rowFactoryProperty()
      A function which produces a TreeTableRow. The system is responsible for reusing TreeTableRows. Return from this function a TreeTableRow which might be usable for representing a single row in a TableView.

      Note that a TreeTableRow is not a TableCell. A TreeTableRow is simply a container for a TableCell, and in most circumstances it is more likely that you'll want to create custom TableCells, rather than TreeTableRows. The primary use case for creating custom TreeTableRow instances would most probably be to introduce some form of column spanning support.

      You can create custom TableCell instances per column by assigning the appropriate function to the cellFactory property in the TreeTableColumn class.

      Returns:
      the row factory property
      See Also:

    • setRowFactory

      public final void setRowFactory(Callback<TreeTableView<S>,TreeTableRow<S>> value)
      Sets the value of the rowFactory property.
      Property description:
      A function which produces a TreeTableRow. The system is responsible for reusing TreeTableRows. Return from this function a TreeTableRow which might be usable for representing a single row in a TableView.

      Note that a TreeTableRow is not a TableCell. A TreeTableRow is simply a container for a TableCell, and in most circumstances it is more likely that you'll want to create custom TableCells, rather than TreeTableRows. The primary use case for creating custom TreeTableRow instances would most probably be to introduce some form of column spanning support.

      You can create custom TableCell instances per column by assigning the appropriate function to the cellFactory property in the TreeTableColumn class.

      Parameters:
      value - the value for the rowFactory property
      See Also:

    • getRowFactory

      public final Callback<TreeTableView<S>,TreeTableRow<S>> getRowFactory()
      Gets the value of the rowFactory property.
      Property description:
      A function which produces a TreeTableRow. The system is responsible for reusing TreeTableRows. Return from this function a TreeTableRow which might be usable for representing a single row in a TableView.

      Note that a TreeTableRow is not a TableCell. A TreeTableRow is simply a container for a TableCell, and in most circumstances it is more likely that you'll want to create custom TableCells, rather than TreeTableRows. The primary use case for creating custom TreeTableRow instances would most probably be to introduce some form of column spanning support.

      You can create custom TableCell instances per column by assigning the appropriate function to the cellFactory property in the TreeTableColumn class.

      Returns:
      the value of the rowFactory property
      See Also:

    • placeholderProperty

      public final ObjectProperty<Node> placeholderProperty()
      This Node is shown to the user when the table has no content to show. This may be the case because the table model has no data in the first place, that a filter has been applied to the table model, resulting in there being nothing to show the user, or that there are no currently visible columns.
      Returns:
      the placeholder property
      See Also:

    • setPlaceholder

      public final void setPlaceholder(Node value)
      Sets the value of the placeholder property.
      Property description:
      This Node is shown to the user when the table has no content to show. This may be the case because the table model has no data in the first place, that a filter has been applied to the table model, resulting in there being nothing to show the user, or that there are no currently visible columns.
      Parameters:
      value - the value for the placeholder property
      See Also:

    • getPlaceholder

      public final Node getPlaceholder()
      Gets the value of the placeholder property.
      Property description:
      This Node is shown to the user when the table has no content to show. This may be the case because the table model has no data in the first place, that a filter has been applied to the table model, resulting in there being nothing to show the user, or that there are no currently visible columns.
      Returns:
      the value of the placeholder property
      See Also:

    • setFixedCellSize

      public final void setFixedCellSize(double value)
      Sets the new fixed cell size for this control. Any value greater than zero will enable fixed cell size mode, whereas a zero or negative value (or Region.USE_COMPUTED_SIZE) will be used to disabled fixed cell size mode.
      Parameters:
      value - The new fixed cell size value, or a value less than or equal to zero (or Region.USE_COMPUTED_SIZE) to disable.
      Since:
      JavaFX 8.0

    • getFixedCellSize

      public final double getFixedCellSize()
      Returns the fixed cell size value. A value less than or equal to zero is used to represent that fixed cell size mode is disabled, and a value greater than zero represents the size of all cells in this control.
      Returns:
      A double representing the fixed cell size of this control, or a value less than or equal to zero if fixed cell size mode is disabled.
      Since:
      JavaFX 8.0

    • fixedCellSizeProperty

      public final DoubleProperty fixedCellSizeProperty()
      Specifies whether this control has cells that are a fixed height (of the specified value). If this value is less than or equal to zero, then all cells are individually sized and positioned. This is a slow operation. Therefore, when performance matters and developers are not dependent on variable cell sizes it is a good idea to set the fixed cell size value. Generally cells are around 24px, so setting a fixed cell size of 24 is likely to result in very little difference in visuals, but a improvement to performance.

      To set this property via CSS, use the -fx-fixed-cell-size property. This should not be confused with the -fx-cell-size property. The difference between these two CSS properties is that -fx-cell-size will size all cells to the specified size, but it will not enforce that this is the only size (thus allowing for variable cell sizes, and preventing the performance gains from being possible). Therefore, when performance matters use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are specified in CSS, -fx-fixed-cell-size takes precedence.

      Returns:
      the fixed cell size property
      Since:
      JavaFX 8.0
      See Also:

    • sortModeProperty

      public final ObjectProperty<TreeSortMode> sortModeProperty()
      Specifies the sort mode to use when sorting the contents of this TreeTableView, should any columns be specified in the sort order list.
      Returns:
      the sortMode property
      See Also:

    • setSortMode

      public final void setSortMode(TreeSortMode value)
      Sets the value of the sortMode property.
      Property description:
      Specifies the sort mode to use when sorting the contents of this TreeTableView, should any columns be specified in the sort order list.
      Parameters:
      value - the value for the sortMode property
      See Also:

    • getSortMode

      public final TreeSortMode getSortMode()
      Gets the value of the sortMode property.
      Property description:
      Specifies the sort mode to use when sorting the contents of this TreeTableView, should any columns be specified in the sort order list.
      Returns:
      the value of the sortMode property
      See Also:

    • getComparator

      public final Comparator<TreeItem<S>> getComparator()
      Gets the value of the comparator property.
      Property description:
      The comparator property is a read-only property that is representative of the current state of the sort order list. The sort order list contains the columns that have been added to it either programmatically or via a user clicking on the headers themselves.
      Returns:
      the value of the comparator property
      See Also:

    • comparatorProperty

      public final ReadOnlyObjectProperty<Comparator<TreeItem<S>>> comparatorProperty()
      The comparator property is a read-only property that is representative of the current state of the sort order list. The sort order list contains the columns that have been added to it either programmatically or via a user clicking on the headers themselves.
      Returns:
      the comparator property
      See Also:

    • setSortPolicy

      public final void setSortPolicy(Callback<TreeTableView<S>,Boolean> callback)
      Sets the value of the sortPolicy property.
      Property description:
      The sort policy specifies how sorting in this TreeTableView should be performed. For example, a basic sort policy may just recursively sort the children of the root tree item, whereas a more advanced sort policy may call to a database to perform the necessary sorting on the server-side.

      TreeTableView ships with a default sort policy that does precisely as mentioned above: it simply attempts to sort the tree hierarchy in-place.

      It is recommended that rather than override the sort method that a different sort policy be provided instead.

      Parameters:
      callback - the value for the sortPolicy property
      See Also:

    • getSortPolicy

      public final Callback<TreeTableView<S>,Boolean> getSortPolicy()
      Gets the value of the sortPolicy property.
      Property description:
      The sort policy specifies how sorting in this TreeTableView should be performed. For example, a basic sort policy may just recursively sort the children of the root tree item, whereas a more advanced sort policy may call to a database to perform the necessary sorting on the server-side.

      TreeTableView ships with a default sort policy that does precisely as mentioned above: it simply attempts to sort the tree hierarchy in-place.

      It is recommended that rather than override the sort method that a different sort policy be provided instead.

      Returns:
      the value of the sortPolicy property
      See Also:

    • sortPolicyProperty

      public final ObjectProperty<Callback<TreeTableView<S>,Boolean>> sortPolicyProperty()
      The sort policy specifies how sorting in this TreeTableView should be performed. For example, a basic sort policy may just recursively sort the children of the root tree item, whereas a more advanced sort policy may call to a database to perform the necessary sorting on the server-side.

      TreeTableView ships with a default sort policy that does precisely as mentioned above: it simply attempts to sort the tree hierarchy in-place.

      It is recommended that rather than override the sort method that a different sort policy be provided instead.

      Returns:
      the sortPolicy property
      See Also:

    • setOnSort

      public final void setOnSort(EventHandler<SortEvent<TreeTableView<S>>> value)
      Sets the value of the onSort property.
      Property description:
      Called when there's a request to sort the control.
      Parameters:
      value - the value for the onSort property
      See Also:

    • getOnSort

      public final EventHandler<SortEvent<TreeTableView<S>>> getOnSort()
      Gets the value of the onSort property.
      Property description:
      Called when there's a request to sort the control.
      Returns:
      the value of the onSort property
      See Also:

    • onSortProperty

      public final ObjectProperty<EventHandler<SortEvent<TreeTableView<S>>>> onSortProperty()
      Called when there's a request to sort the control.
      Returns:
      the onSort property
      See Also:

    • scrollTo

      public void scrollTo(int index)
      Scrolls the TreeTableView such that the item in the given index is visible to the end user.
      Parameters:
      index - The index that should be made visible to the user, assuming of course that it is greater than, or equal to 0, and less than the number of the visible items in the TreeTableView.

    • setOnScrollTo

      public final void setOnScrollTo(EventHandler<ScrollToEvent<Integer>> value)
      Sets the value of the onScrollTo property.
      Property description:
      Called when there's a request to scroll an index into view using scrollTo(int)
      Parameters:
      value - the value for the onScrollTo property
      See Also:

    • getOnScrollTo

      public final EventHandler<ScrollToEvent<Integer>> getOnScrollTo()
      Gets the value of the onScrollTo property.
      Property description:
      Called when there's a request to scroll an index into view using scrollTo(int)
      Returns:
      the value of the onScrollTo property
      See Also:

    • onScrollToProperty

      public final ObjectProperty<EventHandler<ScrollToEvent<Integer>>> onScrollToProperty()
      Called when there's a request to scroll an index into view using scrollTo(int)
      Returns:
      the onScrollTo property
      See Also:

    • scrollToColumn

      public void scrollToColumn(TreeTableColumn<S,?> column)
      Scrolls the TreeTableView so that the given column is visible within the viewport.
      Parameters:
      column - The column that should be visible to the user.

    • scrollToColumnIndex

      public void scrollToColumnIndex(int columnIndex)
      Scrolls the TreeTableView so that the given index is visible within the viewport.
      Parameters:
      columnIndex - The index of a column that should be visible to the user.

    • setOnScrollToColumn

      public final void setOnScrollToColumn(EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> value)
      Sets the value of the onScrollToColumn property.
      Property description:
      Called when there's a request to scroll a column into view using scrollToColumn(TreeTableColumn) or scrollToColumnIndex(int)
      Parameters:
      value - the value for the onScrollToColumn property
      See Also:

    • getOnScrollToColumn

      public final EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> getOnScrollToColumn()
      Gets the value of the onScrollToColumn property.
      Property description:
      Called when there's a request to scroll a column into view using scrollToColumn(TreeTableColumn) or scrollToColumnIndex(int)
      Returns:
      the value of the onScrollToColumn property
      See Also:

    • onScrollToColumnProperty

      public final ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> onScrollToColumnProperty()
      Called when there's a request to scroll a column into view using scrollToColumn(TreeTableColumn) or scrollToColumnIndex(int)
      Returns:
      the onScrollToColumn property
      See Also:

    • getRow

      public int getRow(TreeItem<S> item)
      Returns the index position of the given TreeItem, assuming that it is currently accessible through the tree hierarchy (most notably, that all parent tree items are expanded). If a parent tree item is collapsed, the result is that this method will return -1 to indicate that the given tree item is not accessible in the tree.
      Parameters:
      item - The TreeItem for which the index is sought.
      Returns:
      An integer representing the location in the current TreeTableView of the first instance of the given TreeItem, or -1 if it is null or can not be found (for example, if a parent (all the way up to the root) is collapsed).

    • getTreeItem

      public TreeItem<S> getTreeItem(int row)
      Returns the TreeItem in the given index, or null if it is out of bounds.
      Parameters:
      row - The index of the TreeItem being sought.
      Returns:
      The TreeItem in the given index, or null if it is out of bounds.

    • getTreeItemLevel

      public int getTreeItemLevel(TreeItem<?> node)
      Returns the number of levels of 'indentation' of the given TreeItem, based on how many times getParent() can be recursively called. If the given TreeItem is the root node of this TreeTableView, or if the TreeItem does not have any parent set, the returned value will be zero. For each time getParent() is recursively called, the returned value is incremented by one.
      Parameters:
      node - The TreeItem for which the level is needed.
      Returns:
      An integer representing the number of parents above the given node, or -1 if the given TreeItem is null.

    • getColumns

      public final ObservableList<TreeTableColumn<S,?>> getColumns()
      The TreeTableColumns that are part of this TableView. As the user reorders the TableView columns, this list will be updated to reflect the current visual ordering.

      Note: to display any data in a TableView, there must be at least one TreeTableColumn in this ObservableList.

      Returns:
      the table table column

    • getSortOrder

      public final ObservableList<TreeTableColumn<S,?>> getSortOrder()
      The sortOrder list defines the order in which TreeTableColumn instances are sorted. An empty sortOrder list means that no sorting is being applied on the TableView. If the sortOrder list has one TreeTableColumn within it, the TableView will be sorted using the sortType and comparator properties of this TreeTableColumn (assuming TreeTableColumn.sortable is true). If the sortOrder list contains multiple TreeTableColumn instances, then the TableView is firstly sorted based on the properties of the first TreeTableColumn. If two elements are considered equal, then the second TreeTableColumn in the list is used to determine ordering. This repeats until the results from all TreeTableColumn comparators are considered, if necessary.
      Returns:
      An ObservableList containing zero or more TreeTableColumn instances.

    • resizeColumn

      public boolean resizeColumn(TreeTableColumn<S,?> column, double delta)
      Applies the currently installed resize policy against the given column, resizing it based on the delta value provided.
      Parameters:
      column - the column
      delta - the delta
      Returns:
      true if column resizing is applied

    • edit

      public void edit(int row, TreeTableColumn<S,?> column)
      Causes the cell at the given row/column view indexes to switch into its editing state, if it is not already in it, and assuming that the TableView and column are also editable.
      Parameters:
      row - the row
      column - the column

    • getVisibleLeafColumns

      public ObservableList<TreeTableColumn<S,?>> getVisibleLeafColumns()
      Returns an unmodifiable list containing the currently visible leaf columns.
      Returns:
      an unmodifiable list containing the currently visible leaf columns

    • getVisibleLeafIndex

      public int getVisibleLeafIndex(TreeTableColumn<S,?> column)
      Returns the position of the given column, relative to all other visible leaf columns.
      Parameters:
      column - the column
      Returns:
      the position of the given column, relative to all other visible leaf columns

    • getVisibleLeafColumn

      public TreeTableColumn<S,?> getVisibleLeafColumn(int column)
      Returns the TreeTableColumn in the given column index, relative to all other visible leaf columns.
      Parameters:
      column - the column
      Returns:
      the TreeTableColumn in the given column index, relative to all other visible leaf columns

    • sort

      public void sort()
      The sort method forces the TreeTableView to re-run its sorting algorithm. More often than not it is not necessary to call this method directly, as it is automatically called when the sort order, sort policy, or the state of the TreeTableColumn sort type properties change. In other words, this method should only be called directly when something external changes and a sort is required.

    • refresh

      public void refresh()
      Calling refresh() forces the TreeTableView control to recreate and repopulate the cells necessary to populate the visual bounds of the control. In other words, this forces the TreeTableView to update what it is showing to the user. This is useful in cases where the underlying data source has changed in a way that is not observed by the TreeTableView itself.
      Since:
      JavaFX 8u60

    • getClassCssMetaData

      public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
      Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
      Returns:
      the CssMetaData

    • getControlCssMetaData

      public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()
      Gets the unmodifiable list of the control's CSS-styleable properties.
      Overrides:
      getControlCssMetaData in class Control
      Returns:
      the unmodifiable list of the control's CSS-styleable properties
      Since:
      JavaFX 8.0