Spec-Zone .ru
спецификации, руководства, описания, API
|
S
- The type of the TreeItem instances used in this TreeTableView.@DefaultProperty(value="root") public class TreeTableView<S> extends Control
ListView
and TableView
controls. For an
example on how to create a TreeTableView, refer to the 'Creating a TreeTableView'
control section below.
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).
Note that TreeTableView is intended to be used to visualize data - it is not
intended to be used for laying out your user interface. If you want to lay
your user interface out in a grid-like fashion, consider the
GridPane
layout.
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 DoubleProperty lastModified;
public void setLastModified(Double value) { lastModifiedProperty().set(value); }
public DoubleProperty getLastModified() { return lastModifiedProperty().get(); }
public DoubleProperty lastModifiedProperty() {
if (lastModified == null) lastModified = new SimpleDoubleProperty(this, "lastModified");
return lastModified;
}
}
Firstly, a TreeTableView instance needs to be defined, as such:
TreeTableView<File> treeTable = new TreeTableView<File>();
With the basic tree table defined, 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<File>(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:
TreeItem<File> root = new TreeItem<File>(new File("/"));
treeTable.setRoot(root);
// TODO this is not valid TreeTableView code
TreeTableColumns<Person,String> firstNameCol = new TreeTableColumns<Person,String>("First Name");
firstNameCol.setCellValueFactory(new PropertyValueFactory("firstName"));
TreeTableColumns<Person,String> lastNameCol = new TreeTableColumns<Person,String>("Last Name");
lastNameCol.setCellValueFactory(new PropertyValueFactory("lastName"));
table.getColumns().setAll(firstNameCol, lastNameCol);
With the code shown above we have fully defined the minimum properties required to create a TreeTableView instance. 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 TreeTableColumnss 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, PropertyValueFactory
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 TreeTableColumns
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 Person instance for a particular TreeTableView row
return p.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.
TreeTableColumn
,
TreeTablePosition
Type | Property and Description |
---|---|
ObjectProperty<Callback<TreeTableView.ResizeFeatures,java.lang.Boolean>> |
columnResizePolicy
This is the function called when the user completes a column-resize
operation.
|
ReadOnlyObjectProperty<java.util.Comparator<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.
|
ReadOnlyObjectProperty<TreeItem<S>> |
editingItem
A property used to represent the TreeItem currently being edited
in the TreeTableView, if editing is taking place, or -1 if no item is 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<TreeTableView.EditEvent<S>>> |
onEditCancel
This event handler will be fired when the user cancels editing a cell.
|
ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> |
onEditCommit
This property is used when the user performs an action that should
result in their editing input being persisted.
|
ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> |
onEditStart
This event handler will be fired when the user successfully initiates
editing.
|
ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> |
onScrollToColumn
Called when there's a request to scroll a column into view using
scrollToColumn(TableColumn)
or scrollToColumnIndex(int) |
ObjectProperty<EventHandler<ScrollToEvent<java.lang.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>,java.lang.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
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 TableView controls. |
Modifier and Type | Field and Description |
---|---|
static Callback<TreeTableView.ResizeFeatures,java.lang.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,java.lang.Boolean> |
DEFAULT_SORT_POLICY
The default
sort policy that this TreeTableView
will use if no other policy is specified. |
static Callback<TreeTableView.ResizeFeatures,java.lang.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
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,java.lang.Boolean>> |
columnResizePolicyProperty()
This is the function called when the user completes a column-resize
operation.
|
ReadOnlyObjectProperty<java.util.Comparator<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.
|
void |
edit(TreeItem<S> item)
Instructs the TreeTableView to begin editing the given TreeItem, if
the TreeTableView is
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.
|
ReadOnlyObjectProperty<TreeItem<S>> |
editingItemProperty()
A property used to represent the TreeItem currently being edited
in the TreeTableView, if editing is taking place, or -1 if no item is 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 java.util.List<CssMetaData<? extends Styleable,?>> |
getClassCssMetaData() |
Callback<TreeTableView.ResizeFeatures,java.lang.Boolean> |
getColumnResizePolicy()
Gets the value of the property columnResizePolicy.
|
ObservableList<TreeTableColumn<S,?>> |
getColumns()
The TreeTableColumns that are part of this TableView.
|
java.util.Comparator<S> |
getComparator()
Gets the value of the property comparator.
|
java.util.List<CssMetaData<? extends Styleable,?>> |
getControlCssMetaData() |
TreeTablePosition<S,?> |
getEditingCell()
Gets the value of the property editingCell.
|
TreeItem<S> |
getEditingItem()
Returns the TreeItem that is currently being edited in the TreeTableView,
or null if no item is being edited.
|
int |
getExpandedItemCount()
Gets the value of the property expandedItemCount.
|
double |
getFixedCellSize()
Returns the fixed cell size value, which may be -1 to represent fixed cell
size mode is disabled, or a value greater than zero to represent the size
of all cells in this control.
|
TreeTableView.TreeTableViewFocusModel<S> |
getFocusModel()
Returns the currently installed
FocusModel . |
static int |
getNodeLevel(TreeItem<?> node)
Returns the number of levels of 'indentation' of the given TreeItem,
based on how many times getParent() can be recursively called.
|
EventHandler<TreeTableView.EditEvent<S>> |
getOnEditCancel()
Returns the
EventHandler that will be called when the user cancels
an edit. |
EventHandler<TreeTableView.EditEvent<S>> |
getOnEditCommit()
Returns the
EventHandler that will be called when the user commits
an edit. |
EventHandler<TreeTableView.EditEvent<S>> |
getOnEditStart()
Returns the
EventHandler that will be called when the user begins
an edit. |
EventHandler<ScrollToEvent<java.lang.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, taking into account the
current state of each TreeItem (i.e.
|
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>,java.lang.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.
|
TreeTableColumn<S,?> |
getVisibleLeafColumn(int column)
Returns the TableColumn 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<TreeTableView.EditEvent<S>>> |
onEditCancelProperty()
This event handler will be fired when the user cancels editing a cell.
|
ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> |
onEditCommitProperty()
This property is used when the user performs an action that should
result in their editing input being persisted.
|
ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> |
onEditStartProperty()
This event handler will be fired when the user successfully initiates
editing.
|
ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> |
onScrollToColumnProperty()
Called when there's a request to scroll a column into view using
scrollToColumn(TableColumn)
or scrollToColumnIndex(int) |
ObjectProperty<EventHandler<ScrollToEvent<java.lang.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.
|
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(TableColumn<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,java.lang.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 |
setOnEditCancel(EventHandler<TreeTableView.EditEvent<S>> value)
Sets the
EventHandler that will be called when the user cancels
an edit. |
void |
setOnEditCommit(EventHandler<TreeTableView.EditEvent<S>> value)
Sets the
EventHandler that will be called when the user commits
an edit. |
void |
setOnEditStart(EventHandler<TreeTableView.EditEvent<S>> value)
Sets the
EventHandler that will be called when the user begins
an edit. |
void |
setOnScrollTo(EventHandler<ScrollToEvent<java.lang.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>,java.lang.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>,java.lang.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, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, getUserAgentStylesheet, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, 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, setNeedsLayout
addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, 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, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, screenToLocal, screenToLocal, screenToLocal, 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<TreeItem<S>> editingItemProperty
A property used to represent the TreeItem currently being edited in the TreeTableView, if editing is taking place, or -1 if no item is being edited.
It is not possible to set the editing item, instead it is required that
you call edit(javafx.scene.control.TreeItem)
.
getEditingItem()
public final ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> onEditStartProperty
getOnEditStart()
,
setOnEditStart(EventHandler)
public final ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> onEditCommitProperty
This property is used when the user performs an action that should result in their editing input being persisted.
The EventHandler in this property should not be called directly -
instead call TreeCell.commitEdit(java.lang.Object)
from within
your custom TreeCell. This will handle firing this event, updating the
view, and switching out of the editing state.
getOnEditCommit()
,
setOnEditCommit(EventHandler)
public final ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> onEditCancelProperty
getOnEditCancel()
,
setOnEditCancel(EventHandler)
public final BooleanProperty tableMenuButtonVisibleProperty
public final ObjectProperty<Callback<TreeTableView.ResizeFeatures,java.lang.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
Region.USE_COMPUTED_SIZE
),
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.
getFixedCellSize()
,
setFixedCellSize(double)
public final ReadOnlyObjectProperty<TreeTablePosition<S,?>> editingCellProperty
getEditingCell()
public final ObjectProperty<TreeSortMode> sortModeProperty
sort order
list.getSortMode()
,
setSortMode(TreeSortMode)
public final ReadOnlyObjectProperty<java.util.Comparator<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>,java.lang.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<java.lang.Integer>>> onScrollToProperty
scrollTo(int)
getOnScrollTo()
,
setOnScrollTo(EventHandler)
public ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> onScrollToColumnProperty
scrollToColumn(TableColumn)
or scrollToColumnIndex(int)
public static final Callback<TreeTableView.ResizeFeatures,java.lang.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,java.lang.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,java.lang.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()
public static int getNodeLevel(TreeItem<?> node)
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 TreeItem<S> getEditingItem()
public final ReadOnlyObjectProperty<TreeItem<S>> editingItemProperty()
A property used to represent the TreeItem currently being edited in the TreeTableView, if editing is taking place, or -1 if no item is being edited.
It is not possible to set the editing item, instead it is required that
you call edit(javafx.scene.control.TreeItem)
.
getEditingItem()
public final void setOnEditStart(EventHandler<TreeTableView.EditEvent<S>> value)
EventHandler
that will be called when the user begins
an edit.public final EventHandler<TreeTableView.EditEvent<S>> getOnEditStart()
EventHandler
that will be called when the user begins
an edit.public final ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> onEditStartProperty()
getOnEditStart()
,
setOnEditStart(EventHandler)
public final void setOnEditCommit(EventHandler<TreeTableView.EditEvent<S>> value)
EventHandler
that will be called when the user commits
an edit.public final EventHandler<TreeTableView.EditEvent<S>> getOnEditCommit()
EventHandler
that will be called when the user commits
an edit.public final ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> onEditCommitProperty()
This property is used when the user performs an action that should result in their editing input being persisted.
The EventHandler in this property should not be called directly -
instead call TreeCell.commitEdit(java.lang.Object)
from within
your custom TreeCell. This will handle firing this event, updating the
view, and switching out of the editing state.
getOnEditCommit()
,
setOnEditCommit(EventHandler)
public final void setOnEditCancel(EventHandler<TreeTableView.EditEvent<S>> value)
EventHandler
that will be called when the user cancels
an edit.public final EventHandler<TreeTableView.EditEvent<S>> getOnEditCancel()
EventHandler
that will be called when the user cancels
an edit.public final ObjectProperty<EventHandler<TreeTableView.EditEvent<S>>> onEditCancelProperty()
getOnEditCancel()
,
setOnEditCancel(EventHandler)
public final BooleanProperty tableMenuButtonVisibleProperty()
public final void setTableMenuButtonVisible(boolean value)
public final boolean isTableMenuButtonVisible()
public final void setColumnResizePolicy(Callback<TreeTableView.ResizeFeatures,java.lang.Boolean> callback)
UNCONSTRAINED_RESIZE_POLICY
and
CONSTRAINED_RESIZE_POLICY
.public final Callback<TreeTableView.ResizeFeatures,java.lang.Boolean> getColumnResizePolicy()
UNCONSTRAINED_RESIZE_POLICY
and
CONSTRAINED_RESIZE_POLICY
.public final ObjectProperty<Callback<TreeTableView.ResizeFeatures,java.lang.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 -1 (or Region.USE_COMPUTED_SIZE)
to disable.public final double getFixedCellSize()
public final DoubleProperty fixedCellSizeProperty()
Region.USE_COMPUTED_SIZE
),
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.
getFixedCellSize()
,
setFixedCellSize(double)
public final TreeTablePosition<S,?> getEditingCell()
public final ReadOnlyObjectProperty<TreeTablePosition<S,?>> editingCellProperty()
getEditingCell()
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 java.util.Comparator<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<java.util.Comparator<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>,java.lang.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>,java.lang.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>,java.lang.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 edit(TreeItem<S> item)
editable
. Once
this method is called, if the current
cell factory
is set up to support editing,
the Cell will switch its visual state to enable the user input to take place.item
- The TreeItem in the TreeTableView that should be edited.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<java.lang.Integer>> value)
scrollTo(int)
public EventHandler<ScrollToEvent<java.lang.Integer>> getOnScrollTo()
scrollTo(int)
public ObjectProperty<EventHandler<ScrollToEvent<java.lang.Integer>>> onScrollToProperty()
scrollTo(int)
getOnScrollTo()
,
setOnScrollTo(EventHandler)
public void scrollToColumn(TableColumn<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(TableColumn)
or scrollToColumnIndex(int)
public EventHandler<ScrollToEvent<TreeTableColumn<S,?>>> getOnScrollToColumn()
scrollToColumn(TableColumn)
or scrollToColumnIndex(int)
public ObjectProperty<EventHandler<ScrollToEvent<TreeTableColumn<S,?>>>> onScrollToColumnProperty()
scrollToColumn(TableColumn)
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 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
TableColumn sort type
properties
change. In other words, this method should only be called directly when
something external changes and a sort is required.public static java.util.List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
public java.util.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
Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved. Use is subject to