Module MaterialFX

Package io.github.palexdev.materialfx.controls.base

Class AbstractMFXTreeItem<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

io.github.palexdev.materialfx.controls.base.AbstractMFXTreeItem<T>

Type Parameters:

T - The type of the data within TreeItem.

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

Direct Known Subclasses:

MFXTreeItem

public abstract class AbstractMFXTreeItem<T>
extends Control

Base class for every item used in MFXTreeView.

To be precise the MFXTreeView class is just the container of the tree. According to this implementation each item is a tree, the base concept is something like this:

 
 public class Node<T> {
     private T data;
     private Node<T> parent;
     private List<Node<T>> children;
 }
 
 

The root is defined as the element which parent is null.

See Also:

• AbstractMFXTreeCell
• MFXTreeView
• ITreeSelectionModel

Property Summary

Properties

Type	Property	Description
ObjectProperty<Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>>	cellFactory	Specifies the cell factory used by this item.
DoubleProperty	childrenMargin	Specifies the left margin of each children.
BooleanProperty	selected	Selection property.
BooleanProperty	startExpanded	Specifies whether the item should be expanded when created.
ObjectProperty<MFXTreeView<T>>	treeView

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

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, viewOrder, visible

Field Summary

Fields

Modifier and Type	Field	Description
protected final ObjectProperty<Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>>	cellFactory
protected final T	data
protected final ObservableList<AbstractMFXTreeItem<T>>	items
protected AbstractMFXTreeItem<T>	parent

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
AbstractMFXTreeItem(T data)

Method Summary

Modifier and Type	Method	Description
ObjectProperty<Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>>	cellFactoryProperty()	Specifies the cell factory used by this item.
DoubleProperty	childrenMarginProperty()	Specifies the left margin of each children.
protected abstract void	defaultCellFactory()
Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>	getCellFactory()
double	getChildrenMargin()
T	getData()
long	getIndex()	Calculates the item's index in the tree structure.
AbstractMFXTreeItem<T>	getItemParent()
ObservableList<AbstractMFXTreeItem<T>>	getItems()
long	getItemsCount()	Calculates the number of items contained by this item (included).
int	getLevel()	Calculates the this item's level in the tree structure.
AbstractMFXTreeItem<T>	getNextSibling()	Retrieves the next item at the same level in the tree.
AbstractMFXTreeItem<T>	getPreviousSibling()	Retrieves the previous item at the same level in the tree.
AbstractMFXTreeItem<T>	getRoot()	Retrieves the tree's root.
abstract ITreeSelectionModel<T>	getSelectionModel()
MFXTreeView<T>	getTreeView()	Retrieves the instance of the TreeView which contains the tree.
boolean	isLeaf()
boolean	isRoot()	Checks if the parent item is null.
boolean	isSelected()
boolean	isStartExpanded()
BooleanProperty	selectedProperty()	Selection property.
void	setCellFactory(Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>> cellFactory)	Sets the cell factory used by this item.
void	setChildrenMargin(double childrenMargin)	Sets the children left margin.
void	setItemParent(AbstractMFXTreeItem<T> parent)	Sets this item's parent.
void	setItems(ObservableList<AbstractMFXTreeItem<T>> items)
void	setSelected(boolean selected)	Sets this item selection state.
void	setStartExpanded(boolean startExpanded)	Sets the state of startExpandedProperty()
void	setTreeView(MFXTreeView<T> treeView)	Sets this item's TreeView reference to the given one.
BooleanProperty	startExpandedProperty()	Specifies whether the item should be expanded when created.
ObjectProperty<MFXTreeView<T>>	treeViewProperty()
protected abstract void	updateChildrenParent(List<? extends AbstractMFXTreeItem<T>> treeItems, AbstractMFXTreeItem<T> newParent)

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

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, getInitialCursor, 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, getViewOrder, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

treeView

public ObjectProperty<MFXTreeView<T>> treeViewProperty

See Also:

• getTreeView()
• setTreeView(MFXTreeView)

childrenMargin

public DoubleProperty childrenMarginProperty

Specifies the left margin of each children.

See Also:

• getChildrenMargin()
• setChildrenMargin(double)

startExpanded

public BooleanProperty startExpandedProperty

Specifies whether the item should be expanded when created.

See Also:

• isStartExpanded()
• setStartExpanded(boolean)

cellFactory

public ObjectProperty<Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>> cellFactoryProperty

Specifies the cell factory used by this item.

See Also:

• getCellFactory()
• setCellFactory(Callback)

selected

public BooleanProperty selectedProperty

Selection property.

See Also:

• isSelected()
• setSelected(boolean)

Field Details

data

protected final T data

items

protected final ObservableList<AbstractMFXTreeItem<T>> items

parent

protected AbstractMFXTreeItem<T> parent

cellFactory

protected final ObjectProperty<Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>> cellFactory

Constructor Details

AbstractMFXTreeItem

public AbstractMFXTreeItem(T data)

Method Details

getSelectionModel

public abstract ITreeSelectionModel<T> getSelectionModel()

defaultCellFactory

protected abstract void defaultCellFactory()

updateChildrenParent

protected abstract void updateChildrenParent(List<? extends AbstractMFXTreeItem<T>> treeItems,
 AbstractMFXTreeItem<T> newParent)

isRoot

public boolean isRoot()

Checks if the parent item is null.

Returns:

true if parent is null otherwise returns false

getRoot

public AbstractMFXTreeItem<T> getRoot()

Retrieves the tree's root.

Returns:

the root item

getIndex

public long getIndex()

Calculates the item's index in the tree structure.

Returns:

the item's index

See Also:

• TreeItemStream

getItemsCount

public long getItemsCount()

Calculates the number of items contained by this item (included).

getLevel

public int getLevel()

Calculates the this item's level in the tree structure.

getNextSibling

public AbstractMFXTreeItem<T> getNextSibling()

Retrieves the next item at the same level in the tree.

Returns:

the item's next sibling. Null if is root or there is no other item next

getPreviousSibling

public AbstractMFXTreeItem<T> getPreviousSibling()

Retrieves the previous item at the same level in the tree.

Returns:

the item's previous sibling. Null if is root or there is no other item before

isLeaf

public boolean isLeaf()

Returns:

if this item is leaf or not.

getTreeView

public MFXTreeView<T> getTreeView()

Retrieves the instance of the TreeView which contains the tree.

The reference is stored only in the root item so this method retrieves the root first and then returns the tree view instance.

Returns:

the TreeView instance

treeViewProperty

public ObjectProperty<MFXTreeView<T>> treeViewProperty()

See Also:

• getTreeView()
• setTreeView(MFXTreeView)

setTreeView

public void setTreeView(MFXTreeView<T> treeView)

Sets this item's TreeView reference to the given one.

WARNING: THIS METHOD IS INTENDED FOR INTERNAL USE ONLY

See Also:

• MFXTreeView

getData

public T getData()

Returns:

the data associated with this item

getItems

public ObservableList<AbstractMFXTreeItem<T>> getItems()

Returns:

the list containing this item's children

setItems

public void setItems(ObservableList<AbstractMFXTreeItem<T>> items)

getItemParent

public AbstractMFXTreeItem<T> getItemParent()

Returns:

this item's parent item

setItemParent

public void setItemParent(AbstractMFXTreeItem<T> parent)

Sets this item's parent. This method should be called by subclasses only.

WARNING: THIS METHOD IS INTENDED FOR INTERNAL USE ONLY

getChildrenMargin

public double getChildrenMargin()

Returns:

the children left margin to be used in layout.

childrenMarginProperty

public DoubleProperty childrenMarginProperty()

Specifies the left margin of each children.

See Also:

• getChildrenMargin()
• setChildrenMargin(double)

setChildrenMargin

public void setChildrenMargin(double childrenMargin)

Sets the children left margin.

isStartExpanded

public boolean isStartExpanded()

Returns:

the state of startExpandedProperty()

startExpandedProperty

public BooleanProperty startExpandedProperty()

Specifies whether the item should be expanded when created.

See Also:

• isStartExpanded()
• setStartExpanded(boolean)

setStartExpanded

public void setStartExpanded(boolean startExpanded)

Sets the state of startExpandedProperty()

getCellFactory

public Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>> getCellFactory()

Returns:

this item's cell factory

cellFactoryProperty

public ObjectProperty<Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>>> cellFactoryProperty()

Specifies the cell factory used by this item.

See Also:

• getCellFactory()
• setCellFactory(Callback)

setCellFactory

public void setCellFactory(Callback<AbstractMFXTreeItem<T>,AbstractMFXTreeCell<T>> cellFactory)

Sets the cell factory used by this item.

isSelected

public boolean isSelected()

Returns:

this item's selection state.

selectedProperty

public BooleanProperty selectedProperty()

Selection property.

See Also:

• isSelected()
• setSelected(boolean)

setSelected

public void setSelected(boolean selected)

Sets this item selection state.