Class SingleTypeahead

java.lang.Object

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

org.patternfly.component.menu.SingleTypeahead

All Implemented Interfaces:

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

public class SingleTypeahead
extends ComponentDelegate<HTMLElement, SingleTypeahead>
implements HasValue<String>

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
SingleTypeahead	add(Menu menu)
SingleTypeahead	addMenu(Menu menu)
SingleTypeahead	applyTo(Consumer<MenuToggle> consumer)	Provides access to the underlying menu toggle using a fluent API style
SingleTypeahead	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
SingleTypeahead	disabled(boolean disabled)
void	expand(boolean fireEvent)
SingleTypeahead	flip(boolean flip)
boolean	isDisabled()
Menu	menu()
MenuToggle	menuToggle()
SingleTypeahead	onLoaded(ComponentHandler<SingleTypeahead> loadedHandler)
SingleTypeahead	onNoResults(Function<String,MenuItem> noResults)	Defines the behavior when no results are found during a search.
SingleTypeahead	onSearch(SearchFilter searchFilter)	Configures the search behavior for this typeahead.
SingleTypeahead	onToggle(ToggleHandler<SingleTypeahead> toggleHandler)
SingleTypeahead	placement(Placement placement)
void	select(String itemId)
void	select(String itemId, boolean fireEvent)
void	select(MenuItem item)
void	select(MenuItem item, boolean fireEvent)
static SingleTypeahead	singleTypeahead(String id, String placeholder)	Creates a new SingleTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a SearchInput.
static SingleTypeahead	singleTypeahead(MenuToggle menuToggle)	Creates a new SingleTypeahead component with the given MenuToggle.
SingleTypeahead	stayOpen()
SingleTypeahead	stayOpen(Predicate<Event> stayOpen)
SingleTypeahead	that()
String	value()
SingleTypeahead	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

singleTypeahead

public static SingleTypeahead singleTypeahead(String id,
 String placeholder)

Creates a new SingleTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a SearchInput.

singleTypeahead

public static SingleTypeahead singleTypeahead(MenuToggle menuToggle)

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

add

public SingleTypeahead add(Menu menu)

that

public SingleTypeahead that()

Specified by:

that in interface TypedBuilder<HTMLElement, SingleTypeahead>

onSearch

public SingleTypeahead 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 SingleTypeahead instance for method chaining.

onNoResults

public SingleTypeahead 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 SingleTypeahead instance for method chaining.

select

public void select(String itemId)

select

public void select(String itemId,
 boolean fireEvent)

select

public void select(MenuItem item)

select

public void select(MenuItem item,
 boolean fireEvent)

value

public String value()

Specified by:

value in interface HasValue<String>

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

applyTo

public SingleTypeahead applyTo(Consumer<MenuToggle> consumer)

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

disabled

public SingleTypeahead 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 SingleTypeahead flip(boolean flip)

placement

public SingleTypeahead placement(Placement placement)

stayOpen

public SingleTypeahead stayOpen()

stayOpen

public SingleTypeahead stayOpen(Predicate<Event> stayOpen)

zIndex

public SingleTypeahead zIndex(int zIndex)

ariaLabel

public SingleTypeahead ariaLabel(String label)

onLoaded

public SingleTypeahead onLoaded(ComponentHandler<SingleTypeahead> loadedHandler)

onToggle

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