Class NavigationGroup

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLElement, NavigationGroup>

org.patternfly.component.navigation.NavigationGroup

All Implemented Interfaces:

Iterable<NavigationItem>, ElementAttributeMethods<elemental2.dom.HTMLElement, NavigationGroup>, ElementClassListMethods<elemental2.dom.HTMLElement, NavigationGroup>, ElementConsumerMethods<elemental2.dom.HTMLElement, NavigationGroup>, ElementContainerDelegate<elemental2.dom.HTMLElement, NavigationGroup>, ElementContainerMethods<elemental2.dom.HTMLElement, NavigationGroup>, ElementEventMethods<elemental2.dom.HTMLElement, NavigationGroup>, ElementIdMethods<elemental2.dom.HTMLElement, NavigationGroup>, ElementQueryMethods<elemental2.dom.HTMLElement>, ElementTextDelegate<elemental2.dom.HTMLElement, NavigationGroup>, ElementTextMethods<elemental2.dom.HTMLElement, NavigationGroup>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, NavigationGroup>, HTMLElementDataMethods<elemental2.dom.HTMLElement, NavigationGroup>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, NavigationGroup>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, NavigationGroup>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, NavigationGroup>, HasIdentifier<elemental2.dom.HTMLElement, NavigationGroup>, HasItems<elemental2.dom.HTMLElement, NavigationGroup, NavigationItem>, OuiaSupport<elemental2.dom.HTMLElement, NavigationGroup>

public class NavigationGroup
extends SubComponent<elemental2.dom.HTMLElement, NavigationGroup>
implements ElementContainerDelegate<elemental2.dom.HTMLElement, NavigationGroup>, ElementTextDelegate<elemental2.dom.HTMLElement, NavigationGroup>, HasIdentifier<elemental2.dom.HTMLElement, NavigationGroup>, HasItems<elemental2.dom.HTMLElement, NavigationGroup, NavigationItem>

A navigation group within a Navigation 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
NavigationGroup	add(Divider divider)
NavigationGroup	add(NavigationItem item)	Adds an item to the component.
NavigationGroup	addDivider()
NavigationGroup	addGroup(ExpandableNavigationGroup group)
NavigationGroup	ariaLabel(String label)
void	clear()	Clears all items from the component.
elemental2.dom.Element	containerDelegate()
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
String	identifier()	Retrieves the identifier associated with this component.
NavigationGroup	insertItemAfter(NavigationItem item, String afterIdentifier)
NavigationGroup	insertItemBefore(NavigationItem item, String beforeIdentifier)
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
NavigationItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<NavigationItem>	iterator()
static NavigationGroup	navigationGroup(String identifier)
static NavigationGroup	navigationGroup(String identifier, String text)
NavigationGroup	onAdd(AddItemHandler<NavigationGroup, NavigationItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
NavigationGroup	onRemove(RemoveItemHandler<NavigationGroup, NavigationItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
NavigationGroup	onUpdate(UpdateItemHandler<NavigationGroup, NavigationItem> 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.
int	size()	Retrieves the total number of items currently contained in the component.
elemental2.dom.Element	textDelegate()
NavigationGroup	that()
void	updateItem(NavigationItem 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 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 ElementContainerDelegate

add, add, add

Methods inherited from interface ElementContainerMethods

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 ElementTextDelegate

text, text

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 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

navigationGroup

public static NavigationGroup navigationGroup(String identifier)

navigationGroup

public static NavigationGroup navigationGroup(String identifier,
 String text)

containerDelegate

public elemental2.dom.Element containerDelegate()

Specified by:

containerDelegate in interface ElementContainerDelegate<elemental2.dom.HTMLElement, NavigationGroup>

textDelegate

public elemental2.dom.Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<elemental2.dom.HTMLElement, NavigationGroup>

add

public NavigationGroup add(NavigationItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<elemental2.dom.HTMLElement, NavigationGroup, NavigationItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

addDivider

public NavigationGroup addDivider()

add

public NavigationGroup add(Divider divider)

addGroup

public NavigationGroup addGroup(ExpandableNavigationGroup group)

insertItemBefore

public NavigationGroup insertItemBefore(NavigationItem item,
 String beforeIdentifier)

insertItemAfter

public NavigationGroup insertItemAfter(NavigationItem item,
 String afterIdentifier)

ariaLabel

public NavigationGroup ariaLabel(String label)

that

public NavigationGroup that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLElement, NavigationGroup>

onAdd

public NavigationGroup onAdd(AddItemHandler<NavigationGroup, NavigationItem> 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.HTMLElement, NavigationGroup, NavigationItem>

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 NavigationGroup onUpdate(UpdateItemHandler<NavigationGroup, NavigationItem> 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.HTMLElement, NavigationGroup, NavigationItem>

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 NavigationGroup onRemove(RemoveItemHandler<NavigationGroup, NavigationItem> 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.HTMLElement, NavigationGroup, NavigationItem>

Parameters:

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

Returns:

the builder instance after adding the callback

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLElement, NavigationGroup>

Returns:

the identifier of the component

iterator

public Iterator<NavigationItem> iterator()

Specified by:

iterator in interface Iterable<NavigationItem>

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.HTMLElement, NavigationGroup, NavigationItem>

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.HTMLElement, NavigationGroup, NavigationItem>

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.HTMLElement, NavigationGroup, NavigationItem>

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 NavigationItem 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.HTMLElement, NavigationGroup, NavigationItem>

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(NavigationItem item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<elemental2.dom.HTMLElement, NavigationGroup, NavigationItem>

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.HTMLElement, NavigationGroup, NavigationItem>

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.HTMLElement, NavigationGroup, NavigationItem>