Class FinderColumnSearch

java.lang.Object

org.patternfly.component.SubComponent<HTMLElement, FinderColumnSearch>

org.patternfly.extension.finder.FinderColumnSearch

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement, FinderColumnSearch>, ElementClassListMethods<HTMLElement, FinderColumnSearch>, ElementConsumerMethods<HTMLElement, FinderColumnSearch>, ElementContainerMethods<HTMLElement, FinderColumnSearch>, ElementEventMethods<HTMLElement, FinderColumnSearch>, ElementIdMethods<HTMLElement, FinderColumnSearch>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, FinderColumnSearch>, HTMLElementDataMethods<HTMLElement, FinderColumnSearch>, HTMLElementStyleMethods<HTMLElement, FinderColumnSearch>, HTMLElementVisibilityMethods<HTMLElement, FinderColumnSearch>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, FinderColumnSearch>, OuiaSupport<HTMLElement, FinderColumnSearch>

public class FinderColumnSearch
extends SubComponent<HTMLElement, FinderColumnSearch>

The FinderColumnSearch class is a subcomponent designed to handle search functionality within a finder column. It extends the FinderSubComponent class to provide a specialized interface for managing search inputs. The class allows adding SearchInput instances with or without filtering predicates and defines the behavior for filtering FinderItems based on user-provided search values.

The filtering predicate determines how FinderItems are flagged as filtered depending on their text content and the specified search value. When no predicate is provided, the FinderItems are not programmatically filtered on input.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_ID
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
FinderColumnSearch	add(SearchInput input)	Adds a SearchInput instance to the FinderColumnSearch with no specific filtering predicate.
FinderColumnSearch	add(SearchInput input, BiPredicate<FinderItem, String> predicate)	Adds a SearchInput instance to the FinderColumnSearch with a specific filtering predicate.
FinderColumnSearch	addSearchInput(SearchInput input)	Adds a SearchInput instance to the FinderColumnSearch with no specific filtering predicate.
FinderColumnSearch	addSearchInput(SearchInput input, BiPredicate<FinderItem, String> predicate)	Adds a SearchInput instance to the FinderColumnSearch with a specific filtering predicate.
static FinderColumnSearch	finderColumnSearch()
FinderColumnSearch	that()

Methods inherited from class SubComponent

element, ouiaComponentType, registerSubComponent

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

initOuia, initOuia, ouiaId, ouiaSafe, ouiaTransition

Field Details

SUB_COMPONENT_ID

public static final String SUB_COMPONENT_ID

See Also:

• Constant Field Values

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

finderColumnSearch

public static FinderColumnSearch finderColumnSearch()

addSearchInput

public FinderColumnSearch addSearchInput(SearchInput input)

Adds a SearchInput instance to the FinderColumnSearch with no specific filtering predicate.

Parameters:

input - the SearchInput instance to be added

Returns:

the updated FinderColumnSearch instance

add

public FinderColumnSearch add(SearchInput input)

Adds a SearchInput instance to the FinderColumnSearch with no specific filtering predicate.

Parameters:

input - the SearchInput instance to be added

Returns:

the updated FinderColumnSearch instance

addSearchInput

public FinderColumnSearch addSearchInput(SearchInput input,
 BiPredicate<FinderItem, String> predicate)

Adds a SearchInput instance to the FinderColumnSearch with a specific filtering predicate. The filtering predicate is used to determine how FinderItems should be filtered based on their text content and the specified search value. If the filter predicate returns true, the FinderItem will be marked as filtered.

Parameters:

input - the SearchInput instance to be added

predicate - a BiPredicate that defines the filtering logic based on a FinderItem and the given search value

Returns:

the updated FinderColumnSearch instance

add

public FinderColumnSearch add(SearchInput input,
 BiPredicate<FinderItem, String> predicate)

Adds a SearchInput instance to the FinderColumnSearch with a specific filtering predicate. The filtering predicate is used to determine how FinderItems should be filtered based on their text content and the specified search value. If the filter predicate returns true, the FinderItem will be marked as filtered.

Parameters:

input - the SearchInput instance to be added

predicate - a BiPredicate that defines the filtering logic based on a FinderItem and the given search value

Returns:

the updated FinderColumnSearch instance

that

public FinderColumnSearch that()