Class SearchInputGroupTypeahead

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement, SearchInputGroupTypeahead>

org.patternfly.component.textinputgroup.BaseTextInputGroup<SearchInputGroupTypeahead>

org.patternfly.component.textinputgroup.BaseSearchInputGroup<SearchInputGroupTypeahead>

org.patternfly.component.textinputgroup.SearchInputGroupTypeahead

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLElement, SearchInputGroupTypeahead>, ElementClassListMethods<HTMLElement, SearchInputGroupTypeahead>, ElementConsumerMethods<HTMLElement, SearchInputGroupTypeahead>, ElementContainerMethods<HTMLElement, SearchInputGroupTypeahead>, ElementEventMethods<HTMLElement, SearchInputGroupTypeahead>, ElementIdMethods<HTMLElement, SearchInputGroupTypeahead>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, SearchInputGroupTypeahead>, HTMLElementDataMethods<HTMLElement, SearchInputGroupTypeahead>, HTMLElementStyleMethods<HTMLElement, SearchInputGroupTypeahead>, HTMLElementVisibilityMethods<HTMLElement, SearchInputGroupTypeahead>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, SearchInputGroupTypeahead>, Component, ComponentIcon<HTMLElement, SearchInputGroupTypeahead>, Expandable<HTMLElement, SearchInputGroupTypeahead>, Typeahead<SearchInputGroupTypeahead>, Validatable<HTMLElement, SearchInputGroupTypeahead>, HasValue<String>, OuiaSupport<HTMLElement, SearchInputGroupTypeahead>, Modifiers.Disabled<HTMLElement, SearchInputGroupTypeahead>, Modifiers.Plain<HTMLElement, SearchInputGroupTypeahead>

public class SearchInputGroupTypeahead
extends BaseSearchInputGroup<SearchInputGroupTypeahead>
implements Attachable, Expandable<HTMLElement, SearchInputGroupTypeahead>, Typeahead<SearchInputGroupTypeahead>

A search input with typeahead/autocomplete support. Combines a search input with an attached Menu to provide autocomplete behavior driven by a RefreshStrategy.

See Also:

• https://www.patternfly.org/components/search-input/

Method Summary

Modifier and Type	Method	Description
SearchInputGroupTypeahead	add(Menu menu)
SearchInputGroupTypeahead	addMenu(Menu menu)
void	attach(MutationRecord mutationRecord)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
void	expand(boolean fireEvent)
SearchInputGroupTypeahead	filter(SearchFilter searchFilter)	Sets the filter used to match existing menu items against the current input value.
Menu	menu()
SearchInputGroupTypeahead	onLoaded(ComponentHandler<SearchInputGroupTypeahead> handler)	Adds a handler called when the menu has finished loading its items.
SearchInputGroupTypeahead	onNoResults(NoResults noResults)	Configures the behavior for generating a "no results" menu item when no matching items are found.
SearchInputGroupTypeahead	onToggle(ToggleHandler<SearchInputGroupTypeahead> handler)	Adds a handler called when the typeahead menu is expanded or collapsed.
SearchInputGroupTypeahead	refreshOn(RefreshStrategy strategy)	Sets the refresh strategy for asynchronously loaded items.
static SearchInputGroupTypeahead	searchInputGroupTypeahead(String id)
static SearchInputGroupTypeahead	searchInputTypeahead(String id, String placeholder)
SearchInputGroupTypeahead	stayOpen(StayOpenPredicate<SearchInputGroupTypeahead> stayOpen)
SearchInputGroupTypeahead	that()
SearchInputGroupTypeahead	value(String value, boolean fireEvent)

Methods inherited from class BaseSearchInputGroup

noDefaultOnClear, onClear, showUtilitiesIf, value

Methods inherited from class BaseTextInputGroup

add, addUtilities, applyTo, disabled, icon, input, onChange, onInput, onKeydown, onKeyup, placeholder, removeIcon, resetValidation, utilities, validated, value

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, registerComponent

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ComponentIcon

icon

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, isDisabled

Methods inherited from interface Modifiers.Plain

plain, plain

Methods inherited from interface OuiaSupport

initOuia, initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

searchInputGroupTypeahead

public static SearchInputGroupTypeahead searchInputGroupTypeahead(String id)

searchInputTypeahead

public static SearchInputGroupTypeahead searchInputTypeahead(String id,
 String placeholder)

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

add

public SearchInputGroupTypeahead add(Menu menu)

refreshOn

public SearchInputGroupTypeahead refreshOn(RefreshStrategy strategy)

Description copied from interface: Typeahead

Sets the refresh strategy for asynchronously loaded items.

Specified by:

refreshOn in interface Typeahead<SearchInputGroupTypeahead>

filter

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

onNoResults

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

stayOpen

public SearchInputGroupTypeahead stayOpen(StayOpenPredicate<SearchInputGroupTypeahead> stayOpen)

that

public SearchInputGroupTypeahead that()

Specified by:

that in interface TypedBuilder<HTMLElement, SearchInputGroupTypeahead>

onLoaded

public SearchInputGroupTypeahead onLoaded(ComponentHandler<SearchInputGroupTypeahead> handler)

Description copied from interface: Typeahead

Adds a handler called when the menu has finished loading its items.

Specified by:

onLoaded in interface Typeahead<SearchInputGroupTypeahead>

onToggle

public SearchInputGroupTypeahead onToggle(ToggleHandler<SearchInputGroupTypeahead> handler)

Description copied from interface: Typeahead

Adds a handler called when the typeahead menu is expanded or collapsed.

Specified by:

onToggle in interface Typeahead<SearchInputGroupTypeahead>

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement, SearchInputGroupTypeahead>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement, SearchInputGroupTypeahead>

menu

public Menu menu()

value

public SearchInputGroupTypeahead value(String value,
 boolean fireEvent)

Overrides:

value in class BaseSearchInputGroup<SearchInputGroupTypeahead>