Class PopperMultiTypeahead

java.lang.Object

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

org.patternfly.component.menu.PopperMultiTypeahead

All Implemented Interfaces:

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

@Deprecated
public class PopperMultiTypeahead
extends ComponentDelegate<HTMLElement, PopperMultiTypeahead>
implements PopperTypeahead<PopperMultiTypeahead>

Deprecated.

This implementation uses the Popper.js API, which is due to be removed soon. Use MultiTypeahead instead.

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.

Method Summary

Modifier and Type	Method	Description
PopperMultiTypeahead	add(Menu menu)	Deprecated.
PopperMultiTypeahead	addMenu(Menu menu)	Deprecated.
PopperMultiTypeahead	allowNewItems(Function<String,String> prompt, Function<String, Promise<MenuItem>> createItem)	Deprecated. Allows the creation of new menu items based on user input.
PopperMultiTypeahead	applyToMenuToggle(Consumer<MenuToggle> consumer)	Deprecated. Provides access to the underlying menu toggle using a fluent API style
PopperMultiTypeahead	ariaLabel(String label)	Deprecated.
void	attach(MutationRecord mutationRecord)	Deprecated.
void	clear()	Deprecated.
void	clear(boolean fireEvent)	Deprecated.
void	collapse(boolean fireEvent)	Deprecated.
void	detach(MutationRecord mutationRecord)	Deprecated.
PopperMultiTypeahead	disabled(boolean disabled)	Deprecated. Adds/removes modifier(disabled)
void	expand(boolean fireEvent)	Deprecated.
PopperMultiTypeahead	flip(boolean flip)	Deprecated.
boolean	isDisabled()	Deprecated.
Menu	menu()	Deprecated.
MenuToggle	menuToggle()	Deprecated.
static PopperMultiTypeahead	multiTypeahead(String id, String placeholder)	Deprecated. Creates a new PopperMultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInput.
static PopperMultiTypeahead	multiTypeahead(BaseFilterInput<?> filterInput)	Deprecated. Creates a new PopperMultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and the specified BaseFilterInput.
PopperMultiTypeahead	onLoaded(ComponentHandler<PopperMultiTypeahead> loadedHandler)	Deprecated.
PopperMultiTypeahead	onNoResults(NoResults noResults)	Deprecated. Configures the behavior for generating a "no results" menu item when no matching items are found in the menu list for the given input text.
PopperMultiTypeahead	onSearch(SearchFilter searchFilter)	Deprecated. Configures the search behavior for this typeahead.
PopperMultiTypeahead	onToggle(ToggleHandler<PopperMultiTypeahead> toggleHandler)	Deprecated.
PopperMultiTypeahead	placement(PopperPlacement placement)	Deprecated.
void	selectIdentifiers(List<String> identifiers)	Deprecated.
void	selectIdentifiers(List<String> identifiers, boolean fireEvent)	Deprecated.
void	selectItems(List<MenuItem> items)	Deprecated.
void	selectItems(List<MenuItem> items, boolean fireEvent)	Deprecated.
PopperMultiTypeahead	stayOpen()	Deprecated.
PopperMultiTypeahead	stayOpen(Predicate<Event> stayOpen)	Deprecated. Specifies a condition that determines whether the menu should remain open when an event occurs.
PopperMultiTypeahead	that()	Deprecated.
PopperMultiTypeahead	zIndex(int zIndex)	Deprecated.

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

Methods inherited from interface PopperTypeahead

allowNewItems

Method Details

multiTypeahead

public static PopperMultiTypeahead multiTypeahead(String id,
 String placeholder)

Deprecated.

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

multiTypeahead

public static PopperMultiTypeahead multiTypeahead(BaseFilterInput<?> filterInput)

Deprecated.

Creates a new PopperMultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and the specified BaseFilterInput.

Parameters:

filterInput - the BaseFilterInput instance used to configure the typeahead component with filtering and search capabilities

Returns:

a new PopperMultiTypeahead instance configured with the given filter input

add

public PopperMultiTypeahead add(Menu menu)

Deprecated.

allowNewItems

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

Deprecated.

Description copied from interface: PopperTypeahead

Allows the creation of new menu items based on user input. This method enables a typeahead component to provide functionality for dynamically adding custom items when the user-provided input does not match any existing items.

Specified by:

allowNewItems in interface PopperTypeahead<PopperMultiTypeahead>

Parameters:

prompt - a Function that takes a String input representing the user's data and returns a String response, typically used to prompt the user or display a message.

createItem - a Function that takes a String input representing the user's data and returns a Promise of a MenuItem, representing the newly created item.

Returns:

an instance of the enclosing type, enabling method chaining for further configuration.

that

public PopperMultiTypeahead that()

Deprecated.

Specified by:

that in interface TypedBuilder<HTMLElement, PopperMultiTypeahead>

onSearch

public PopperMultiTypeahead onSearch(SearchFilter searchFilter)

Deprecated.

Description copied from interface: PopperTypeahead

Configures the search behavior for this typeahead.

Specified by:

onSearch in interface PopperTypeahead<PopperMultiTypeahead>

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

onNoResults

public PopperMultiTypeahead onNoResults(NoResults noResults)

Deprecated.

Description copied from interface: PopperTypeahead

Configures the behavior for generating a "no results" menu item when no matching items are found in the menu list for the given input text.

Specified by:

onNoResults in interface PopperTypeahead<PopperMultiTypeahead>

Parameters:

noResults - a NoResults implementation responsible for defining how the "no results" menu item is created and displayed when no matches are found.

Returns:

the instance of the current type enabling method chaining.

clear

public void clear()

Deprecated.

clear

public void clear(boolean fireEvent)

Deprecated.

selectIdentifiers

public void selectIdentifiers(List<String> identifiers)

Deprecated.

selectIdentifiers

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

Deprecated.

selectItems

public void selectItems(List<MenuItem> items)

Deprecated.

selectItems

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

Deprecated.

attach

public void attach(MutationRecord mutationRecord)

Deprecated.

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Deprecated.

Specified by:

detach in interface Attachable

addMenu

public PopperMultiTypeahead addMenu(Menu menu)

Deprecated.

applyToMenuToggle

public PopperMultiTypeahead applyToMenuToggle(Consumer<MenuToggle> consumer)

Deprecated.

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

disabled

public PopperMultiTypeahead disabled(boolean disabled)

Deprecated.

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

Deprecated.

Specified by:

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

flip

public PopperMultiTypeahead flip(boolean flip)

Deprecated.

placement

public PopperMultiTypeahead placement(PopperPlacement placement)

Deprecated.

stayOpen

public PopperMultiTypeahead stayOpen()

Deprecated.

stayOpen

public PopperMultiTypeahead stayOpen(Predicate<Event> stayOpen)

Deprecated.

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 PopperMultiTypeahead zIndex(int zIndex)

Deprecated.

ariaLabel

public PopperMultiTypeahead ariaLabel(String label)

Deprecated.

onLoaded

public PopperMultiTypeahead onLoaded(ComponentHandler<PopperMultiTypeahead> loadedHandler)

Deprecated.

onToggle

public PopperMultiTypeahead onToggle(ToggleHandler<PopperMultiTypeahead> toggleHandler)

Deprecated.

collapse

public void collapse(boolean fireEvent)

Deprecated.

Specified by:

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

expand

public void expand(boolean fireEvent)

Deprecated.

Specified by:

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

menuToggle

public MenuToggle menuToggle()

Deprecated.

menu

public Menu menu()

Deprecated.