Class MenuItem

java.lang.Object

org.patternfly.component.SubComponent<HTMLElement, MenuItem>

org.patternfly.component.menu.MenuItem

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLElement, MenuItem>, ElementClassListMethods<HTMLElement, MenuItem>, ElementConsumerMethods<HTMLElement, MenuItem>, ElementContainerMethods<HTMLElement, MenuItem>, ElementEventMethods<HTMLElement, MenuItem>, ElementIdMethods<HTMLElement, MenuItem>, ElementQueryMethods<HTMLElement>, ElementTextDelegate<HTMLElement, MenuItem>, ElementTextMethods<HTMLElement, MenuItem>, HTMLElementAttributeMethods<HTMLElement, MenuItem>, HTMLElementDataMethods<HTMLElement, MenuItem>, HTMLElementStyleMethods<HTMLElement, MenuItem>, HTMLElementVisibilityMethods<HTMLElement, MenuItem>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, MenuItem>, ComponentIcon<HTMLElement, MenuItem>, ComponentIconAndText<HTMLElement, MenuItem>, HasIdentifier<HTMLElement, MenuItem>, ComponentContext<HTMLElement, MenuItem>, Modifiers.Disabled<HTMLElement, MenuItem>

public class MenuItem
extends SubComponent<HTMLElement, MenuItem>
implements Attachable, ComponentContext<HTMLElement, MenuItem>, ComponentIcon<HTMLElement, MenuItem>, ComponentIconAndText<HTMLElement, MenuItem>, Modifiers.Disabled<HTMLElement, MenuItem>, ElementTextDelegate<HTMLElement, MenuItem>, HasIdentifier<HTMLElement, MenuItem>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
MenuItem	add(MenuItemAction itemAction)
MenuItem	addAction(MenuItemAction itemAction)
MenuItem	ariaDisabled()
MenuItem	ariaDisabled(boolean ariaDisabled)
static MenuItem	asyncMenuItem(String identifier, String text, AsyncItems<MenuList,MenuItem> loadItems)
void	attach(MutationRecord mutationRecord)
static MenuItem	checkboxMenuItem(String identifier, String text)	Create a new menu item with type MenuItemType.link.
MenuItem	danger()
MenuItem	description(HTMLElement element)
MenuItem	description(String description)
MenuItem	disabled(boolean disabled)	Adds/removes modifier(disabled)
MenuItem	external()
<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.
MenuItem	href(String href)
MenuItem	icon(Element icon)
MenuItem	iconAndText(Element icon, String text, IconPosition iconPosition)
String	identifier()	Retrieves the identifier associated with this component.
static MenuItem	linkMenuItem(String identifier, String text, String href)	Create a new menu item with type MenuItemType.link.
static MenuItem	menuItem(String identifier)	Create a new menu item with type MenuItemType.action.
static MenuItem	menuItem(String identifier, String text)	Create a new menu item with type MenuItemType.action.
MenuItem	onClick(ComponentHandler<MenuItem> handler)	Registers an event handler to be invoked when the menu item is clicked.
MenuItem	removeIcon()
MenuItem	selected()
static MenuItem	skeletonMenuItem(String identifier, String loading)
<T> MenuItem	store(String key, T value)	Stores a value associated with a key.
MenuItem	text(HTMLElement element)
Element	textDelegate()
MenuItem	that()

Methods inherited from class SubComponent

element, registerSubComponent

Methods inherited from class Object

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

Methods inherited from interface Attachable

detach

Methods inherited from interface ComponentContext

get, get

Methods inherited from interface ComponentIcon

icon

Methods inherited from interface ComponentIconAndText

iconAndText, iconAndText

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

disabled, isDisabled

Field Details

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

menuItem

public static MenuItem menuItem(String identifier)

Create a new menu item with type MenuItemType.action.

menuItem

public static MenuItem menuItem(String identifier,
 String text)

Create a new menu item with type MenuItemType.action.

linkMenuItem

public static MenuItem linkMenuItem(String identifier,
 String text,
 String href)

Create a new menu item with type MenuItemType.link.

checkboxMenuItem

public static MenuItem checkboxMenuItem(String identifier,
 String text)

Create a new menu item with type MenuItemType.link.

asyncMenuItem

public static MenuItem asyncMenuItem(String identifier,
 String text,
 AsyncItems<MenuList,MenuItem> loadItems)

skeletonMenuItem

public static MenuItem skeletonMenuItem(String identifier,
 String loading)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

textDelegate

public Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<HTMLElement, MenuItem>

addAction

public MenuItem addAction(MenuItemAction itemAction)

add

public MenuItem add(MenuItemAction itemAction)

ariaDisabled

public MenuItem ariaDisabled()

ariaDisabled

public MenuItem ariaDisabled(boolean ariaDisabled)

danger

public MenuItem danger()

disabled

public MenuItem disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLElement, MenuItem>

description

public MenuItem description(String description)

description

public MenuItem description(HTMLElement element)

external

public MenuItem external()

href

public MenuItem href(String href)

icon

public MenuItem icon(Element icon)

Specified by:

icon in interface ComponentIcon<HTMLElement, MenuItem>

iconAndText

public MenuItem iconAndText(Element icon,
 String text,
 IconPosition iconPosition)

Specified by:

iconAndText in interface ComponentIconAndText<HTMLElement, MenuItem>

removeIcon

public MenuItem removeIcon()

Specified by:

removeIcon in interface ComponentIcon<HTMLElement, MenuItem>

selected

public MenuItem selected()

store

public <T> MenuItem store(String key,
 T value)

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<HTMLElement, MenuItem>

Type Parameters:

T - the type of the value being stored

Parameters:

key - the key associated with the value

value - the value to be stored

text

public MenuItem text(HTMLElement element)

that

public MenuItem that()

Specified by:

that in interface TypedBuilder<HTMLElement, MenuItem>

onClick

public MenuItem onClick(ComponentHandler<MenuItem> handler)

Registers an event handler to be invoked when the menu item is clicked. If the menu item has been marked as a favorite, the handler will be called with the original menu item, not the favorite item.

Parameters:

handler - the event handler to associate with this menu item. This handler is invoked with the event and the current menu item instance when a click event occurs.

Returns:

the current MenuItem instance, allowing for method chaining.

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<HTMLElement, MenuItem>

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<HTMLElement, MenuItem>

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<HTMLElement, MenuItem>

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