Class PopperSingleTypeahead

java.lang.Object

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

org.patternfly.component.menu.PopperSingleTypeahead

All Implemented Interfaces:

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

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

Deprecated.

This implementation uses the Popper.js API, which is due to be removed soon. Use SingleTypeahead 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
PopperSingleTypeahead	add(Menu menu)	Deprecated.
PopperSingleTypeahead	addMenu(Menu menu)	Deprecated.
PopperSingleTypeahead	allowNewItems(Function<String,String> prompt, Function<String, Promise<MenuItem>> createItem)	Deprecated. Allows the creation of new menu items based on user input.
PopperSingleTypeahead	applyToMenuToggle(Consumer<MenuToggle> consumer)	Deprecated. Provides access to the underlying menu toggle using a fluent API style
PopperSingleTypeahead	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.
PopperSingleTypeahead	disabled(boolean disabled)	Deprecated. Adds/removes modifier(disabled)
void	expand(boolean fireEvent)	Deprecated.
PopperSingleTypeahead	flip(boolean flip)	Deprecated.
boolean	isDisabled()	Deprecated.
Menu	menu()	Deprecated.
MenuToggle	menuToggle()	Deprecated.
PopperSingleTypeahead	noDefaultSelectHandler()	Deprecated.
PopperSingleTypeahead	onLoaded(ComponentHandler<PopperSingleTypeahead> loadedHandler)	Deprecated.
PopperSingleTypeahead	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.
PopperSingleTypeahead	onSearch(SearchFilter searchFilter)	Deprecated. Configures the search behavior for this typeahead.
PopperSingleTypeahead	onToggle(ToggleHandler<PopperSingleTypeahead> toggleHandler)	Deprecated.
PopperSingleTypeahead	placement(PopperPlacement placement)	Deprecated.
void	select(String identifier)	Deprecated.
void	select(String identifier, boolean fireEvent)	Deprecated.
void	select(MenuItem item)	Deprecated.
void	select(MenuItem item, boolean fireEvent)	Deprecated.
static PopperSingleTypeahead	singleTypeahead(String id, String placeholder)	Deprecated. Creates a new PopperSingleTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a SearchInput.
static PopperSingleTypeahead	singleTypeahead(BaseSearchInput<?> searchInput)	Deprecated. Creates a new PopperSingleTypeahead instance using the provided BaseSearchInput.
PopperSingleTypeahead	stayOpen()	Deprecated.
PopperSingleTypeahead	stayOpen(Predicate<Event> stayOpen)	Deprecated. Specifies a condition that determines whether the menu should remain open when an event occurs.
PopperSingleTypeahead	that()	Deprecated.
PopperSingleTypeahead	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

singleTypeahead

public static PopperSingleTypeahead singleTypeahead(String id,
 String placeholder)

Deprecated.

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

singleTypeahead

public static PopperSingleTypeahead singleTypeahead(BaseSearchInput<?> searchInput)

Deprecated.

Creates a new PopperSingleTypeahead instance using the provided BaseSearchInput.

Parameters:

searchInput - the BaseSearchInput used to configure the typeahead component. This input determines the search behavior and the interaction model of the typeahead.

Returns:

a new PopperSingleTypeahead instance initialized with a MenuToggle of type MenuToggleType.typeahead.

add

public PopperSingleTypeahead add(Menu menu)

Deprecated.

allowNewItems

public PopperSingleTypeahead 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<PopperSingleTypeahead>

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

Deprecated.

Specified by:

that in interface TypedBuilder<HTMLElement, PopperSingleTypeahead>

onSearch

public PopperSingleTypeahead onSearch(SearchFilter searchFilter)

Deprecated.

Description copied from interface: PopperTypeahead

Configures the search behavior for this typeahead.

Specified by:

onSearch in interface PopperTypeahead<PopperSingleTypeahead>

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 PopperSingleTypeahead 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<PopperSingleTypeahead>

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.

noDefaultSelectHandler

public PopperSingleTypeahead noDefaultSelectHandler()

Deprecated.

clear

public void clear()

Deprecated.

clear

public void clear(boolean fireEvent)

Deprecated.

select

public void select(String identifier)

Deprecated.

select

public void select(String identifier,
 boolean fireEvent)

Deprecated.

select

public void select(MenuItem item)

Deprecated.

select

public void select(MenuItem item,
 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 PopperSingleTypeahead addMenu(Menu menu)

Deprecated.

applyToMenuToggle

public PopperSingleTypeahead applyToMenuToggle(Consumer<MenuToggle> consumer)

Deprecated.

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

disabled

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

Deprecated.

placement

public PopperSingleTypeahead placement(PopperPlacement placement)

Deprecated.

stayOpen

public PopperSingleTypeahead stayOpen()

Deprecated.

stayOpen

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

Deprecated.

ariaLabel

public PopperSingleTypeahead ariaLabel(String label)

Deprecated.

onLoaded

public PopperSingleTypeahead onLoaded(ComponentHandler<PopperSingleTypeahead> loadedHandler)

Deprecated.

onToggle

public PopperSingleTypeahead onToggle(ToggleHandler<PopperSingleTypeahead> 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.