Package org.patternfly.component.menu

Class Menu

java.lang.Object

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

org.patternfly.component.menu.Menu

All Implemented Interfaces:

Container<HTMLDivElement,Menu>, Finder<HTMLDivElement>, HasElement<HTMLDivElement,Menu>, HasHTMLElement<HTMLDivElement,Menu>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement,Menu>, Component, Modifiers.Plain<HTMLDivElement,Menu>

Direct Known Subclasses:

DropdownMenu, SingleSelectMenu

public class Menu
extends BaseComponent<HTMLDivElement,Menu>
implements 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.actionMenuItem("1", "Item 1"))
                        .addItem(MenuItem.actionMenuItem("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	addSearchInput(MenuSearchInput searchInput)
Menu	addSearchInput(MenuSearchInput searchInput, boolean noSeparator)
Menu	favorites()
Menu	flyout()
Menu	height(String height)	Sets the --pf-v5-c-menu__content--MaxHeight variable to the specified value
static Menu	menu(MenuType menuType, SelectionMode selectionMode)
static Menu	menu(SelectionMode selectionMode)
Menu	onAction(MenuActionHandler actionHandler)
Menu	onMultiSelect(MultiSelectHandler<Menu,MenuItem> selectHandler)
Menu	onSingleSelect(SelectHandler<MenuItem> selectHandler)
Menu	scrollable()
void	select(String itemId)
void	select(String itemId, boolean selected)
void	select(String itemId, boolean selected, boolean fireEvent)
void	select(MenuItem item)
void	select(MenuItem item, boolean selected)
void	select(MenuItem item, boolean selected, boolean fireEvent)
Menu	that()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.Container

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

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, innerHtml, on, on, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.style.Modifiers.Plain

plain, plain

Method Details

menu

public static Menu menu(SelectionMode selectionMode)

menu

public static Menu menu(MenuType menuType,
 SelectionMode selectionMode)

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)

addSearchInput

public Menu addSearchInput(MenuSearchInput searchInput)

addSearchInput

public Menu addSearchInput(MenuSearchInput searchInput,
 boolean noSeparator)

addDivider

public Menu addDivider()

flyout

public Menu flyout()

scrollable

public Menu scrollable()

favorites

public Menu favorites()

height

public Menu height(String height)

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

that

public Menu that()

Specified by:

that in interface TypedBuilder<HTMLDivElement,Menu>

onSingleSelect

public Menu onSingleSelect(SelectHandler<MenuItem> selectHandler)

onMultiSelect

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

onAction

public Menu onAction(MenuActionHandler actionHandler)

select

public void select(String itemId)

select

public void select(String itemId,
 boolean selected)

select

public void select(String itemId,
 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)