Class NavigationItem

java.lang.Object

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

org.patternfly.component.navigation.NavigationItem

All Implemented Interfaces:

ElementAttributeMethods<elemental2.dom.HTMLLIElement, NavigationItem>, ElementClassListMethods<elemental2.dom.HTMLLIElement, NavigationItem>, ElementConsumerMethods<elemental2.dom.HTMLLIElement, NavigationItem>, ElementContainerDelegate<elemental2.dom.HTMLLIElement, NavigationItem>, ElementContainerMethods<elemental2.dom.HTMLLIElement, NavigationItem>, ElementEventMethods<elemental2.dom.HTMLLIElement, NavigationItem>, ElementIdMethods<elemental2.dom.HTMLLIElement, NavigationItem>, ElementQueryMethods<elemental2.dom.HTMLLIElement>, ElementTextDelegate<elemental2.dom.HTMLLIElement, NavigationItem>, ElementTextMethods<elemental2.dom.HTMLLIElement, NavigationItem>, HTMLElementAttributeMethods<elemental2.dom.HTMLLIElement, NavigationItem>, HTMLElementDataMethods<elemental2.dom.HTMLLIElement, NavigationItem>, HTMLElementStyleMethods<elemental2.dom.HTMLLIElement, NavigationItem>, HTMLElementVisibilityMethods<elemental2.dom.HTMLLIElement, NavigationItem>, IsElement<elemental2.dom.HTMLLIElement>, TypedBuilder<elemental2.dom.HTMLLIElement, NavigationItem>, ComponentIcon<elemental2.dom.HTMLLIElement, NavigationItem>, ComponentContext<elemental2.dom.HTMLLIElement, NavigationItem>, HasIdentifier<elemental2.dom.HTMLLIElement, NavigationItem>, OuiaSupport<elemental2.dom.HTMLLIElement, NavigationItem>

public class NavigationItem
extends SubComponent<elemental2.dom.HTMLLIElement, NavigationItem>
implements ComponentContext<elemental2.dom.HTMLLIElement, NavigationItem>, ComponentIcon<elemental2.dom.HTMLLIElement, NavigationItem>, ElementContainerDelegate<elemental2.dom.HTMLLIElement, NavigationItem>, ElementTextDelegate<elemental2.dom.HTMLLIElement, NavigationItem>, HasIdentifier<elemental2.dom.HTMLLIElement, NavigationItem>

A navigation item 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
NavigationItem	ariaLabel(String label)
elemental2.dom.Element	containerDelegate()
<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.
NavigationItem	href(String href)
NavigationItem	icon(elemental2.dom.Element icon)
String	identifier()	Retrieves the identifier associated with this component.
static NavigationItem	navigationItem(String identifier)
static NavigationItem	navigationItem(String identifier, String text)
static NavigationItem	navigationItem(String identifier, String text, String href)
NavigationItem	onClick(ComponentHandler<NavigationItem> handler)
NavigationItem	removeIcon()
<T> NavigationItem	store(String key, T value)	Stores a value associated with a key.
elemental2.dom.Element	textDelegate()
NavigationItem	that()

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

navigationItem

public static NavigationItem navigationItem(String identifier)

navigationItem

public static NavigationItem navigationItem(String identifier,
 String text)

navigationItem

public static NavigationItem navigationItem(String identifier,
 String text,
 String href)

containerDelegate

public elemental2.dom.Element containerDelegate()

Specified by:

containerDelegate in interface ElementContainerDelegate<elemental2.dom.HTMLLIElement, NavigationItem>

textDelegate

public elemental2.dom.Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<elemental2.dom.HTMLLIElement, NavigationItem>

href

public NavigationItem href(String href)

icon

public NavigationItem icon(elemental2.dom.Element icon)

Specified by:

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

removeIcon

public NavigationItem removeIcon()

Specified by:

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

ariaLabel

public NavigationItem ariaLabel(String label)

store

public <T> NavigationItem 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, NavigationItem>

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

Specified by:

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

onClick

public NavigationItem onClick(ComponentHandler<NavigationItem> handler)

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

Returns:

the identifier of the component

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

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

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