Class MenuList

java.lang.Object

org.patternfly.component.SubComponent<HTMLUListElement, MenuList>

org.patternfly.component.menu.MenuList

All Implemented Interfaces:

Iterable<MenuItem>, Attachable, ElementAttributeMethods<HTMLUListElement, MenuList>, ElementClassListMethods<HTMLUListElement, MenuList>, ElementConsumerMethods<HTMLUListElement, MenuList>, ElementContainerMethods<HTMLUListElement, MenuList>, ElementEventMethods<HTMLUListElement, MenuList>, ElementIdMethods<HTMLUListElement, MenuList>, ElementQueryMethods<HTMLUListElement>, HTMLElementAttributeMethods<HTMLUListElement, MenuList>, HTMLElementDataMethods<HTMLUListElement, MenuList>, HTMLElementStyleMethods<HTMLUListElement, MenuList>, HTMLElementVisibilityMethods<HTMLUListElement, MenuList>, IsElement<HTMLUListElement>, TypedBuilder<HTMLUListElement, MenuList>, HasItems<HTMLUListElement, MenuList, MenuItem>, Ordered<HTMLUListElement, MenuList, MenuItem>

public class MenuList
extends SubComponent<HTMLUListElement, MenuList>
implements Ordered<HTMLUListElement, MenuList, MenuItem>, Attachable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_NAME

Fields inherited from interface org.patternfly.component.Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
MenuList	add(AsyncItems<MenuList,MenuItem> items)
MenuList	add(MenuItem item)
MenuList	addDivider()
MenuList	addItems(AsyncItems<MenuList,MenuItem> items)
void	attach(MutationRecord mutationRecord)
void	clear()
Comparator<MenuItem>	comparator()	Retrieves the comparator used for ordering elements in a component.
boolean	contains(String identifier)
boolean	isEmpty()
MenuItem	item(String identifier)
Iterator<MenuItem>	iterator()
Promise<Iterable<MenuItem>>	load()
static MenuList	menuList()	Creates a new menu list component.
MenuList	onAdd(BiConsumer<MenuList,MenuItem> onAdd)
MenuList	onRemove(BiConsumer<MenuList,MenuItem> onRemove)
MenuList	ordered(Comparator<MenuItem> comparator)	Orders the elements contained in the component using the specified comparator.
Promise<Iterable<MenuItem>>	reload()
void	removeItem(String identifier)
void	reset()
int	size()
AsyncStatus	status()
MenuList	that()

Methods inherited from class org.patternfly.component.SubComponent

element, registerSubComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.Attachable

detach

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.HasItems

addItem, addItems, items

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.patternfly.component.Ordered

addOrdered, defaultOrder, ordered

Field Details

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

menuList

public static MenuList menuList()

Creates a new menu list component.

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

add

public MenuList add(MenuItem item)

Specified by:

add in interface HasItems<HTMLUListElement, MenuList, MenuItem>

addItems

public MenuList addItems(AsyncItems<MenuList,MenuItem> items)

add

public MenuList add(AsyncItems<MenuList,MenuItem> items)

addDivider

public MenuList addDivider()

ordered

public MenuList ordered(Comparator<MenuItem> comparator)

Description copied from interface: Ordered

Orders the elements contained in the component using the specified comparator. The comparator determines the order in which the elements are arranged.

Specified by:

ordered in interface Ordered<HTMLUListElement, MenuList, MenuItem>

Parameters:

comparator - the comparator used to define the ordering of the elements

Returns:

the builder instance with the elements ordered

that

public MenuList that()

Specified by:

that in interface TypedBuilder<HTMLUListElement, MenuList>

onAdd

public MenuList onAdd(BiConsumer<MenuList,MenuItem> onAdd)

Specified by:

onAdd in interface HasItems<HTMLUListElement, MenuList, MenuItem>

onRemove

public MenuList onRemove(BiConsumer<MenuList,MenuItem> onRemove)

Specified by:

onRemove in interface HasItems<HTMLUListElement, MenuList, MenuItem>

comparator

public Comparator<MenuItem> comparator()

Description copied from interface: Ordered

Retrieves the comparator used for ordering elements in a component.

Specified by:

comparator in interface Ordered<HTMLUListElement, MenuList, MenuItem>

Returns:

the comparator that determines the order of elements

load

public Promise<Iterable<MenuItem>> load()

reset

public void reset()

reload

public Promise<Iterable<MenuItem>> reload()

status

public AsyncStatus status()

iterator

public Iterator<MenuItem> iterator()

Specified by:

iterator in interface Iterable<MenuItem>

size

public int size()

Specified by:

size in interface HasItems<HTMLUListElement, MenuList, MenuItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLUListElement, MenuList, MenuItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLUListElement, MenuList, MenuItem>

item

public MenuItem item(String identifier)

Specified by:

item in interface HasItems<HTMLUListElement, MenuList, MenuItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLUListElement, MenuList, MenuItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLUListElement, MenuList, MenuItem>