Class MultiTypeahead

java.lang.Object

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

org.patternfly.component.menu.MultiTypeahead

All Implemented Interfaces:

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

public class MultiTypeahead
extends ComponentDelegate<HTMLElement, MultiTypeahead>

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.

See Also:

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

Method Summary

Modifier and Type	Method	Description
MultiTypeahead	add(Menu menu)
MultiTypeahead	addMenu(Menu menu)
MultiTypeahead	applyTo(Consumer<MenuToggle> consumer)	Provides access to the underlying menu toggle using a fluent API style
MultiTypeahead	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()
void	clear(boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
MultiTypeahead	disabled(boolean disabled)
void	expand(boolean fireEvent)
MultiTypeahead	flip(boolean flip)
boolean	isDisabled()
Menu	menu()
MenuToggle	menuToggle()
static MultiTypeahead	multiTypeahead(String id, String placeholder)	Creates a new MultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInput.
static MultiTypeahead	multiTypeahead(MenuToggle menuToggle)	Creates a new MultiTypeahead component with the given MenuToggle.
MultiTypeahead	onLoaded(ComponentHandler<MultiTypeahead> loadedHandler)
MultiTypeahead	onNoResults(Function<String,MenuItem> noResults)	Defines the behavior when no results are found during a search.
MultiTypeahead	onSearch(SearchFilter searchFilter)	Configures the search behavior for this typeahead.
MultiTypeahead	onToggle(ToggleHandler<MultiTypeahead> toggleHandler)
MultiTypeahead	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)
MultiTypeahead	stayOpen()
MultiTypeahead	stayOpen(Predicate<Event> stayOpen)	Specifies a condition that determines whether the menu should remain open when an event occurs.
MultiTypeahead	that()
void	unselectIdentifiers(List<String> identifiers)
void	unselectIdentifiers(List<String> identifiers, boolean fireEvent)
void	unselectItems(List<MenuItem> items)
void	unselectItems(List<MenuItem> items, boolean fireEvent)
MultiTypeahead	zIndex(int zIndex)

Methods inherited from class org.patternfly.component.ComponentDelegate

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

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

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

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

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

disabled

Method Details

multiTypeahead

public static MultiTypeahead multiTypeahead(String id,
 String placeholder)

Creates a new MultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInput.

multiTypeahead

public static MultiTypeahead multiTypeahead(MenuToggle menuToggle)

Creates a new MultiTypeahead component with the given MenuToggle. The MenuToggle must be of type MenuToggleType.typeahead and must contain a FilterInput.

add

public MultiTypeahead add(Menu menu)

that

public MultiTypeahead that()

onSearch

public MultiTypeahead onSearch(SearchFilter searchFilter)

Configures the search behavior for this typeahead.

By default, the search filter will match items that contain the search query in their text.

Parameters:

searchFilter - a SearchFilter that defines the search logic. The first parameter is a MenuItem representing a menu item, and the second parameter is a String representing the search query. The predicate should return true for items matching the search.

Returns:

the MultiTypeahead instance for method chaining.

onNoResults

public MultiTypeahead onNoResults(Function<String,MenuItem> noResults)

Defines the behavior when no results are found during a search. This method allows setting a Function that takes a search query as input and provides a MenuItem to be displayed when no matching results are found.

By default, a "No results found" message is displayed.

Parameters:

noResults - a Function that accepts a String parameter representing the search query, and returns a MenuItem to display for no results.

Returns:

the MultiTypeahead 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)

unselectIdentifiers

public void unselectIdentifiers(List<String> identifiers)

unselectIdentifiers

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

unselectItems

public void unselectItems(List<MenuItem> items)

unselectItems

public void unselectItems(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 MultiTypeahead addMenu(Menu menu)

applyTo

public MultiTypeahead applyTo(Consumer<MenuToggle> consumer)

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

disabled

public MultiTypeahead disabled(boolean 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>>

flip

public MultiTypeahead flip(boolean flip)

placement

public MultiTypeahead placement(Placement placement)

stayOpen

public MultiTypeahead stayOpen()

stayOpen

public MultiTypeahead stayOpen(Predicate<Event> stayOpen)

Specifies a condition that determines whether the menu should remain open when an event occurs.

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.

zIndex

public MultiTypeahead zIndex(int zIndex)

ariaLabel

public MultiTypeahead ariaLabel(String label)

onLoaded

public MultiTypeahead onLoaded(ComponentHandler<MultiTypeahead> loadedHandler)

onToggle

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