Class MultiSelect

java.lang.Object

org.patternfly.component.ComponentDelegate<HTMLElement, MultiSelect>

org.patternfly.component.menu.MultiSelect

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLElement, MultiSelect>, ElementClassListMethods<HTMLElement, MultiSelect>, ElementConsumerMethods<HTMLElement, MultiSelect>, ElementContainerMethods<HTMLElement, MultiSelect>, ElementEventMethods<HTMLElement, MultiSelect>, ElementIdMethods<HTMLElement, MultiSelect>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, MultiSelect>, HTMLElementDataMethods<HTMLElement, MultiSelect>, HTMLElementStyleMethods<HTMLElement, MultiSelect>, HTMLElementVisibilityMethods<HTMLElement, MultiSelect>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, MultiSelect>, Component, Expandable<HTMLElement, MultiSelect>, Modifiers.Disabled<HTMLElement, MultiSelect>

public class MultiSelect
extends ComponentDelegate<HTMLElement, MultiSelect>

A select component to select multiple items from a list.

This implementation uses the Popover API and CSS anchor positioning instead of Popper.js. The select uses the browser's top-layer rendering for correct stacking, eliminating z-index issues. CSS position-try-fallbacks handles menu flipping when there is not enough space.

See Also:

• https://www.patternfly.org/components/menus/select

Method Summary

Modifier and Type	Method	Description
MultiSelect	add(Menu menu)
MultiSelect	addMenu(Menu menu)
MultiSelect	applyToMenuList(Consumer<MenuList> consumer)	Applies the provided Consumer to the MenuList associated with this MultiSelect.
MultiSelect	applyToMenuToggle(Consumer<MenuToggle> consumer)	Provides access to the underlying menu toggle using a fluent API style
MultiSelect	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()
void	clear(boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
MultiSelect	disabled(boolean disabled)	Adds/removes modifier(disabled)
void	expand(boolean fireEvent)
boolean	isDisabled()
Menu	menu()
MenuToggle	menuToggle()
static MultiSelect	multiSelect(String text)	Creates a new instance of MultiSelect with a toggle menu initialized using the provided text.
static MultiSelect	multiSelect(MenuToggle menuToggle)	Creates a new instance of MultiSelect initialized with the specified MenuToggle.
MultiSelect	onLoaded(ComponentHandler<MultiSelect> loadedHandler)
MultiSelect	onToggle(ToggleHandler<MultiSelect> toggleHandler)
MultiSelect	placement(Placement placement)
void	selectIdentifiers(List<String> identifiers)
void	selectIdentifiers(List<String> identifiers, boolean fireEvent)
void	selectItems(List<MenuItem> items)
void	selectItems(List<MenuItem> items, boolean fireEvent)
MultiSelect	stayOpen(StayOpenPredicate stayOpen)	Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.
MultiSelect	that()

Methods inherited from class ComponentDelegate

componentType, element

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 Expandable

collapse, expand, expanded, toggle, toggle

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

Method Details

multiSelect

public static MultiSelect multiSelect(String text)

Creates a new instance of MultiSelect with a toggle menu initialized using the provided text. The toggle menu includes a badge initialized with a count of zero in the read state.

Parameters:

text - the text to be displayed on the toggle menu

Returns:

a new instance of MultiSelect initialized with the specified text

multiSelect

public static MultiSelect multiSelect(MenuToggle menuToggle)

Creates a new instance of MultiSelect initialized with the specified MenuToggle.

Parameters:

menuToggle - the MenuToggle to initialize the MultiSelect with

Returns:

a new instance of MultiSelect initialized with the provided MenuToggle

that

public MultiSelect that()

add

public MultiSelect add(Menu menu)

applyToMenuList

public MultiSelect applyToMenuList(Consumer<MenuList> consumer)

Applies the provided Consumer to the MenuList associated with this MultiSelect. If the menu, menu content, or menu list is not yet initialized, they will be created as part of this method.

This method simplifies the process of adding menu items to the component. It is a shortcut for creating and adding a MultiSelectMenu, MenuContent, and MenuList in a single step. Don't use this method if you need to us another menu type, want to customize the menu, content or list or if you want to use MenuGroups.

Parameters:

consumer - a Consumer that accepts a MenuList for customization or modification

Returns:

the current MultiSelect instance for method chaining

clear

public void clear()

clear

public void clear(boolean fireEvent)

selectIdentifiers

public void selectIdentifiers(List<String> identifiers)

selectIdentifiers

public void selectIdentifiers(List<String> identifiers,
 boolean fireEvent)

selectItems

public void selectItems(List<MenuItem> items)

selectItems

public void selectItems(List<MenuItem> items,
 boolean fireEvent)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addMenu

public MultiSelect addMenu(Menu menu)

applyToMenuToggle

public MultiSelect applyToMenuToggle(Consumer<MenuToggle> consumer)

Provides access to the underlying menu toggle using a fluent API style

disabled

public MultiSelect disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Modifiers.Disabled<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

placement

public MultiSelect placement(Placement placement)

stayOpen

public MultiSelect stayOpen(StayOpenPredicate stayOpen)

Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.

Parameters:

stayOpen - a Predicate that evaluates an Event to determine if the menu remains open.

Returns:

the current instance with the condition applied, enabling method chaining.

ariaLabel

public MultiSelect ariaLabel(String label)

onLoaded

public MultiSelect onLoaded(ComponentHandler<MultiSelect> loadedHandler)

onToggle

public MultiSelect onToggle(ToggleHandler<MultiSelect> toggleHandler)

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

menuToggle

public MenuToggle menuToggle()

menu

public Menu menu()