S
- The type of the TreeItem instances used in this TreeTableView.@DefaultProperty(value="root") public class TreeTableView<S> extends Control
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:
TreeTableColumn
API:
cell factories
to
easily customize cell
contents in both rendering and editing
states.
minWidth
/
prefWidth
/
maxWidth
,
and also fixed width columns
.
column nesting
resizing policies
to
dictate what happens when the user resizes columns.
multiple column sorting
by clicking
the column header (hold down Shift keyboard key whilst clicking on a
header to sort by multiple columns).
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;
}
}
Firstly, a TreeTableView instance needs to be defined, as such:
TreeTableView<File> treeTable = new TreeTableView<>();
With the basic TreeTableView instantiated, we next focus on the 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, as such:
TreeItem<File> root = new TreeItem<>(new File("/"));
treeTable.setRoot(root);
With the root set as such, the TreeTableView will automatically update whenever
the children
of the root changes.
At this point we now 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 last modified
properties, we extend the code shown above as follows:
TreeTableColumns<File,String> fileNameCol = new TreeTableColumn<>("Filename");
TreeTableColumns<File,Long> lastModifiedCol = new TreeTableColumn<>("Size");
table.getColumns().setAll(fileNameCol, lastModifiedCol);
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("name"));
lastModifiedCol.setCellValueFactory(new TreeItemPropertyValueFactory("lastModified"));
Running this code (assuming the file system structure is probably built up in
memory) will result in a TreeTableView being shown with two columns for name
and lastModified. Any other properties of the File class will not be shown, as
no TreeTableColumns are defined for them.
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();
}
});
}
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);
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.
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
TableColumnBase.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.
TreeTableColumn
,
TreeTablePosition
Type | Property and Description |
---|---|
ObjectProperty<Callback<TreeTableView.ResizeFeatures,Boolean>> |
columnResizePolicy
This is the function called when the user completes a column-resize
operation.
|
ReadOnlyObjectProperty<Comparator<TreeItem<S>>> |
comparator
The comparator property is a read-only property that is representative of the
current state of the
sort order list. |
BooleanProperty |
editable
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.
|
ReadOnlyObjectProperty<TreeTablePosition<S,?>> |
editingCell
Represents the current cell being edited, or null if
there is no cell being edited.
|
ReadOnlyIntegerProperty |
expandedItemCount
Represents the number of tree nodes presently able to be visible in the
TreeTableView.
|
DoubleProperty |
fixedCellSize
Specifies whether this control has cells that are a fixed height (of the
specified value).
|
ObjectProperty<TreeTableView.TreeTableViewFocusModel<S>> |
focusModel
The FocusModel provides the API through which it is possible
to control focus on zero or one rows of the TreeTableView.
|
ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> |
onScrollToColumn
Called when there's a request to scroll a column into view using
scrollToColumn(TreeTableColumn)
or scrollToColumnIndex(int) |
ObjectProperty<EventHandler<ScrollToEvent<Integer>>> |
onScrollTo
Called when there's a request to scroll an index into view using
scrollTo(int) |
ObjectProperty<EventHandler<SortEvent<TreeTableView<S>>>> |
onSort
Called when there's a request to sort the control.
|
ObjectProperty<Node> |
placeholder
This Node is shown to the user when the table has no content to show.
|
ObjectProperty<TreeItem<S>> |
root
Property representing the root node of the TreeTableView.
|
ObjectProperty<Callback<TreeTableView<S>,TreeTableRow<S>>> |
rowFactory
A function which produces a TreeTableRow.
|
ObjectProperty<TreeTableView.TreeTableViewSelectionModel<S>> |
selectionModel
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.
|
BooleanProperty |
showRoot
Property that represents whether or not the TreeTableView root node is visible.
|
ObjectProperty<TreeSortMode> |
sortMode
Specifies the sort mode to use when sorting the contents of this TreeTableView,
should any columns be specified in the
sort order
list. |
ObjectProperty<Callback<TreeTableView<S>,Boolean>> |
sortPolicy
The sort policy specifies how sorting in this TreeTableView should be performed.
|
BooleanProperty |
tableMenuButtonVisible
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.
|
ObjectProperty<TreeTableColumn<S,?>> |
treeColumn
Property that represents which column should have the disclosure node
shown in it (that is, the column with the arrow).
|
contextMenu, skin, tooltip
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
needsLayout
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible
Modifier and Type | Class and Description |
---|---|
static class |
TreeTableView.EditEvent<S>
An
Event subclass used specifically in TreeTableView for representing
edit-related events. |
static class |
TreeTableView.ResizeFeatures<S>
An immutable wrapper class for use in the TableView
column resize functionality. |
static class |
TreeTableView.TreeTableViewFocusModel<S>
A
FocusModel with additional functionality to support the requirements
of a TableView control. |
static class |
TreeTableView.TreeTableViewSelectionModel<S>
A simple extension of the
SelectionModel abstract class to
allow for special support for TreeTableView controls. |
Modifier and Type | Field and Description |
---|---|
static Callback<TreeTableView.ResizeFeatures,Boolean> |
CONSTRAINED_RESIZE_POLICY
Simple policy that ensures the width of all visible leaf columns in
this table sum up to equal the width of the table itself.
|
static Callback<TreeTableView,Boolean> |
DEFAULT_SORT_POLICY
The default
sort policy that this TreeTableView
will use if no other policy is specified. |
static 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).
|
USE_COMPUTED_SIZE, USE_PREF_SIZE
BASELINE_OFFSET_SAME_AS_HEIGHT
Constructor and Description |
---|
TreeTableView()
Creates an empty TreeTableView.
|
TreeTableView(TreeItem<S> root)
Creates a TreeTableView with the provided root node.
|
Modifier and Type | Method and Description |
---|---|
ObjectProperty<Callback<TreeTableView.ResizeFeatures,Boolean>> |
columnResizePolicyProperty()
This is the function called when the user completes a column-resize
operation.
|
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. |
protected Skin<?> |
createDefaultSkin()
Create a new instance of the default skin for this control.
|
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.
|
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.
|
static <S> EventType<TreeTableView.EditEvent<S>> |
editAnyEvent()
An EventType that indicates some edit event has occurred.
|
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.
|
static <S> EventType<TreeTableView.EditEvent<S>> |
editCommitEvent()
An EventType that is used to indicate that an edit in a TreeTableView has been
committed.
|
ReadOnlyObjectProperty<TreeTablePosition<S,?>> |
editingCellProperty()
Represents the current cell being edited, or null if
there is no cell being edited.
|
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.
|
ReadOnlyIntegerProperty |
expandedItemCountProperty()
Represents the number of tree nodes presently able to be visible in the
TreeTableView.
|
DoubleProperty |
fixedCellSizeProperty()
Specifies whether this control has cells that are a fixed height (of the
specified value).
|
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.
|
static List<CssMetaData<? extends Styleable,?>> |
getClassCssMetaData() |
Callback<TreeTableView.ResizeFeatures,Boolean> |
getColumnResizePolicy()
Gets the value of the property columnResizePolicy.
|
ObservableList<TreeTableColumn<S,?>> |
getColumns()
The TreeTableColumns that are part of this TableView.
|
Comparator<TreeItem<S>> |
getComparator()
Gets the value of the property comparator.
|
List<CssMetaData<? extends Styleable,?>> |
getControlCssMetaData() |
TreeTablePosition<S,?> |
getEditingCell()
Gets the value of the property editingCell.
|
int |
getExpandedItemCount()
Gets the value of the property expandedItemCount.
|
double |
getFixedCellSize()
Returns the fixed cell size value.
|
TreeTableView.TreeTableViewFocusModel<S> |
getFocusModel()
Returns the currently installed
FocusModel . |
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) |
EventHandler<ScrollToEvent<Integer>> |
getOnScrollTo()
Gets the value of the property onScrollTo.
|
EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> |
getOnScrollToColumn()
Gets the value of the property onScrollToColumn.
|
EventHandler<SortEvent<TreeTableView<S>>> |
getOnSort()
Gets the value of the property onSort.
|
Node |
getPlaceholder()
Gets the value of the property placeholder.
|
TreeItem<S> |
getRoot()
Returns the current root node of this TreeTableView, or null if no root node
is specified.
|
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).
|
Callback<TreeTableView<S>,TreeTableRow<S>> |
getRowFactory()
Gets the value of the property rowFactory.
|
TreeTableView.TreeTableViewSelectionModel<S> |
getSelectionModel()
Returns the currently installed selection model.
|
TreeSortMode |
getSortMode()
Gets the value of the property sortMode.
|
ObservableList<TreeTableColumn<S,?>> |
getSortOrder()
The sortOrder list defines the order in which
TreeTableColumn instances
are sorted. |
Callback<TreeTableView<S>,Boolean> |
getSortPolicy()
Gets the value of the property sortPolicy.
|
TreeTableColumn<S,?> |
getTreeColumn()
Gets the value of the property treeColumn.
|
TreeItem<S> |
getTreeItem(int row)
Returns the TreeItem in the given index, or null if it is out of bounds.
|
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.
|
TreeTableColumn<S,?> |
getVisibleLeafColumn(int column)
Returns the TreeTableColumn in the given column index, relative to all other
visible leaf columns.
|
ObservableList<TreeTableColumn<S,?>> |
getVisibleLeafColumns()
Returns an unmodifiable list containing the currently visible leaf columns.
|
int |
getVisibleLeafIndex(TreeTableColumn<S,?> column)
Returns the position of the given column, relative to all other
visible leaf columns.
|
boolean |
isEditable()
Gets the value of the property editable.
|
boolean |
isShowRoot()
Returns true if the root of the TreeTableView should be shown, and false if
it should not.
|
boolean |
isTableMenuButtonVisible()
Gets the value of the property tableMenuButtonVisible.
|
protected void |
layoutChildren()
Invoked during the layout pass to layout the children in this
Parent . |
ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> |
onScrollToColumnProperty()
Called when there's a request to scroll a column into view using
scrollToColumn(TreeTableColumn)
or scrollToColumnIndex(int) |
ObjectProperty<EventHandler<ScrollToEvent<Integer>>> |
onScrollToProperty()
Called when there's a request to scroll an index into view using
scrollTo(int) |
ObjectProperty<EventHandler<SortEvent<TreeTableView<S>>>> |
onSortProperty()
Called when there's a request to sort the control.
|
ObjectProperty<Node> |
placeholderProperty()
This Node is shown to the user when the table has no content to show.
|
Object |
queryAccessibleAttribute(AccessibleAttribute attribute,
Object... parameters)
*
Accessibility handling *
*
|
void |
refresh()
Calling
refresh() forces the TreeTableView control to recreate and
repopulate the cells necessary to populate the visual bounds of the control. |
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.
|
ObjectProperty<TreeItem<S>> |
rootProperty()
Property representing the root node of the TreeTableView.
|
ObjectProperty<Callback<TreeTableView<S>,TreeTableRow<S>>> |
rowFactoryProperty()
A function which produces a TreeTableRow.
|
void |
scrollTo(int index)
Scrolls the TreeTableView such that the item in the given index is visible to
the end user.
|
void |
scrollToColumn(TreeTableColumn<S,?> column)
Scrolls the TreeTableView so that the given column is visible within the viewport.
|
void |
scrollToColumnIndex(int columnIndex)
Scrolls the TreeTableView so that the given index is visible within the viewport.
|
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.
|
void |
setColumnResizePolicy(Callback<TreeTableView.ResizeFeatures,Boolean> callback)
Sets the value of the property columnResizePolicy.
|
void |
setEditable(boolean value)
Sets the value of the property editable.
|
void |
setFixedCellSize(double value)
Sets the new fixed cell size for this control.
|
void |
setFocusModel(TreeTableView.TreeTableViewFocusModel<S> value)
Sets the
FocusModel to be used in the TreeTableView. |
void |
setOnScrollTo(EventHandler<ScrollToEvent<Integer>> value)
Sets the value of the property onScrollTo.
|
void |
setOnScrollToColumn(EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> value)
Sets the value of the property onScrollToColumn.
|
void |
setOnSort(EventHandler<SortEvent<TreeTableView<S>>> value)
Sets the value of the property onSort.
|
void |
setPlaceholder(Node value)
Sets the value of the property placeholder.
|
void |
setRoot(TreeItem<S> value)
Sets the root node in this TreeTableView.
|
void |
setRowFactory(Callback<TreeTableView<S>,TreeTableRow<S>> value)
Sets the value of the property rowFactory.
|
void |
setSelectionModel(TreeTableView.TreeTableViewSelectionModel<S> value)
Sets the
MultipleSelectionModel to be used in the TreeTableView. |
void |
setShowRoot(boolean value)
Specifies whether the root
TreeItem should be shown within this
TreeTableView. |
void |
setSortMode(TreeSortMode value)
Sets the value of the property sortMode.
|
void |
setSortPolicy(Callback<TreeTableView<S>,Boolean> callback)
Sets the value of the property sortPolicy.
|
void |
setTableMenuButtonVisible(boolean value)
Sets the value of the property tableMenuButtonVisible.
|
void |
setTreeColumn(TreeTableColumn<S,?> value)
Sets the value of the property treeColumn.
|
BooleanProperty |
showRootProperty()
Property that represents whether or not the TreeTableView root node is visible.
|
void |
sort()
The sort method forces the TreeTableView to re-run its sorting algorithm.
|
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. |
ObjectProperty<Callback<TreeTableView<S>,Boolean>> |
sortPolicyProperty()
The sort policy specifies how sorting in this TreeTableView should be performed.
|
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.
|
ObjectProperty<TreeTableColumn<S,?>> |
treeColumnProperty()
Property that represents which column should have the disclosure node
shown in it (that is, the column with the arrow).
|
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty
public final ObjectProperty<TreeItem<S>> rootProperty
public final BooleanProperty showRootProperty
isShowRoot()
,
setShowRoot(boolean)
public final ObjectProperty<TreeTableColumn<S,?>> treeColumnProperty
visible leaf columns
list.getTreeColumn()
,
setTreeColumn(TreeTableColumn)
public final ObjectProperty<TreeTableView.TreeTableViewSelectionModel<S>> selectionModelProperty
public final ObjectProperty<TreeTableView.TreeTableViewFocusModel<S>> focusModelProperty
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.
getExpandedItemCount()
public final BooleanProperty editableProperty
isEditable()
,
setEditable(boolean)
public final ReadOnlyObjectProperty<TreeTablePosition<S,?>> editingCellProperty
getEditingCell()
public final BooleanProperty tableMenuButtonVisibleProperty
public final ObjectProperty<Callback<TreeTableView.ResizeFeatures,Boolean>> columnResizePolicyProperty
UNCONSTRAINED_RESIZE_POLICY
and
CONSTRAINED_RESIZE_POLICY
.public final ObjectProperty<Callback<TreeTableView<S>,TreeTableRow<S>>> rowFactoryProperty
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.
getRowFactory()
,
setRowFactory(Callback)
public final ObjectProperty<Node> placeholderProperty
getPlaceholder()
,
setPlaceholder(Node)
public final DoubleProperty fixedCellSizeProperty
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.
getFixedCellSize()
,
setFixedCellSize(double)
public final ObjectProperty<TreeSortMode> sortModeProperty
sort order
list.getSortMode()
,
setSortMode(TreeSortMode)
public final ReadOnlyObjectProperty<Comparator<TreeItem<S>>> comparatorProperty
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.getComparator()
public final ObjectProperty<Callback<TreeTableView<S>,Boolean>> sortPolicyProperty
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.
getSortPolicy()
,
setSortPolicy(Callback)
public ObjectProperty<EventHandler<SortEvent<TreeTableView<S>>>> onSortProperty
getOnSort()
,
setOnSort(EventHandler)
public ObjectProperty<EventHandler<ScrollToEvent<Integer>>> onScrollToProperty
scrollTo(int)
getOnScrollTo()
,
setOnScrollTo(EventHandler)
public ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> onScrollToColumnProperty
scrollToColumn(TreeTableColumn)
or scrollToColumnIndex(int)
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.
public static final Callback<TreeTableView.ResizeFeatures,Boolean> CONSTRAINED_RESIZE_POLICY
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.
public static final Callback<TreeTableView,Boolean> DEFAULT_SORT_POLICY
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.public TreeTableView()
Refer to the TreeTableView
class documentation for details on the
default state of other properties.
public TreeTableView(TreeItem<S> root)
Refer to the TreeTableView
class documentation for details on the
default state of other properties.
root
- The node to be the root in this TreeTableView.public static <S> EventType<TreeTableView.EditEvent<S>> editAnyEvent()
editStartEvent()
,
editCommitEvent()
and editCancelEvent()
.public static <S> EventType<TreeTableView.EditEvent<S>> editStartEvent()
public static <S> EventType<TreeTableView.EditEvent<S>> editCancelEvent()
public static <S> EventType<TreeTableView.EditEvent<S>> editCommitEvent()
@Deprecated public static int getNodeLevel(TreeItem<?> node)
getTreeItemLevel(TreeItem)
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.
node
- The TreeItem for which the level is needed.public final void setRoot(TreeItem<S> value)
TreeItem
class level
documentation for more details.value
- The TreeItem
that will be placed at the root of the
TreeTableView.public final TreeItem<S> getRoot()
public final ObjectProperty<TreeItem<S>> rootProperty()
public final void setShowRoot(boolean value)
TreeItem
should be shown within this
TreeTableView.value
- If true, the root TreeItem will be shown, and if false it
will be hidden.public final boolean isShowRoot()
public final BooleanProperty showRootProperty()
isShowRoot()
,
setShowRoot(boolean)
public final ObjectProperty<TreeTableColumn<S,?>> treeColumnProperty()
visible leaf columns
list.getTreeColumn()
,
setTreeColumn(TreeTableColumn)
public final void setTreeColumn(TreeTableColumn<S,?> value)
visible leaf columns
list.public final TreeTableColumn<S,?> getTreeColumn()
visible leaf columns
list.public final void setSelectionModel(TreeTableView.TreeTableViewSelectionModel<S> value)
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).public final TreeTableView.TreeTableViewSelectionModel<S> getSelectionModel()
public final ObjectProperty<TreeTableView.TreeTableViewSelectionModel<S>> selectionModelProperty()
public final void setFocusModel(TreeTableView.TreeTableViewFocusModel<S> value)
FocusModel
to be used in the TreeTableView.public final TreeTableView.TreeTableViewFocusModel<S> getFocusModel()
FocusModel
.public final ObjectProperty<TreeTableView.TreeTableViewFocusModel<S>> focusModelProperty()
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.
getExpandedItemCount()
public final int getExpandedItemCount()
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.
public final void setEditable(boolean value)
public final boolean isEditable()
public final BooleanProperty editableProperty()
isEditable()
,
setEditable(boolean)
public final TreeTablePosition<S,?> getEditingCell()
public final ReadOnlyObjectProperty<TreeTablePosition<S,?>> editingCellProperty()
getEditingCell()
public final BooleanProperty tableMenuButtonVisibleProperty()
public final void setTableMenuButtonVisible(boolean value)
public final boolean isTableMenuButtonVisible()
public final void setColumnResizePolicy(Callback<TreeTableView.ResizeFeatures,Boolean> callback)
UNCONSTRAINED_RESIZE_POLICY
and
CONSTRAINED_RESIZE_POLICY
.public final Callback<TreeTableView.ResizeFeatures,Boolean> getColumnResizePolicy()
UNCONSTRAINED_RESIZE_POLICY
and
CONSTRAINED_RESIZE_POLICY
.public final ObjectProperty<Callback<TreeTableView.ResizeFeatures,Boolean>> columnResizePolicyProperty()
UNCONSTRAINED_RESIZE_POLICY
and
CONSTRAINED_RESIZE_POLICY
.public final ObjectProperty<Callback<TreeTableView<S>,TreeTableRow<S>>> rowFactoryProperty()
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.
getRowFactory()
,
setRowFactory(Callback)
public final void setRowFactory(Callback<TreeTableView<S>,TreeTableRow<S>> value)
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.
public final Callback<TreeTableView<S>,TreeTableRow<S>> getRowFactory()
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.
public final ObjectProperty<Node> placeholderProperty()
getPlaceholder()
,
setPlaceholder(Node)
public final void setPlaceholder(Node value)
public final Node getPlaceholder()
public final void setFixedCellSize(double value)
value
- The new fixed cell size value, or a value less than or equal
to zero (or Region.USE_COMPUTED_SIZE) to disable.public final double getFixedCellSize()
public final DoubleProperty fixedCellSizeProperty()
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.
getFixedCellSize()
,
setFixedCellSize(double)
public final ObjectProperty<TreeSortMode> sortModeProperty()
sort order
list.getSortMode()
,
setSortMode(TreeSortMode)
public final void setSortMode(TreeSortMode value)
sort order
list.public final TreeSortMode getSortMode()
sort order
list.public final Comparator<TreeItem<S>> getComparator()
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.public final ReadOnlyObjectProperty<Comparator<TreeItem<S>>> comparatorProperty()
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.getComparator()
public final void setSortPolicy(Callback<TreeTableView<S>,Boolean> callback)
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.
public final Callback<TreeTableView<S>,Boolean> getSortPolicy()
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.
public final ObjectProperty<Callback<TreeTableView<S>,Boolean>> sortPolicyProperty()
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.
getSortPolicy()
,
setSortPolicy(Callback)
public void setOnSort(EventHandler<SortEvent<TreeTableView<S>>> value)
public EventHandler<SortEvent<TreeTableView<S>>> getOnSort()
public ObjectProperty<EventHandler<SortEvent<TreeTableView<S>>>> onSortProperty()
getOnSort()
,
setOnSort(EventHandler)
protected void layoutChildren()
Parent
. By default it will only set the size of managed,
resizable content to their preferred sizes and does not do any node
positioning.
Subclasses should override this function to layout content as needed.
layoutChildren
in class Control
public void scrollTo(int index)
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.public void setOnScrollTo(EventHandler<ScrollToEvent<Integer>> value)
scrollTo(int)
public EventHandler<ScrollToEvent<Integer>> getOnScrollTo()
scrollTo(int)
public ObjectProperty<EventHandler<ScrollToEvent<Integer>>> onScrollToProperty()
scrollTo(int)
getOnScrollTo()
,
setOnScrollTo(EventHandler)
public void scrollToColumn(TreeTableColumn<S,?> column)
column
- The column that should be visible to the user.public void scrollToColumnIndex(int columnIndex)
columnIndex
- The index of a column that should be visible to the user.public void setOnScrollToColumn(EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> value)
scrollToColumn(TreeTableColumn)
or scrollToColumnIndex(int)
public EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> getOnScrollToColumn()
scrollToColumn(TreeTableColumn)
or scrollToColumnIndex(int)
public ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> onScrollToColumnProperty()
scrollToColumn(TreeTableColumn)
or scrollToColumnIndex(int)
public int getRow(TreeItem<S> item)
item
- The TreeItem for which the index is sought.public TreeItem<S> getTreeItem(int row)
row
- The index of the TreeItem being sought.public int getTreeItemLevel(TreeItem<?> node)
node
- The TreeItem for which the level is needed.public final ObservableList<TreeTableColumn<S,?>> getColumns()
Note: to display any data in a TableView, there must be at least one TreeTableColumn in this ObservableList.
public final ObservableList<TreeTableColumn<S,?>> getSortOrder()
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.public boolean resizeColumn(TreeTableColumn<S,?> column, double delta)
public void edit(int row, TreeTableColumn<S,?> column)
public ObservableList<TreeTableColumn<S,?>> getVisibleLeafColumns()
public int getVisibleLeafIndex(TreeTableColumn<S,?> column)
public TreeTableColumn<S,?> getVisibleLeafColumn(int column)
public void sort()
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.public void refresh()
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.public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()
getControlCssMetaData
in class Control
protected Skin<?> createDefaultSkin()
-fx-skin
or set explicitly in a sub-class with setSkin(...)
.createDefaultSkin
in class Control
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)
queryAccessibleAttribute
in class Control
attribute
- the requested attributeparameters
- optional list of parametersAccessibleAttribute
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.