Class BreadcrumbItem

java.lang.Object

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

org.patternfly.component.breadcrumb.BreadcrumbItem

All Implemented Interfaces:

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

public class BreadcrumbItem
extends SubComponent<elemental2.dom.HTMLLIElement, BreadcrumbItem>
implements ComponentContext<elemental2.dom.HTMLLIElement, BreadcrumbItem>, ElementTextDelegate<elemental2.dom.HTMLLIElement, BreadcrumbItem>, HasIdentifier<elemental2.dom.HTMLLIElement, BreadcrumbItem>

An item in a Breadcrumb component representing a level in the navigation hierarchy.

See Also:

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

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
BreadcrumbItem	active()
BreadcrumbItem	active(boolean active)
static BreadcrumbItem	breadcrumbItem(String identifier, String text)
static BreadcrumbItem	breadcrumbItem(String identifier, String text, String href)
static BreadcrumbItem	breadcrumbItem(String identifier, String text, String href, String target)
<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.
BreadcrumbItem	href(String href)
String	identifier()	Retrieves the identifier associated with this component.
BreadcrumbItem	onClick(ComponentHandler<BreadcrumbItem> actionHandler)
<T> BreadcrumbItem	store(String key, T value)	Stores a value associated with a key.
BreadcrumbItem	target(String target)
elemental2.dom.Element	textDelegate()
BreadcrumbItem	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 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 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

breadcrumbItem

public static BreadcrumbItem breadcrumbItem(String identifier,
 String text)

breadcrumbItem

public static BreadcrumbItem breadcrumbItem(String identifier,
 String text,
 String href)

breadcrumbItem

public static BreadcrumbItem breadcrumbItem(String identifier,
 String text,
 String href,
 String target)

textDelegate

public elemental2.dom.Element textDelegate()

Specified by:

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

active

public BreadcrumbItem active()

active

public BreadcrumbItem active(boolean active)

href

public BreadcrumbItem href(String href)

target

public BreadcrumbItem target(String target)

store

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

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

Specified by:

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

onClick

public BreadcrumbItem onClick(ComponentHandler<BreadcrumbItem> actionHandler)

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

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

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

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