Class MenuToggle

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement, MenuToggle>

org.patternfly.component.menu.MenuToggle

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement, MenuToggle>, ElementClassListMethods<HTMLElement, MenuToggle>, ElementConsumerMethods<HTMLElement, MenuToggle>, ElementContainerMethods<HTMLElement, MenuToggle>, ElementEventMethods<HTMLElement, MenuToggle>, ElementIdMethods<HTMLElement, MenuToggle>, ElementQueryMethods<HTMLElement>, ElementTextMethods<HTMLElement, MenuToggle>, HTMLElementAttributeMethods<HTMLElement, MenuToggle>, HTMLElementDataMethods<HTMLElement, MenuToggle>, HTMLElementStyleMethods<HTMLElement, MenuToggle>, HTMLElementVisibilityMethods<HTMLElement, MenuToggle>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, MenuToggle>, Component, ComponentIcon<HTMLElement, MenuToggle>, ComponentIconAndText<HTMLElement, MenuToggle>, Modifiers.Disabled<HTMLElement, MenuToggle>, Modifiers.FullHeight<HTMLElement, MenuToggle>, Modifiers.FullWidth<HTMLElement, MenuToggle>, Modifiers.Primary<HTMLElement, MenuToggle>, Modifiers.Secondary<HTMLElement, MenuToggle>

public class MenuToggle
extends BaseComponent<HTMLElement, MenuToggle>
implements ComponentIcon<HTMLElement, MenuToggle>, ComponentIconAndText<HTMLElement, MenuToggle>, Modifiers.Disabled<HTMLElement, MenuToggle>, ElementTextMethods<HTMLElement, MenuToggle>, Modifiers.FullHeight<HTMLElement, MenuToggle>, Modifiers.FullWidth<HTMLElement, MenuToggle>, Modifiers.Primary<HTMLElement, MenuToggle>, Modifiers.Secondary<HTMLElement, MenuToggle>

The menu toggle component pairs with the menu OR the panel component to create a more customizable dropdown and select implementations. Using a menu toggle with a menu enables you to create custom component configurations not supported by the standard dropdown or select components.

See Also:

• invalid input: '<'

Method Summary

Modifier and Type	Method	Description
MenuToggle	add(Avatar avatar)
MenuToggle	add(Badge badge)
MenuToggle	add(Checkbox checkbox)	Adds a checkbox to the menu toggle and ensures the necessary internal wiring.
MenuToggle	add(MenuToggleAction action)
MenuToggle	add(BaseFilterInput<?> filterInput)
MenuToggle	add(BaseSearchInput<?> searchInput)
MenuToggle	addAction(MenuToggleAction action)
MenuToggle	addAvatar(Avatar avatar)
MenuToggle	addBadge(Badge badge)
MenuToggle	addCheckbox(Checkbox checkbox)	Adds a checkbox to the menu toggle and ensures the necessary internal wiring.
MenuToggle	addFilterInput(BaseFilterInput<?> filterInput)
MenuToggle	addSearchInput(BaseSearchInput<?> searchInput)
MenuToggle	ariaLabel(String label)
Badge	badge()
Checkbox	checkbox()
MenuToggle	disabled(boolean disabled)	Adds/removes modifier(disabled)
BaseFilterInput<?>	filterInput()
MenuToggle	icon(Element icon)
MenuToggle	iconAndText(Element icon, String text, IconPosition iconPosition)
static MenuToggle	menuToggle()
static MenuToggle	menuToggle(Element icon)
static MenuToggle	menuToggle(Element icon, String label)
static MenuToggle	menuToggle(String text)
static MenuToggle	menuToggle(MenuToggleType type)
static <T extends BaseFilterInput<T>> MenuToggle	menuToggle(BaseFilterInput<T> filterInput)
static <T extends BaseSearchInput<T>> MenuToggle	menuToggle(BaseSearchInput<T> searchInput)
static MenuToggle	menuToggle(PredefinedIcon icon)
static MenuToggle	menuToggle(PredefinedIcon icon, String label)
MenuToggle	placeholder()
MenuToggle	placeholder(boolean placeholder)
MenuToggle	removeIcon()
void	resetValidation()
BaseSearchInput<?>	searchInput()
MenuToggle	small()
String	text()
MenuToggle	text(String text)
MenuToggle	that()
MenuToggle	validated(ValidationStatus status)

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

Methods inherited from interface Modifiers.FullHeight

fullHeight, fullHeight

Methods inherited from interface Modifiers.FullWidth

fullWidth, fullWidth

Methods inherited from interface Modifiers.Primary

primary, primary

Methods inherited from interface Modifiers.Secondary

secondary, secondary

Method Details

menuToggle

public static MenuToggle menuToggle()

menuToggle

public static MenuToggle menuToggle(String text)

menuToggle

public static MenuToggle menuToggle(PredefinedIcon icon)

menuToggle

public static MenuToggle menuToggle(PredefinedIcon icon,
 String label)

menuToggle

public static MenuToggle menuToggle(Element icon)

menuToggle

public static MenuToggle menuToggle(Element icon,
 String label)

menuToggle

public static <T extends BaseSearchInput<T>>
MenuToggle menuToggle(BaseSearchInput<T> searchInput)

menuToggle

public static <T extends BaseFilterInput<T>>
MenuToggle menuToggle(BaseFilterInput<T> filterInput)

menuToggle

public static MenuToggle menuToggle(MenuToggleType type)

addAvatar

public MenuToggle addAvatar(Avatar avatar)

add

public MenuToggle add(Avatar avatar)

addBadge

public MenuToggle addBadge(Badge badge)

add

public MenuToggle add(Badge badge)

addAction

public MenuToggle addAction(MenuToggleAction action)

add

public MenuToggle add(MenuToggleAction action)

addCheckbox

public MenuToggle addCheckbox(Checkbox checkbox)

Adds a checkbox to the menu toggle and ensures the necessary internal wiring. Please make sure that the checkbox is a wrapped checkbox created with Checkbox.checkboxWrapped(String, String).

Parameters:

checkbox - the Checkbox component to be added to the menu toggle

Returns:

the updated MenuToggle instance with the checkbox added

add

public MenuToggle add(Checkbox checkbox)

Adds a checkbox to the menu toggle and ensures the necessary internal wiring. Please make sure that the checkbox is a * wrapped checkbox created with Checkbox.checkboxWrapped(String, String).

Parameters:

checkbox - the Checkbox component to be added to the menu toggle

Returns:

the updated MenuToggle instance

addSearchInput

public MenuToggle addSearchInput(BaseSearchInput<?> searchInput)

add

public MenuToggle add(BaseSearchInput<?> searchInput)

addFilterInput

public MenuToggle addFilterInput(BaseFilterInput<?> filterInput)

add

public MenuToggle add(BaseFilterInput<?> filterInput)

disabled

public MenuToggle disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLElement, MenuToggle>

icon

public MenuToggle icon(Element icon)

Specified by:

icon in interface ComponentIcon<HTMLElement, MenuToggle>

removeIcon

public MenuToggle removeIcon()

Specified by:

removeIcon in interface ComponentIcon<HTMLElement, MenuToggle>

placeholder

public MenuToggle placeholder()

placeholder

public MenuToggle placeholder(boolean placeholder)

text

public MenuToggle text(String text)

Specified by:

text in interface ElementTextMethods<HTMLElement, MenuToggle>

iconAndText

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

Specified by:

iconAndText in interface ComponentIconAndText<HTMLElement, MenuToggle>

small

public MenuToggle small()

validated

public MenuToggle validated(ValidationStatus status)

that

public MenuToggle that()

Specified by:

that in interface TypedBuilder<HTMLElement, MenuToggle>

ariaLabel

public MenuToggle ariaLabel(String label)

resetValidation

public void resetValidation()

text

public String text()

Specified by:

text in interface ElementTextMethods<HTMLElement, MenuToggle>

searchInput

public BaseSearchInput<?> searchInput()

filterInput

public BaseFilterInput<?> filterInput()

badge

public Badge badge()

checkbox

public Checkbox checkbox()