Class TreeView

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement, TreeView>

org.patternfly.component.tree.TreeView

All Implemented Interfaces:

Iterable<TreeViewItem>, Attachable, ElementAttributeMethods<HTMLElement, TreeView>, ElementClassListMethods<HTMLElement, TreeView>, ElementConsumerMethods<HTMLElement, TreeView>, ElementContainerMethods<HTMLElement, TreeView>, ElementEventMethods<HTMLElement, TreeView>, ElementIdMethods<HTMLElement, TreeView>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, TreeView>, HTMLElementDataMethods<HTMLElement, TreeView>, HTMLElementStyleMethods<HTMLElement, TreeView>, HTMLElementVisibilityMethods<HTMLElement, TreeView>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, TreeView>, Component, HasItems<HTMLElement, TreeView, TreeViewItem>

public class TreeView
extends BaseComponent<HTMLElement, TreeView>
implements HasItems<HTMLElement, TreeView, TreeViewItem>, Attachable

A tree view is a structure that displays data in a hierarchical view. It can be used in a dropdown, drawer, primary-detail, modal, or wizard.

See Also:

• https://www.patternfly.org/components/tree-view

Method Summary

Modifier and Type	Method	Description
TreeView	add(TreeViewItem item)	Adds an item to the component.
TreeView	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()	Clears all items from the component.
void	collapse()
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
void	detach(MutationRecord mutationRecord)
TreeView	expandedIcon(Supplier<Element> icon)
TreeViewItem	findItem(String identifier)
TreeView	guides()	Same as guides(true)
TreeView	guides(boolean guides)	Adds/removes modifier(guides)
TreeView	icon(Supplier<Element> icon)
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
TreeViewItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<TreeViewItem>	iterator()
Promise<Iterable<TreeViewItem>>	load(String identifier)
Promise<Iterable<TreeViewItem>>	load(TreeViewItem item)
TreeView	onAdd(AddItemHandler<TreeView, TreeViewItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
TreeView	onMultiSelect(MultiSelectHandler<TreeView, TreeViewItem> selectHandler)
TreeView	onRemove(RemoveItemHandler<TreeView, TreeViewItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
TreeView	onSelect(SelectHandler<TreeViewItem> selectHandler)
TreeView	onToggle(ToggleHandler<TreeViewItem> toggleHandler)
TreeView	onUpdate(UpdateItemHandler<TreeView, TreeViewItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
void	removeItem(String identifier)	Removes an item from the component based on the provided identifier.
void	reset()
void	select(String identifier)
void	select(TreeViewItem item)
void	select(TreeViewItem item, boolean selected)
void	select(TreeViewItem item, boolean selected, boolean fireEvent)
List<TreeViewItem>	selectedItems()
int	size()	Retrieves the total number of items currently contained in the component.
TreeView	that()
void	toggle(TreeViewItem item)
void	toggle(TreeViewItem item, boolean fireEvent)
static TreeView	treeView()
static TreeView	treeView(TreeViewType type)
void	unselect()
void	unselect(boolean fireEvent)
void	updateItem(TreeViewItem item)	Updates an existing item in the component.

Methods inherited from class BaseComponent

componentType, element, registerComponent

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface HasItems

addItem, addItems, items, replaceItemElement, updateItem, updateItem

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface Iterable

forEach, spliterator

Method Details

treeView

public static TreeView treeView()

treeView

public static TreeView treeView(TreeViewType type)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

add

public TreeView add(TreeViewItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

guides

public TreeView guides()

Same as guides(true)

guides

public TreeView guides(boolean guides)

Adds/removes modifier(guides)

icon

public TreeView icon(Supplier<Element> icon)

expandedIcon

public TreeView expandedIcon(Supplier<Element> icon)

that

public TreeView that()

Specified by:

that in interface TypedBuilder<HTMLElement, TreeView>

ariaLabel

public TreeView ariaLabel(String label)

onAdd

public TreeView onAdd(AddItemHandler<TreeView, TreeViewItem> onAdd)

Description copied from interface: HasItems

Registers a callback to be invoked whenever a new item is added to the component.

Specified by:

onAdd in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

onAdd - a AddItemHandler that takes the builder instance and the item being added as arguments

Returns:

the builder instance after adding the callback

onUpdate

public TreeView onUpdate(UpdateItemHandler<TreeView, TreeViewItem> onUpdate)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is updated in the component.

Specified by:

onUpdate in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

onUpdate - a UpdateItemHandler that takes the component, the previous state of the item, and the updated state of the item as arguments

Returns:

the builder instance after adding the callback

onRemove

public TreeView onRemove(RemoveItemHandler<TreeView, TreeViewItem> onRemove)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is removed from the component.

Specified by:

onRemove in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

onRemove - a RemoveItemHandler that takes the component and the item being removed as arguments

Returns:

the builder instance after adding the callback

onMultiSelect

public TreeView onMultiSelect(MultiSelectHandler<TreeView, TreeViewItem> selectHandler)

onSelect

public TreeView onSelect(SelectHandler<TreeViewItem> selectHandler)

onToggle

public TreeView onToggle(ToggleHandler<TreeViewItem> toggleHandler)

load

public Promise<Iterable<TreeViewItem>> load(String identifier)

load

public Promise<Iterable<TreeViewItem>> load(TreeViewItem item)

toggle

public void toggle(TreeViewItem item)

toggle

public void toggle(TreeViewItem item,
 boolean fireEvent)

select

public void select(String identifier)

select

public void select(TreeViewItem item)

select

public void select(TreeViewItem item,
 boolean selected)

select

public void select(TreeViewItem item,
 boolean selected,
 boolean fireEvent)

selectedItems

public List<TreeViewItem> selectedItems()

unselect

public void unselect()

unselect

public void unselect(boolean fireEvent)

collapse

public void collapse()

reset

public void reset()

findItem

public TreeViewItem findItem(String identifier)

iterator

public Iterator<TreeViewItem> iterator()

Specified by:

iterator in interface Iterable<TreeViewItem>

size

public int size()

Description copied from interface: HasItems

Retrieves the total number of items currently contained in the component.

Specified by:

size in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Returns:

the number of items contained in the component

isEmpty

public boolean isEmpty()

Description copied from interface: HasItems

Checks whether the collection of items in the component is empty.

Specified by:

isEmpty in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Returns:

true if the component contains no items; false otherwise

contains

public boolean contains(String identifier)

Description copied from interface: HasItems

Checks whether the component contains an item associated with the given identifier.

Specified by:

contains in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

identifier - the identifier of the item to be checked

Returns:

true if the component contains an item associated with the provided identifier, false otherwise

item

public TreeViewItem item(String identifier)

Description copied from interface: HasItems

Retrieves the item associated with the specified identifier from the component.

Specified by:

item in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

identifier - the identifier of the item to be retrieved

Returns:

the item associated with the given identifier, or null if no item is found

updateItem

public void updateItem(TreeViewItem item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

item - the item to be updated

removeItem

public void removeItem(String identifier)

Description copied from interface: HasItems

Removes an item from the component based on the provided identifier.

Specified by:

removeItem in interface HasItems<HTMLElement, TreeView, TreeViewItem>

Parameters:

identifier - the identifier of the item to be removed

clear

public void clear()

Description copied from interface: HasItems

Clears all items from the component. This method removes any existing items within the component, leaving it empty. Any associated or registered callbacks related to the removal of items may be invoked as part of this operation.

Specified by:

clear in interface HasItems<HTMLElement, TreeView, TreeViewItem>