Class TreeViewItem

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLLIElement, TreeViewItem>

org.patternfly.component.tree.TreeViewItem

All Implemented Interfaces:

Iterable<TreeViewItem>, ElementAttributeMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementClassListMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementConsumerMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementContainerMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementEventMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementIdMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementQueryMethods<elemental2.dom.HTMLLIElement>, ElementTextMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, HTMLElementAttributeMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, HTMLElementDataMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, HTMLElementStyleMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, HTMLElementVisibilityMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, IsElement<elemental2.dom.HTMLLIElement>, TypedBuilder<elemental2.dom.HTMLLIElement, TreeViewItem>, HasAsyncItems<TreeViewItem, TreeViewItem>, ComponentIcon<elemental2.dom.HTMLLIElement, TreeViewItem>, Expandable<elemental2.dom.HTMLLIElement, TreeViewItem>, ComponentContext<elemental2.dom.HTMLLIElement, TreeViewItem>, HasIdentifier<elemental2.dom.HTMLLIElement, TreeViewItem>, HasItems<elemental2.dom.HTMLLIElement, TreeViewItem, TreeViewItem>, OuiaSupport<elemental2.dom.HTMLLIElement, TreeViewItem>, Modifiers.Compact<elemental2.dom.HTMLLIElement, TreeViewItem>, Modifiers.Disabled<elemental2.dom.HTMLLIElement, TreeViewItem>

public class TreeViewItem
extends SubComponent<elemental2.dom.HTMLLIElement, TreeViewItem>
implements Modifiers.Compact<elemental2.dom.HTMLLIElement, TreeViewItem>, ComponentContext<elemental2.dom.HTMLLIElement, TreeViewItem>, ComponentIcon<elemental2.dom.HTMLLIElement, TreeViewItem>, Modifiers.Disabled<elemental2.dom.HTMLLIElement, TreeViewItem>, ElementTextMethods<elemental2.dom.HTMLLIElement, TreeViewItem>, Expandable<elemental2.dom.HTMLLIElement, TreeViewItem>, HasAsyncItems<TreeViewItem, TreeViewItem>, HasIdentifier<elemental2.dom.HTMLLIElement, TreeViewItem>, HasItems<elemental2.dom.HTMLLIElement, TreeViewItem, TreeViewItem>

A tree view item within a TreeView component.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_ID
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
TreeViewItem	add(AsyncItems<TreeViewItem, TreeViewItem> items)
TreeViewItem	add(TreeViewItem item)	Adds an item to the component.
void	clear()	Clears all items from the component.
void	collapse(boolean fireEvent)
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
TreeViewItem	disabled(boolean disabled)	Adds/removes modifier(disabled)
void	expand(boolean fireEvent)
TreeViewItem	expandedIcon(elemental2.dom.Element icon)
TreeViewItem	expandedIcon(PredefinedIcon icon)
<T> T	get(String key)	Retrieves the value associated with the given key from the ComponentContext.
boolean	has(String key)	Determines whether a value is stored with the specified key.
TreeViewItem	icon(elemental2.dom.Element icon)
String	identifier()	Retrieves the identifier associated with this component.
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()
elemental2.promise.Promise<Iterable<TreeViewItem>>	load()	Fetches items for the first time.
TreeViewItem	onAdd(AddItemHandler<TreeViewItem, TreeViewItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
TreeViewItem	onRemove(RemoveItemHandler<TreeViewItem, TreeViewItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
TreeViewItem	onToggle(ToggleHandler<TreeViewItem> toggleHandler)
TreeViewItem	onUpdate(UpdateItemHandler<TreeViewItem, TreeViewItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
TreeViewItem	parent()
elemental2.promise.Promise<Iterable<TreeViewItem>>	refresh()	Re-fetches items while keeping old items visible, then swaps them after the new items arrive.
TreeViewItem	removeIcon()
void	removeItem(String identifier)	Removes an item from the component based on the provided identifier.
void	reset()	Clears all items and sets status back to AsyncStatus.pending.
boolean	selected()
int	size()	Retrieves the total number of items currently contained in the component.
AsyncStatus	status()
<T> TreeViewItem	store(String key, T value)	Stores a value associated with a key.
String	text()
TreeViewItem	text(String text)
TreeViewItem	that()
static TreeViewItem	treeViewItem(String identifier)
static TreeViewItem	treeViewItem(String identifier, String text)
void	updateItem(TreeViewItem item)	Updates an existing item in the component.

Methods inherited from class SubComponent

element, ouiaComponentType, registerSubComponent

Methods inherited from class Object

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

Methods inherited from interface ComponentContext

get, get

Methods inherited from interface ComponentIcon

icon

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 Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface HasAsyncItems

addItems

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

Methods inherited from interface Modifiers.Compact

compact, compact

Methods inherited from interface Modifiers.Disabled

disabled, isDisabled

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Field Details

SUB_COMPONENT_ID

public static final String SUB_COMPONENT_ID

See Also:

• Constant Field Values

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

treeViewItem

public static TreeViewItem treeViewItem(String identifier)

treeViewItem

public static TreeViewItem treeViewItem(String identifier,
 String text)

add

public TreeViewItem add(TreeViewItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<elemental2.dom.HTMLLIElement, TreeViewItem, TreeViewItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

add

public TreeViewItem add(AsyncItems<TreeViewItem, TreeViewItem> items)

Specified by:

add in interface HasAsyncItems<TreeViewItem, TreeViewItem>

disabled

public TreeViewItem disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<elemental2.dom.HTMLLIElement, TreeViewItem>

text

public TreeViewItem text(String text)

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLLIElement, TreeViewItem>

icon

public TreeViewItem icon(elemental2.dom.Element icon)

Specified by:

icon in interface ComponentIcon<elemental2.dom.HTMLLIElement, TreeViewItem>

removeIcon

public TreeViewItem removeIcon()

Specified by:

removeIcon in interface ComponentIcon<elemental2.dom.HTMLLIElement, TreeViewItem>

expandedIcon

public TreeViewItem expandedIcon(PredefinedIcon icon)

expandedIcon

public TreeViewItem expandedIcon(elemental2.dom.Element icon)

store

public <T> TreeViewItem store(String key,
 T value)

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<elemental2.dom.HTMLLIElement, TreeViewItem>

Type Parameters:

T - the type of the value being stored

Parameters:

key - the key associated with the value

value - the value to be stored

that

public TreeViewItem that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLLIElement, TreeViewItem>

onAdd

public TreeViewItem onAdd(AddItemHandler<TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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 TreeViewItem onUpdate(UpdateItemHandler<TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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 TreeViewItem onRemove(RemoveItemHandler<TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, TreeViewItem>

Parameters:

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

Returns:

the builder instance after adding the callback

onToggle

public TreeViewItem onToggle(ToggleHandler<TreeViewItem> toggleHandler)

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLLIElement, TreeViewItem>

Returns:

the identifier of the component

parent

public TreeViewItem parent()

selected

public boolean selected()

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<elemental2.dom.HTMLLIElement, TreeViewItem>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<elemental2.dom.HTMLLIElement, TreeViewItem>

load

public elemental2.promise.Promise<Iterable<TreeViewItem>> load()

Description copied from interface: HasAsyncItems

Fetches items for the first time. Only runs when status is AsyncStatus.pending. Idempotent.

Specified by:

load in interface HasAsyncItems<TreeViewItem, TreeViewItem>

refresh

public elemental2.promise.Promise<Iterable<TreeViewItem>> refresh()

Description copied from interface: HasAsyncItems

Re-fetches items while keeping old items visible, then swaps them after the new items arrive.

Specified by:

refresh in interface HasAsyncItems<TreeViewItem, TreeViewItem>

reset

public void reset()

Description copied from interface: HasAsyncItems

Clears all items and sets status back to AsyncStatus.pending. Does not fetch.

Specified by:

reset in interface HasAsyncItems<TreeViewItem, TreeViewItem>

status

public AsyncStatus status()

Specified by:

status in interface HasAsyncItems<TreeViewItem, TreeViewItem>

has

public boolean has(String key)

Description copied from interface: ComponentContext

Determines whether a value is stored with the specified key.

Specified by:

has in interface ComponentContext<elemental2.dom.HTMLLIElement, TreeViewItem>

Parameters:

key - the key to check

Returns:

true if a value is stored with the specified key, false otherwise

get

public <T> T get(String key)

Description copied from interface: ComponentContext

Retrieves the value associated with the given key from the ComponentContext.

Specified by:

get in interface ComponentContext<elemental2.dom.HTMLLIElement, TreeViewItem>

Type Parameters:

T - the type of the value being retrieved

Parameters:

key - the key associated with the value

Returns:

the value associated with the key, or null if no value is found

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<elemental2.dom.HTMLLIElement, TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, 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<elemental2.dom.HTMLLIElement, TreeViewItem, TreeViewItem>

text

public String text()

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLLIElement, TreeViewItem>