Class Menu

java.lang.Object

org.patternfly.component.BaseComponent<HTMLDivElement, Menu>

org.patternfly.component.menu.Menu

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLDivElement, Menu>, ElementClassListMethods<HTMLDivElement, Menu>, ElementConsumerMethods<HTMLDivElement, Menu>, ElementContainerMethods<HTMLDivElement, Menu>, ElementEventMethods<HTMLDivElement, Menu>, ElementIdMethods<HTMLDivElement, Menu>, ElementQueryMethods<HTMLDivElement>, HTMLElementAttributeMethods<HTMLDivElement, Menu>, HTMLElementDataMethods<HTMLDivElement, Menu>, HTMLElementStyleMethods<HTMLDivElement, Menu>, HTMLElementVisibilityMethods<HTMLDivElement, Menu>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement, Menu>, Component, Modifiers.Plain<HTMLDivElement, Menu>

Direct Known Subclasses:

DropdownMenu, MultiSelectMenu, SingleSelectMenu

public class Menu
extends BaseComponent<HTMLDivElement, Menu>
implements Attachable, Modifiers.Plain<HTMLDivElement, Menu>

A menu is a list of options or actions that users can choose from. It can be used in a variety of contexts whenever the user needs to choose between multiple values, options, or actions. A menu is most often paired with a MenuToggle as its trigger, but can also be used inline or can be attached to other interactable elements to toggle it open and close.

Menu menu = menu(MenuType.menu, click)
        .scrollable()
        .height("200px")
        .addHeader("Header")
        .addContent(menuContent()
                .addList(menuList()
                        .addItem(MenuItem.menuItem("1", "Item 1"))
                        .addItem(MenuItem.menuItem("2", "Item 2"))
                        .addDivider()
                        .addItem(MenuItem.linkMenuItem("3", "Item 3", "#third"))))
        .addFooter(menuFooter()
                .add(button("Footer")));

See Also:

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

Method Summary

Modifier and Type	Method	Description
Menu	add(MenuContent content)
Menu	addContent(MenuContent content)
Menu	addDivider()
Menu	addFooter(String text)	Shortcut for addFooter(menuFooter(text))
Menu	addFooter(MenuFooter footer)
Menu	addHeader(String text)	Shortcut for addHeader(menuHeader(text))
Menu	addHeader(MenuHeader header)
Menu	addSearch(MenuSearch search)
void	allowTabFirstItem()	Sets the `tabIndex` property of the first focusable item within a menu to `0`, allowing it to be reachable via the Tab key.
void	attach(MutationRecord mutationRecord)
void	detach(MutationRecord mutationRecord)
Menu	favorites()
MenuItem	findItem(String identifier)
Menu	flyout()
boolean	hasAsyncItems()	Checks if the menu contains any asynchronous items that are currently in a pending status.
Menu	height(String height)	Sets the --pf-v5-c-menu__content--MaxHeight variable to the specified value
List<MenuItem>	items()
static Menu	menu(MenuType menuType, SelectionMode selectionMode)
Menu	onAction(MenuActionHandler actionHandler)
Menu	onMultiSelect(MultiSelectHandler<Menu,MenuItem> selectHandler)
Menu	onSingleSelect(SelectHandler<MenuItem> selectHandler)
void	reload()
Menu	scrollable()
void	select(String identifier)
void	select(String identifier, boolean selected)
void	select(String identifier, boolean selected, boolean fireEvent)
void	select(MenuItem item)
void	select(MenuItem item, boolean selected)
void	select(MenuItem item, boolean selected, boolean fireEvent)
List<MenuItem>	selectedItems()
Menu	that()

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 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 Modifiers.Plain

plain, plain

Method Details

menu

public static Menu menu(MenuType menuType,
 SelectionMode selectionMode)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addHeader

public Menu addHeader(String text)

Shortcut for addHeader(menuHeader(text))

addHeader

public Menu addHeader(MenuHeader header)

addContent

public Menu addContent(MenuContent content)

add

public Menu add(MenuContent content)

addFooter

public Menu addFooter(String text)

Shortcut for addFooter(menuFooter(text))

addFooter

public Menu addFooter(MenuFooter footer)

addSearch

public Menu addSearch(MenuSearch search)

addDivider

public Menu addDivider()

favorites

public Menu favorites()

flyout

public Menu flyout()

height

public Menu height(String height)

Sets the --pf-v5-c-menu__content--MaxHeight variable to the specified value

scrollable

public Menu scrollable()

that

public Menu that()

Specified by:

that in interface TypedBuilder<HTMLDivElement, Menu>

onAction

public Menu onAction(MenuActionHandler actionHandler)

onSingleSelect

public Menu onSingleSelect(SelectHandler<MenuItem> selectHandler)

onMultiSelect

public Menu onMultiSelect(MultiSelectHandler<Menu,MenuItem> selectHandler)

allowTabFirstItem

public void allowTabFirstItem()

Sets the `tabIndex` property of the first focusable item within a menu to `0`, allowing it to be reachable via the Tab key. Focusable items are identified as non-disabled `

findItem

public MenuItem findItem(String identifier)

hasAsyncItems

public boolean hasAsyncItems()

Checks if the menu contains any asynchronous items that are currently in a pending status. This method inspects the menu lists to determine if any status is pending.

Returns:

true if any MenuList has a status of pending, otherwise false.

items

public List<MenuItem> items()

reload

public void reload()

select

public void select(String identifier)

select

public void select(String identifier,
 boolean selected)

select

public void select(String identifier,
 boolean selected,
 boolean fireEvent)

select

public void select(MenuItem item)

select

public void select(MenuItem item,
 boolean selected)

select

public void select(MenuItem item,
 boolean selected,
 boolean fireEvent)

selectedItems

public List<MenuItem> selectedItems()