TreeTableView is made up of a number of TreeTableColumn instances. Each
TreeTableColumn in a TreeTableView is responsible for displaying
(and editing) the contents of that column. As well as being responsible for
displaying and editing data for a single column, a TreeTableColumn also
contains the necessary properties to:
minWidth/
prefWidth/
maxWidth and width properties)
visibility toggled
header text
nested columns it may contain
context menu when the user
right-clicks the column header area
comparator, sortable and
sortType)
text (what to show in the column
header area), and the column cell value factory
(which is used to populate individual cells in the column). This can be
achieved using some variation on the following code:
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();
}
});
}
This approach assumes that the object returned from p.getValue().getValue()
has a JavaFX ObservableValue that can simply be returned. The benefit of this
is that the TableView will internally create bindings to ensure that,
should the returned ObservableValue change, the cell contents will be
automatically refreshed.
In situations where a TableColumn must interact with classes created before
JavaFX, or that generally do not wish to use JavaFX APIs for properties, it is
possible to wrap the returned value in a ReadOnlyObjectWrapper instance. For
example:
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 new ReadOnlyObjectWrapper(p.getValue().getValue().getFirstName());
}
});
}
It is hoped that over time there will be convenience cell value factories
developed and made available to developers. As of the JavaFX 2.0 release,
there is one such convenience class: javafx.scene.control.cell.TreeItemPropertyValueFactory .
This class removes the need to write the code above, instead relying on reflection to
look up a given property from a String. Refer to the
TreeItemPropertyValueFactory class documentation for more information
on how to use this with a TableColumn.
Finally, for more detail on how to use TableColumn, there is further documentation in
the TableView class documentation.
TableView, TableCell, TablePosition, javafx.scene.control.cell.TreeItemPropertyValueFactory
| Modifier and Type | Class and Description |
|---|---|
| public static class | TreeTableColumn.
The TableView type S, The TreeTableColumn type T>A support class used in TreeTableColumn as a wrapper class
to provide all necessary information for a particular |
| public static class | TreeTableColumn.
the type of the TreeItem instances contained within the TreeTableView S, the type of the items contained within the TreeTableColumn T>An event that is fired when a user performs an edit on a table cell. |
| public static enum | TreeTableColumn.
Enumeration that specifies the type of sorting being applied to a specific column. |
| Modifier and Type | Field and Description |
|---|---|
| private final ObjectProperty | cellFactory
The cell factory for all cells in this column. |
| private ObjectProperty | cellValueFactory
The cell value factory needs to be set to specify how to populate all cells within a single TreeTableColumn. |
| private final ObservableList | |
| private ListChangeListener | |
| public static final Callback | DEFAULT_CELL_FACTORY
If no cellFactory is specified on a TreeTableColumn instance, then this one will be used by default. |
| private EventHandler | |
| private static final String | |
| private static final EventType | |
| private static final EventType | |
| private static final EventType | |
| private static final EventType | |
| private ObjectProperty | onEditCancel
This event handler will be fired when the user cancels editing a cell. |
| private ObjectProperty | onEditCommit
This event handler will be fired when the user successfully commits their editing. |
| private ObjectProperty | onEditStart
This event handler will be fired when the user successfully initiates editing. |
| private ObjectProperty | sortType
Used to state whether this column, if it is part of a sort order (see
|
| private ReadOnlyObjectWrapper | treeTableView
The TreeTableView that this TreeTableColumn belongs to. |
| private WeakListChangeListener |
| Access | Constructor and Description |
|---|---|
| public | TreeTableColumn()
Creates a default TreeTableColumn with default cell factory, comparator, and onEditCommit implementation. |
| public | TreeTableColumn(String
The string to show when the TreeTableColumn is placed within
the TreeTableView. text)Creates a TreeTableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation. |
| Modifier and Type | Method and Description |
|---|---|
| public final ObjectProperty | |
| public final ObjectProperty | |
| public static < the type of the TreeTableView generic type S, the type of the content in all cells in this TreeTableColumn T> EventType | |
| public static < the type of the TreeTableView generic type S, the type of the content in all cells in this TreeTableColumn T> EventType | Returns: the edit cancel eventIndicates that the editing has been canceled, meaning that no change should be made to the backing data source. |
| public static < the type of the TreeTableView generic type S, the type of the content in all cells in this TreeTableColumn T> EventType | Returns: the edit commit eventIndicates that the editing has been committed by the user, meaning that a change should be made to the backing data source to reflect the new data. |
| public static < the type of the TreeTableView generic type S, the type of the content in all cells in this TreeTableColumn T> EventType | Returns: the edit start eventIndicates that the user has performed some interaction to start an edit
event, or alternatively the
|
| public final Callback | |
| public final ObservableValue | getCellObservableValue(int index)
Implements abstract javafx. Attempts to return an ObservableValue<T> for the item in the given index (which is of type S). |
| public final ObservableValue | getCellObservableValue(TreeItem<S> item)
Implements abstract javafx. Attempts to return an ObservableValue<T> for the given item (which is of type S). |
| public final Callback | |
| public static List | Returns: an empty listGets the |
| public final ObservableList | getColumns()
Implements abstract javafx. This enables support for nested columns, which can be useful to group together related data. |
| public List | |
| public final EventHandler | |
| public final EventHandler | |
| public final EventHandler | |
| public final TreeTableColumn. | |
| public Node | getStyleableNode()
Overrides default javafx. Returns the Node that represents this Styleable object. |
| public Styleable | Returns: getTreeTableView()Implements javafx. Return the parent of this Styleable, or null if there is no parent. |
| public final TreeTableView | |
| public String | Returns: "TreeTableColumn"Implements javafx. The type of this |
| public final ObjectProperty | |
| public final ObjectProperty | |
| public final ObjectProperty | |
| private TableColumnHeader | |
| public final void | |
| public final void | |
| public final void | |
| public final void | |
| public final void | |
| public final void | |
| pack-priv final void | |
| public final ObjectProperty | |
| public final ReadOnlyObjectProperty |