Class MultiSelectTypeahead

java.lang.Object

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

org.patternfly.component.menu.MultiSelectTypeahead

All Implemented Interfaces:

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

public class MultiSelectTypeahead
extends ComponentDelegate<HTMLElement, MultiSelectTypeahead>
implements Typeahead<MultiSelectTypeahead>

A typeahead is a select variant that replaces the typical button toggle for opening the select menu with a text input and button toggle combo. As a user enters characters into the text input, the menu options will be filtered to match.

This implementation uses the Popover API and CSS anchor positioning instead of Popper.js. The typeahead 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
MultiSelectTypeahead	add(Menu menu)
MultiSelectTypeahead	addMenu(Menu menu)
MultiSelectTypeahead	allowNewItems(Function<String, Promise<MenuItem>> createItem)
MultiSelectTypeahead	allowNewItems(Function<String,String> prompt, Function<String, Promise<MenuItem>> createItem)
MultiSelectTypeahead	applyToMenuList(Consumer<MenuList> consumer)	Applies the provided Consumer to the MenuList associated with this MultiSelect.
MultiSelectTypeahead	applyToMenuToggle(Consumer<MenuToggle> consumer)	Provides access to the underlying menu toggle using a fluent API style
MultiSelectTypeahead	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()
void	clear(boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
MultiSelectTypeahead	disabled(boolean disabled)	Adds/removes modifier(disabled)
void	expand(boolean fireEvent)
MultiSelectTypeahead	filter(SearchFilter searchFilter)	Sets the filter used to match existing menu items against the current input value.
boolean	isDisabled()
Menu	menu()
MenuToggle	menuToggle()
static MultiSelectTypeahead	multiSelectTypeahead(String id, String placeholder)	Creates a new MultiSelectTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInputGroup.
static MultiSelectTypeahead	multiSelectTypeahead(BaseFilterInputGroup<?> filterInput)	Creates a new MultiSelectTypeahead component with a MenuToggle of type MenuToggleType.typeahead and the specified BaseFilterInputGroup.
MultiSelectTypeahead	onLoaded(ComponentHandler<MultiSelectTypeahead> loadedHandler)
MultiSelectTypeahead	onNoResults(NoResults noResults)	Configures the behavior for generating a "no results" menu item when no matching items are found.
MultiSelectTypeahead	onToggle(ToggleHandler<MultiSelectTypeahead> toggleHandler)
MultiSelectTypeahead	placement(Placement placement)
MultiSelectTypeahead	refreshOn(RefreshStrategy strategy)	Sets the refresh strategy for asynchronously loaded items.
void	selectIdentifiers(List<String> identifiers)
void	selectIdentifiers(List<String> identifiers, boolean fireEvent)
void	selectItems(List<MenuItem> items)
void	selectItems(List<MenuItem> items, boolean fireEvent)
MultiSelectTypeahead	stayOpen(StayOpenPredicate<MenuToggle> stayOpen)	Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.
MultiSelectTypeahead	that()

Methods inherited from class ComponentDelegate

componentType, element, ouiaComponentType

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

Methods inherited from interface OuiaSupport

initOuia, initOuia, ouiaId, ouiaSafe, ouiaTransition

Methods inherited from interface Typeahead

onLoaded, onToggle

Method Details

multiSelectTypeahead

public static MultiSelectTypeahead multiSelectTypeahead(String id,
 String placeholder)

Creates a new MultiSelectTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInputGroup.

multiSelectTypeahead

public static MultiSelectTypeahead multiSelectTypeahead(BaseFilterInputGroup<?> filterInput)

Creates a new MultiSelectTypeahead component with a MenuToggle of type MenuToggleType.typeahead and the specified BaseFilterInputGroup.

Parameters:

filterInput - the BaseFilterInputGroup instance used to configure the typeahead component

Returns:

a new MultiSelectTypeahead instance configured with the given filter input

add

public MultiSelectTypeahead add(Menu menu)

allowNewItems

public MultiSelectTypeahead allowNewItems(Function<String, Promise<MenuItem>> createItem)

allowNewItems

public MultiSelectTypeahead allowNewItems(Function<String,String> prompt,
 Function<String, Promise<MenuItem>> createItem)

that

public MultiSelectTypeahead that()

Specified by:

that in interface TypedBuilder<HTMLElement, MultiSelectTypeahead>

filter

public MultiSelectTypeahead filter(SearchFilter searchFilter)

Description copied from interface: Typeahead

Sets the filter used to match existing menu items against the current input value. Defaults to SearchFilter.contains().

Specified by:

filter in interface Typeahead<MultiSelectTypeahead>

onNoResults

public MultiSelectTypeahead onNoResults(NoResults noResults)

Description copied from interface: Typeahead

Configures the behavior for generating a "no results" menu item when no matching items are found.

Specified by:

onNoResults in interface Typeahead<MultiSelectTypeahead>

refreshOn

public MultiSelectTypeahead refreshOn(RefreshStrategy strategy)

Description copied from interface: Typeahead

Sets the refresh strategy for asynchronously loaded items.

Specified by:

refreshOn in interface Typeahead<MultiSelectTypeahead>

applyToMenuList

public MultiSelectTypeahead 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 MultiSelectTypeahead addMenu(Menu menu)

applyToMenuToggle

public MultiSelectTypeahead applyToMenuToggle(Consumer<MenuToggle> consumer)

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

disabled

public MultiSelectTypeahead 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 MultiSelectTypeahead placement(Placement placement)

stayOpen

public MultiSelectTypeahead stayOpen(StayOpenPredicate<MenuToggle> stayOpen)

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

Parameters:

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

Returns:

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

ariaLabel

public MultiSelectTypeahead ariaLabel(String label)

onLoaded

public MultiSelectTypeahead onLoaded(ComponentHandler<MultiSelectTypeahead> loadedHandler)

onToggle

public MultiSelectTypeahead onToggle(ToggleHandler<MultiSelectTypeahead> 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()