Class Navigation

java.lang.Object

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

org.patternfly.component.navigation.Navigation

All Implemented Interfaces:

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

public class Navigation
extends BaseComponent<HTMLElement, Navigation>
implements HasItems<HTMLElement, Navigation, NavigationItem>, Attachable

A navigation organizes an application's structure and content, making it easy to find information and accomplish tasks. Navigation communicates relationships, context, and actions a user can take within an application.

navigation(primary)
        .addItem(navigationItem("itm-1", "Item 1", "#itm-1"))
        .addItem(navigationItem("itm-2", "Item 2", "#itm-2"))
        .addItem(navigationItem("itm-3", "Item 3", "#itm-3"));

navigation(grouped)
        .addGroup(navigationGroup("grp-1", "Group 1")
                .addItem(navigationItem("grp-1-itm-1", "Item 1", "#grp-1-itm-1"))
                .addItem(navigationItem("grp-1-itm-2", "Item 2", "#grp-1-itm-2"))
                .addItem(navigationItem("grp-1-itm-3", "Item 3", "#grp-1-itm-3")))
        .addGroup(navigationGroup("grp-2", "Group 2")
                .addItem(navigationItem("grp-2-itm-1", "Item 1", "#grp-2-itm-1"))
                .addItem(navigationItem("grp-2-itm-2", "Item 2", "#grp-2-itm-2"))
                .addDivider()
                .addItem(navigationItem("grp-2-itm-3", "Item 3", "#grp-2-itm-3")));

navigation(expandable)
        .addItem(navigationItem("itm-1", "Item 1", "#itm-1"))
        .addDivider()
        .addGroup(expandableNavigationGroup("grp-1", "Group 1")
                .addItem(navigationItem("grp-1-itm-1", "Item 1", "#grp-1-itm-1"))
                .addItem(navigationItem("grp-1-itm-2", "Item 2", "#grp-1-itm-2"))
                .addDivider()
                .addItem(navigationItem("grp-1-itm-3", "Item 3", "#grp-1-itm-3")))
        .addItem(navigationItem("itm-2", "Item 2", "#itm-2"))
        .addItem(navigationItem("itm-3", "Item 3", "#itm-3"))
        .addGroup(expandableNavigationGroup("grp-2", "Group 2")
                .addItem(navigationItem("grp-2-itm-1", "Item 1", "#grp-2-itm-1"))
                .addItem(navigationItem("grp-2-itm-2", "Item 2", "#grp-2-itm-2"))
                .addGroup(expandableNavigationGroup("nested-grp-1", "Nested Group")
                        .addItem(navigationItem("nested-grp-1-itm-1", "Item 1", "#nested-grp-1-itm-1"))
                        .addDivider()
                        .addItem(navigationItem("nested-grp-1-itm-2", "Item 2", "#nested-grp-1-itm-2"))));

See Also:

• https://www.patternfly.org/components/navigation

Method Summary

Modifier and Type	Method	Description
Navigation	add(Divider divider)
Navigation	add(ExpandableNavigationGroup group)
Navigation	add(NavigationGroup group)
Navigation	add(NavigationItem item)	Adds an item to the component.
Navigation	addDivider()
Navigation	addGroup(ExpandableNavigationGroup group)
Navigation	addGroup(NavigationGroup group)
Navigation	addItem(NavigationItem item)	Adds a single item to the component.
<T> Navigation	addItems(Iterable<T> items, Function<T, NavigationItem> display)	Adds a collection of items to the component.
Navigation	ariaScrollBackLabel(String label)	Aria-label for the back scroll button
Navigation	ariaScrollForwardLabel(String label)	Aria-label for the forward scroll button
void	attach(MutationRecord mutationRecord)
void	clear()	Clears all items from the component.
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
void	detach(MutationRecord mutationRecord)
Navigation	insertGroupAfter(ExpandableNavigationGroup group, String afterIdentifier)
Navigation	insertGroupAfter(NavigationGroup group, String afterIdentifier)
Navigation	insertGroupBefore(ExpandableNavigationGroup group, String beforeIdentifier)
Navigation	insertGroupBefore(NavigationGroup group, String beforeIdentifier)
Navigation	insertItemAfter(NavigationItem item, String afterIdentifier)
Navigation	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 Navigation	navigation(NavigationType type)
Navigation	onAdd(AddItemHandler<Navigation, NavigationItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
Navigation	onRemove(RemoveItemHandler<Navigation, NavigationItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
Navigation	onSelect(SelectHandler<NavigationItem> selectHandler)
Navigation	onToggle(ToggleHandler<ExpandableNavigationGroup> toggleHandler)
Navigation	onUpdate(UpdateItemHandler<Navigation, 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.
void	select(String itemId)
void	select(String itemId, boolean fireEvent)
void	select(NavigationItem item)
void	select(NavigationItem item, boolean fireEvent)
int	size()	Retrieves the total number of items currently contained in the component.
Navigation	that()
void	updateItem(NavigationItem 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

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

navigation

public static Navigation navigation(NavigationType 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

addItems

public <T> Navigation addItems(Iterable<T> items,
 Function<T, NavigationItem> display)

Description copied from interface: HasItems

Adds a collection of items to the component. The method applies the provided function to each item in the given iterable to transform it into a subcomponent, which is then added to the component.

Specified by:

addItems in interface HasItems<HTMLElement, Navigation, NavigationItem>

Type Parameters:

T - the type of the items in the iterable

Parameters:

items - the iterable collection of items to be added

display - the function used to transform each item into a subcomponent

Returns:

the builder instance after adding the items

addItem

public Navigation addItem(NavigationItem item)

Description copied from interface: HasItems

Adds a single item to the component.

Specified by:

addItem in interface HasItems<HTMLElement, Navigation, NavigationItem>

Parameters:

item - the item to be added

Returns:

the builder instance after adding the item

add

public Navigation add(NavigationItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, Navigation, NavigationItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

addGroup

public Navigation addGroup(NavigationGroup group)

add

public Navigation add(NavigationGroup group)

addGroup

public Navigation addGroup(ExpandableNavigationGroup group)

add

public Navigation add(ExpandableNavigationGroup group)

addDivider

public Navigation addDivider()

add

public Navigation add(Divider divider)

insertItemBefore

public Navigation insertItemBefore(NavigationItem item,
 String beforeIdentifier)

insertItemAfter

public Navigation insertItemAfter(NavigationItem item,
 String afterIdentifier)

insertGroupBefore

public Navigation insertGroupBefore(NavigationGroup group,
 String beforeIdentifier)

insertGroupAfter

public Navigation insertGroupAfter(NavigationGroup group,
 String afterIdentifier)

insertGroupBefore

public Navigation insertGroupBefore(ExpandableNavigationGroup group,
 String beforeIdentifier)

insertGroupAfter

public Navigation insertGroupAfter(ExpandableNavigationGroup group,
 String afterIdentifier)

that

public Navigation that()

Specified by:

that in interface TypedBuilder<HTMLElement, Navigation>

ariaScrollBackLabel

public Navigation ariaScrollBackLabel(String label)

Aria-label for the back scroll button

ariaScrollForwardLabel

public Navigation ariaScrollForwardLabel(String label)

Aria-label for the forward scroll button

onAdd

public Navigation onAdd(AddItemHandler<Navigation, 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<HTMLElement, Navigation, 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

onRemove

public Navigation onRemove(RemoveItemHandler<Navigation, 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<HTMLElement, Navigation, NavigationItem>

Parameters:

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

Returns:

the builder instance after adding the callback

onSelect

public Navigation onSelect(SelectHandler<NavigationItem> selectHandler)

onUpdate

public Navigation onUpdate(UpdateItemHandler<Navigation, 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<HTMLElement, Navigation, 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

onToggle

public Navigation onToggle(ToggleHandler<ExpandableNavigationGroup> toggleHandler)

select

public void select(String itemId)

select

public void select(String itemId,
 boolean fireEvent)

select

public void select(NavigationItem item)

select

public void select(NavigationItem item,
 boolean fireEvent)

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<HTMLElement, Navigation, 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<HTMLElement, Navigation, 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<HTMLElement, Navigation, 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<HTMLElement, Navigation, 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<HTMLElement, Navigation, 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<HTMLElement, Navigation, 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<HTMLElement, Navigation, NavigationItem>