class: TreeView

[107:7] extends: Control

The TreeView class wraps the JavaFX TreeView control, which displays hierarchical data as an expandable and collapsible tree. Each node in the tree is represented by a TreeItem, and the root TreeItem can optionally be hidden so the top-level children appear as the visual roots. TreeView supports single and multiple selection modes and fires selection-change events when the user clicks a different item. The tables below list every CSS property available to TreeView, organized by the class level where each property is defined.

CSS Properties -- TreeView

Property	Values	Default	Description
`-fx-fixed-cell-size`	`<size>`	`Region.USE_COMPUTED_SIZE`	Sets a fixed height for every cell. When set, `-fx-fixed-cell-size` takes precedence over `-fx-cell-size`.

CSS Properties -- Control

Property	Values	Default	Description
`-fx-skin`	`<string>`	`null`	Fully qualified class name of the Skin to use for rendering this control.
`-fx-focus-traversable`	`true \| false`	`true`	When true, the control participates in focus traversal via the keyboard Tab key. (Default is `false` for Accordion, ScrollPane.)

CSS Properties -- Region

Background fills

Property	Values	Default	Description
`-fx-background-color`	`<paint> [, <paint>]*`	`transparent`	One or more paint values for background fill layers, rendered back to front.
`-fx-background-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`0 0 0 0`	Insets from the region edges for each background fill layer.
`-fx-background-radius`	`<size> [/ <size>]* [, ...]*`	`0 0 0 0`	Corner radii for each background fill layer.

Background images

Property	Values	Default	Description
`-fx-background-image`	`<uri> [, <uri>]*`	`null`	One or more image URIs for background image layers.
`-fx-background-position`	`<bg-position> [, ...]*`	`0% 0%`	Position of each background image within the region. Accepts keywords or size values.
`-fx-background-repeat`	`<repeat-style> [, ...]*`	`repeat repeat`	Tiling behavior for each background image. Values: repeat, no-repeat, round, space applied per axis.
`-fx-background-size`	`<bg-size> [, ...]*`	`auto auto`	Dimensions for each background image. Supports cover, contain, stretch, or explicit sizes.

Stroked borders

Property	Values	Default	Description
`-fx-border-color`	`<paint>` or `<t> <r> <b> <l>` [, ...]*	`null`	Paint colors for the border stroke layers.
`-fx-border-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`null`	Insets from region edges for each border layer.
`-fx-border-radius`	`<size> [, ...]*`	`null`	Corner radii for border stroke layers.
`-fx-border-style`	`<border-style> [, ...]*`	`null`	Border line style (solid, dotted, dashed) plus phase and line cap/join options per layer.
`-fx-border-width`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`null`	Thickness of each border stroke layer, per side.

Border images

Property	Values	Default	Description
`-fx-border-image-source`	`<uri> [, <uri>]*`	`null`	Image URIs used to paint the border.
`-fx-border-image-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`0 0 0 0`	Insets for each border image layer.
`-fx-border-image-repeat`	`<repeat-style> [, ...]*`	`repeat repeat`	Tiling behavior for each border image.
`-fx-border-image-slice`	`<size>` or `<t> <r> <b> <l>` [fill] [, ...]*	`100%`	Divides each border image into nine regions. Adding fill preserves the center region.
`-fx-border-image-width`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`1 1 1 1`	Width of each border image slice per side.

Other Region properties

Property	Values	Default	Description
`-fx-padding`	`<size>` or `<t> <r> <b> <l>`	`0 0 0 0`	Interior padding between the region border and its content.
`-fx-shape`	`<string>`	`null`	SVG path string that defines a custom clip shape for the region.
`-fx-scale-shape`	`true \| false`	`true`	When true, the shape is scaled to fit the region.
`-fx-position-shape`	`true \| false`	`true`	When true, the shape is centered within the region.
`-fx-snap-to-pixel`	`true \| false`	`true`	When true, positions and sizes are rounded to whole pixel boundaries.
`-fx-min-width`	`<size>`	`-1`	Minimum width. -1 uses the computed minimum.
`-fx-pref-width`	`<size>`	`-1`	Preferred width. -1 uses the computed preferred.
`-fx-max-width`	`<size>`	`-1`	Maximum width. -1 uses the computed maximum.
`-fx-min-height`	`<size>`	`-1`	Minimum height. -1 uses the computed minimum.
`-fx-pref-height`	`<size>`	`-1`	Preferred height. -1 uses the computed preferred.
`-fx-max-height`	`<size>`	`-1`	Maximum height. -1 uses the computed maximum.

CSS Properties -- Node

Property	Values	Default	Description
`-fx-blend-mode`	`add \| blue \| color-burn \| color-dodge \| darken \| difference \| exclusion \| green \| hard-light \| lighten \| multiply \| overlay \| red \| screen \| soft-light \| src-atop \| src-in \| src-out \| src-over`	`null`	Blend mode used when compositing this node with nodes beneath it.
`-fx-cursor`	`null \| crosshair \| default \| hand \| move \| e-resize \| h-resize \| ne-resize \| nw-resize \| n-resize \| se-resize \| sw-resize \| s-resize \| w-resize \| v-resize \| text \| wait \| <url>`	`null` (inherits)	Mouse cursor shape shown when the pointer is over this node. Inherits from parent by default.
`-fx-effect`	`<effect>`	`null`	A visual effect (e.g. DropShadow, InnerShadow) applied to the rendered node.
`-fx-focus-traversable`	`true \| false`	`false`	Whether this node participates in focus traversal. Overridden to `true` by Control.
`-fx-view-order`	`<number>`	`0`	Adjusts rendering and hit-test order within the parent without changing the scene graph order.
`-fx-opacity`	`<number> [0.0 - 1.0]`	`1`	Opacity of the node. 0 is fully transparent, 1 is fully opaque.
`-fx-rotate`	`<number>`	`0`	Rotation angle in degrees applied around the node's center point. Positive values are clockwise.
`-fx-scale-x`	`<number>`	`1`	Scale factor along the X axis about the node's center.
`-fx-scale-y`	`<number>`	`1`	Scale factor along the Y axis about the node's center.
`-fx-scale-z`	`<number>`	`1`	Scale factor along the Z axis about the node's center.
`-fx-translate-x`	`<number>`	`0`	Translation offset along the X axis in pixels.
`-fx-translate-y`	`<number>`	`0`	Translation offset along the Y axis in pixels.
`-fx-translate-z`	`<number>`	`0`	Translation offset along the Z axis in pixels.
`visibility`	`visible \| hidden \| collapse \| inherit`	`visible`	Controls whether the node is rendered and participates in layout. `collapse` removes it from layout; `hidden` keeps the space.
`-fx-managed`	`true \| false`	`true`	When false, the parent layout does not manage this node's position or size.

Methods

TreeView (object RootItem = null)

Creates a new TreeView with an optional root TreeItem.
- @p RootItem is an optional TreeItem to use as the root.
setRoot (object RootItem)

Sets the root TreeItem.
- @p RootItem is a TreeItem to use as the root.
- @r this object for chaining
setShowRoot (bool Show)

Sets whether the root node is visible.
- @p Show is a bool with true to show the root.
- @r this object for chaining
getSelected ()

Gets the currently selected TreeItem.
- @r The selected TreeItem or null.
getRoot ()

Returns the root TreeItem of the TreeView.
- @r A TreeItem with the root node.
getSelectedItem ()

Gets the currently selected TreeItem value.
- @r The value held by the selected TreeItem, or null.
onChange (callback OnChange)

Sets a callback for when the selection changes.
- @p OnChange is a callback to call on selection change.
- @r this object for chaining
setPrefSize (double Width, double Height)

Sets the preferred width and height of the TreeView.
- @p Width is a double with the preferred width in pixels.
- @p Height is a double with the preferred height in pixels.
- @r this object for chaining
setId (string Id)

Sets the CSS id of this TreeView node.
- @p Id is a string with the CSS id.
- @r this object for chaining
setFixedCellSize (double Size)

Sets a fixed height in pixels for every row cell in the TreeView.
- @p Size is a double with the fixed cell size, or -1 to use computed sizes.
- @r this object for chaining
setCellFactory (callback Factory)

Sets a custom cell factory callback that creates cells for each tree item.
- @p Factory is a callback that receives a TreeView and returns a TreeCell.
- @r this object for chaining
rootProperty ()

Returns the ObjectProperty backing the root TreeItem.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<TreeItem>.
isShowRoot ()

Returns whether the root TreeItem is rendered.
- @r A bool; true when the root is shown.
showRootProperty ()

Returns the BooleanProperty backing the showRoot flag.
- @r An AJO wrapping javafx.beans.property.BooleanProperty.
setSelectionModel (object Model)

Replaces the selection model used by this TreeView.
- @p Model is an AJO wrapping a javafx.scene.control.MultipleSelectionModel.
- @r this object for chaining
getSelectionModel ()

Returns the current selection model.
- @r An AJO wrapping javafx.scene.control.MultipleSelectionModel<TreeItem>.
selectionModelProperty ()

Returns the ObjectProperty backing the selection model.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<MultipleSelectionModel<TreeItem>>.
setFocusModel (object Model)

Replaces the focus model used by this TreeView.
- @p Model is an AJO wrapping a javafx.scene.control.FocusModel.
- @r this object for chaining
getFocusModel ()

Returns the current focus model.
- @r An AJO wrapping javafx.scene.control.FocusModel<TreeItem>.
focusModelProperty ()

Returns the ObjectProperty backing the focus model.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<FocusModel<TreeItem>>.
expandedItemCountProperty ()

Returns the read-only IntegerProperty backing the expanded item count.
- @r An AJO wrapping javafx.beans.property.ReadOnlyIntegerProperty.
getExpandedItemCount ()

Returns the number of currently expanded items in the TreeView.
- @r An int with the visible item count.
getFixedCellSize ()

Returns the fixed cell height in pixels, or a negative sentinel when unset.
- @r A double with the fixed cell size.
fixedCellSizeProperty ()

Returns the DoubleProperty backing the fixed cell size.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setEditable (bool Editable)

Sets whether the TreeView allows inline editing of items.
- @p Editable is a bool; true enables in-place editing.
- @r this object for chaining
isEditable ()

Returns whether the TreeView allows inline editing.
- @r A bool; true when editing is enabled.
editableProperty ()

Returns the BooleanProperty backing the editable flag.
- @r An AJO wrapping javafx.beans.property.BooleanProperty.
getEditingItem ()

Returns the TreeItem currently being edited, or null when no edit is in progress.
- @r An AJO wrapping the editing javafx.scene.control.TreeItem, or null.
editingItemProperty ()

Returns the read-only ObjectProperty backing the editing item.
- @r An AJO wrapping javafx.beans.property.ReadOnlyObjectProperty<TreeItem>.
setOnEditStart (callback OnStart)

Registers a callback for the editStart event.
- @p OnStart is a callback invoked with a TreeView.EditEvent.
- @r this object for chaining
getOnEditStart ()

Returns the current onEditStart handler.
- @r An AJO wrapping javafx.event.EventHandler<TreeView.EditEvent>.
onEditStartProperty ()

Returns the ObjectProperty backing the onEditStart handler.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<EventHandler<TreeView.EditEvent>>.
setOnEditCommit (callback OnCommit)

Registers a callback for the editCommit event.
- @p OnCommit is a callback invoked with a TreeView.EditEvent.
- @r this object for chaining
getOnEditCommit ()

Returns the current onEditCommit handler.
- @r An AJO wrapping javafx.event.EventHandler<TreeView.EditEvent>.
onEditCommitProperty ()

Returns the ObjectProperty backing the onEditCommit handler.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<EventHandler<TreeView.EditEvent>>.
setOnEditCancel (callback OnCancel)

Registers a callback for the editCancel event.
- @p OnCancel is a callback invoked with a TreeView.EditEvent.
- @r this object for chaining
getOnEditCancel ()

Returns the current onEditCancel handler.
- @r An AJO wrapping javafx.event.EventHandler<TreeView.EditEvent>.
onEditCancelProperty ()

Returns the ObjectProperty backing the onEditCancel handler.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<EventHandler<TreeView.EditEvent>>.
edit (object Item)

Begins editing the given TreeItem when the TreeView is editable.
- @p Item is a TreeItem to edit; pass null to cancel editing.
- @r this object for chaining
scrollTo (int Index)

Scrolls the TreeView so the row at the given index is visible.
- @p Index is an int with the zero-based row index.
- @r this object for chaining
setOnScrollTo (callback OnScroll)

Registers a callback for the scrollTo event.
- @p OnScroll is a callback invoked with a TreeView.EditEvent-like ScrollToEvent.
- @r this object for chaining
getOnScrollTo ()

Returns the current onScrollTo handler.
- @r An AJO wrapping javafx.event.EventHandler<ScrollToEvent>.
onScrollToProperty ()

Returns the ObjectProperty backing the onScrollTo handler.
- @r An AJO wrapping javafx.beans.property.ObjectProperty<EventHandler<ScrollToEvent>>.
getRow (object Item)

Returns the row index of the given TreeItem within the tree, or -1 when the item is not present.
- @p Item is a TreeItem to look up.
- @r An int with the row index, or -1.
getTreeItem (int Index)

Returns the TreeItem displayed at the given row index, or null when the index is out of bounds.
- @p Index is an int with the zero-based row index.
- @r An AJO wrapping the javafx.scene.control.TreeItem, or null.
getTreeItemLevel (object Item)

Returns the depth (root-relative level) of the given TreeItem, or -1 when the item is not in the tree.
- @p Item is a TreeItem whose level is reported.
- @r An int with the tree level.
refresh ()

Forces the TreeView to rebuild its visible cells.
- @r this object for chaining
getControlCssMetaData ()

Returns the list of CssMetaData entries declared on TreeView.
- @r An AJO wrapping the List<CssMetaData>.
queryAccessibleAttribute (string Attr)

Queries the value of a JavaFX AccessibleAttribute on this TreeView. Pass the enum constant name as a string (for example "ROLE", "TEXT").
- @p Attr is a string with the javafx.scene.AccessibleAttribute enum name.
- @r The attribute value as returned by JavaFX.