TreeList

Since 2.2.1

TreeList<NODE> is a generic hierarchical list widget. Each node implements ITreeNode and can be a branch (expandable) or a leaf. Nodes are rendered using a configurable UIElementProvider and can be expanded/collapsed via arrow icons, single-click, or double-click.

Features:

• Single and multi-selection (with Shift and Ctrl).
• Dynamic tree (children are rechecked every tick by default) or static tree.
• Flatten-root mode to skip the root node in the display.
• Customisable expand/collapse icons and node background textures.

INFO

Everything documented on UIElement (layout, styles, events, data bindings, etc.) applies here too.

---

Usage

var tree = new TreeList<MyNode>(rootNode);
tree.setNodeUISupplier(TreeList.textTemplate(node -> Component.literal(node.getName())));
tree.setOnSelectedChanged(selected -> System.out.println("Selected: " + selected));
tree.setDoubleClickToExpand(true);
parent.addChild(tree);

treeList<MyNode>(rootNode, {
    nodeUI(TreeList.textTemplate { node -> Component.literal(node.name) })
    onSelectionChanged { selected -> println("Selected: $selected") }
}) { }

let tree = new TreeList(rootNode);
tree.setNodeUISupplier(TreeList.textTemplate(n => Component.literal(n.name)));
tree.setOnSelectedChanged(selected => { /* use selection */ });
parent.addChild(tree);

---

Tree List Style

INFO

node-background

Background texture for unselected nodes.

Default: none (empty)

tree.menuStyle(style -> style.nodeTexture(myBg));

tree-list {
    node-background: color(#00000040);
}

INFO

node-hover-background

Background texture for selected (highlighted) nodes.

Default: ColorPattern.BLUE.rectTexture()

tree.menuStyle(style -> style.hoverTexture(myHighlight));

tree-list {
    node-hover-background: color(#4040FF80);
}

INFO

collapse-icon / expand-icon

Icons shown on branch nodes when they are collapsed or expanded.

Defaults: Icons.RIGHT_ARROW_NO_BAR_S_WHITE / Icons.DOWN_ARROW_NO_BAR_S_WHITE

tree.menuStyle(style -> style
    .collapseIcon(myCollapsed)
    .expandIcon(myExpanded)
);

tree-list {
    collapse-icon: sprite("mymod:textures/gui/arrow_right.png");
    expand-icon: sprite("mymod:textures/gui/arrow_down.png");
}

---

Fields

Name	Type	Access	Description
treeListStyle	TreeListStyle	private (getter)	Current style.
root	NODE (nullable)	private (getter)	The root tree node.
hoveredNode	NODE (nullable)	private (getter)	The node currently under the mouse.
doubleClickToExpand	boolean	setter	Whether double-clicking expands/collapses branches. Default: true.
clickToExpand	boolean	setter	Whether single-clicking expands/collapses branches. Default: false.
supportMultipleSelection	boolean	setter	Whether Ctrl+click and Shift+click select multiple nodes. Default: false.
staticTree	boolean	setter	When true, children are not rechecked every tick. Default: false.

---

Methods

Method	Returns	Description
setRoot(NODE)	TreeList<NODE>	Sets the root node and rebuilds the list.
setNodeUISupplier(UIElementProvider<NODE>)	TreeList<NODE>	Sets the factory that creates the UI for each node.
setOnNodeUICreated(BiConsumer<NODE, UIElement>)	TreeList<NODE>	Callback invoked after each node UI is created.
setOnSelectedChanged(Consumer<Set<NODE>>)	—	Callback invoked when the selection changes.
setOnDoubleClickNode(Consumer<NODE>)	—	Callback invoked on double-click.
setSelectableNodeFilter(Predicate<NODE>)	—	Predicate that controls which nodes can be selected.
setFlattenRoot(boolean)	TreeList<NODE>	When true, the root is not shown; its children become top-level items.
getSelected()	Set<NODE>	Returns the currently selected nodes (unmodifiable).
setSelected(Collection<NODE>, boolean)	TreeList<NODE>	Replaces the selection.
addSelected(NODE, boolean)	TreeList<NODE>	Adds a node to the selection.
removeSelected(NODE, boolean)	TreeList<NODE>	Removes a node from the selection.
expandNode(NODE)	void	Expands a branch node.
collapseNode(NODE)	void	Collapses a branch node.
expandNodeAlongPath(NODE)	void	Expands all ancestors of the given node.
isNodeExpanded(NODE)	boolean	Returns true if the node is currently expanded.
isNodeSelected(NODE)	boolean	Returns true if the node is currently selected.
reloadList()	TreeList<NODE>	Clears and rebuilds all node UIs from the current root.
menuStyle(Consumer<TreeListStyle>)	TreeList<NODE>	Configures style fluently.

---

Node UI Templates

Static helper methods for common node UI layouts:

Method	Description
textTemplate(Function<NODE, Component>)	Creates a node UI showing only text.
iconTextTemplate(Function<NODE, IGuiTexture>, Function<NODE, Component>)	Creates a node UI with an icon and text.
optionalIconTextTemplate(Function<NODE, IGuiTexture>, Function<NODE, Component>)	Like iconTextTemplate but the icon is shown only when non-empty.