Class FinderColumn

java.lang.Object

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

org.patternfly.extension.finder.FinderColumn

All Implemented Interfaces:

Iterable<FinderItem>, ElementAttributeMethods<HTMLElement, FinderColumn>, ElementClassListMethods<HTMLElement, FinderColumn>, ElementConsumerMethods<HTMLElement, FinderColumn>, ElementContainerMethods<HTMLElement, FinderColumn>, ElementEventMethods<HTMLElement, FinderColumn>, ElementIdMethods<HTMLElement, FinderColumn>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, FinderColumn>, HTMLElementDataMethods<HTMLElement, FinderColumn>, HTMLElementStyleMethods<HTMLElement, FinderColumn>, HTMLElementVisibilityMethods<HTMLElement, FinderColumn>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, FinderColumn>, org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>, org.patternfly.component.HasIdentifier<HTMLElement, FinderColumn>, org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>, org.patternfly.component.Ordered<HTMLElement, FinderColumn, FinderItem>, org.patternfly.core.ComponentContext<HTMLElement, FinderColumn>, org.patternfly.core.OuiaSupport<HTMLElement, FinderColumn>

public class FinderColumn
extends org.patternfly.component.SubComponent<HTMLElement, FinderColumn>
implements org.patternfly.core.ComponentContext<HTMLElement, FinderColumn>, org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>, org.patternfly.component.HasIdentifier<HTMLElement, FinderColumn>, org.patternfly.component.Ordered<HTMLElement, FinderColumn, FinderItem>

A column in the Finder, displaying a list of FinderItems that can be selected, filtered, and sorted.

Field Summary

Fields

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

Fields inherited from interface org.patternfly.component.Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
FinderColumn	active()	Same as active(true)
FinderColumn	active(boolean active)	Adds/removes modifier(active)
FinderColumn	add(org.patternfly.component.AsyncItems<FinderColumn, FinderItem> items)
FinderColumn	add(FinderColumnHeader header)
FinderColumn	add(FinderColumnSearch search)
FinderColumn	add(FinderItem item)
FinderColumn	addHeader(FinderColumnHeader header)
FinderColumn	addSearch(FinderColumnSearch search)
void	clear()
Comparator<FinderItem>	comparator()
boolean	contains(String identifier)
FinderColumn	defaultSearch()	Same as defaultSearch("Filter by name")
FinderColumn	defaultSearch(String placeholder)	Configures the current FinderColumn instance with a default search functionality.
Finder	finder()
static FinderColumn	finderColumn(String identifier)
static FinderColumn	finderColumn(String identifier, String header)
<T> T	get(String key)
boolean	has(String key)
String	identifier()
boolean	isEmpty()
FinderItem	item(String identifier)
Iterator<FinderItem>	iterator()
Promise<Iterable<FinderItem>>	load()
FinderColumn	onAdd(org.patternfly.component.AddItemHandler<FinderColumn, FinderItem> onAdd)
FinderColumn	onPreview(PreviewHandler previewHandler)
FinderColumn	onRemove(org.patternfly.component.RemoveItemHandler<FinderColumn, FinderItem> onRemove)
FinderColumn	onSelect(org.patternfly.handler.SelectHandler<FinderItem> selectHandler)
FinderColumn	onUpdate(org.patternfly.component.UpdateItemHandler<FinderColumn, FinderItem> onUpdate)
FinderColumn	ordered(Comparator<FinderItem> comparator)
FinderColumn	pinnable()	Same as pinnable(true)
FinderColumn	pinnable(boolean pinnable)	Adds/removes modifier(pinnable)
Promise<Iterable<FinderItem>>	reload()
void	removeItem(String identifier)
void	reset()
void	select(String identifier)
void	select(String identifier, boolean selected)
void	select(String identifier, boolean selected, boolean fireEvent)
void	select(FinderItem item)
void	select(FinderItem item, boolean selected)
void	select(FinderItem item, boolean selected, boolean fireEvent)
FinderColumn	showSearchThreshold(int size)	Configures the current FinderColumn instance to show the search component when the size of the items in the column is greater than or equal to the specified value.
int	size()
org.patternfly.core.AsyncStatus	status()
<T> FinderColumn	store(String key, T value)
FinderColumn	that()
FinderColumn	toggleSearch(Predicate<FinderColumn> predicate)	Toggles the visibility of the search component in the column based on the provided predicate.
void	updateItem(FinderItem item)

Methods inherited from class org.patternfly.component.SubComponent

element, ouiaComponentType, registerSubComponent

Methods inherited from class Object

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

Methods inherited from interface org.patternfly.core.ComponentContext

get, get

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 org.patternfly.component.HasAsyncItems

addItems

Methods inherited from interface org.patternfly.component.HasItems

addItem, addItems, items, replaceItemElement, updateItem, updateItem

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 Iterable

forEach, spliterator

Methods inherited from interface org.patternfly.component.Ordered

addOrdered, defaultOrder, ordered

Methods inherited from interface org.patternfly.core.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

finderColumn

public static FinderColumn finderColumn(String identifier)

finderColumn

public static FinderColumn finderColumn(String identifier,
 String header)

addHeader

public FinderColumn addHeader(FinderColumnHeader header)

add

public FinderColumn add(FinderColumnHeader header)

addSearch

public FinderColumn addSearch(FinderColumnSearch search)

add

public FinderColumn add(FinderColumnSearch search)

add

public FinderColumn add(FinderItem item)

Specified by:

add in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

add

public FinderColumn add(org.patternfly.component.AsyncItems<FinderColumn, FinderItem> items)

Specified by:

add in interface org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

active

public FinderColumn active()

Same as active(true)

active

public FinderColumn active(boolean active)

Adds/removes modifier(active)

defaultSearch

public FinderColumn defaultSearch()

Same as defaultSearch("Filter by name")

Returns:

the current FinderColumn instance with the default search functionality added

defaultSearch

public FinderColumn defaultSearch(String placeholder)

Configures the current FinderColumn instance with a default search functionality. The search functionality allows filtering of items in the column based on the content of a search input field. The provided placeholder text for the search input is used to indicate the purpose of the search field to the user.

Parameters:

placeholder - the placeholder text to display in the search input field

Returns:

the current FinderColumn instance with the configured default search functionality

ordered

public FinderColumn ordered(Comparator<FinderItem> comparator)

Specified by:

ordered in interface org.patternfly.component.Ordered<HTMLElement, FinderColumn, FinderItem>

pinnable

public FinderColumn pinnable()

Same as pinnable(true)

pinnable

public FinderColumn pinnable(boolean pinnable)

Adds/removes modifier(pinnable)

store

public <T> FinderColumn store(String key,
 T value)

Specified by:

store in interface org.patternfly.core.ComponentContext<HTMLElement, FinderColumn>

showSearchThreshold

public FinderColumn showSearchThreshold(int size)

Configures the current FinderColumn instance to show the search component when the size of the items in the column is greater than or equal to the specified value. The visibility condition is evaluated based on the number of items in the column.

If no search component is present in the column, this method does nothing.

Parameters:

size - the minimum number of items required in the column to show the search component

Returns:

the current FinderColumn instance with updated search visibility configuration

toggleSearch

public FinderColumn toggleSearch(Predicate<FinderColumn> predicate)

Toggles the visibility of the search component in the column based on the provided predicate. The predicate is evaluated against the current column and determines whether the search component should be visible. Additionally, the visibility of the search component reacts to items being added to or removed from the column.

If no search component is present in the column, this method does nothing.

Parameters:

predicate - a Predicate that evaluates the visibility condition for the search component based on the current FinderColumn

Returns:

the current FinderColumn instance with updated search visibility

that

public FinderColumn that()

Specified by:

that in interface TypedBuilder<HTMLElement, FinderColumn>

onAdd

public FinderColumn onAdd(org.patternfly.component.AddItemHandler<FinderColumn, FinderItem> onAdd)

Specified by:

onAdd in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

onUpdate

public FinderColumn onUpdate(org.patternfly.component.UpdateItemHandler<FinderColumn, FinderItem> onUpdate)

Specified by:

onUpdate in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

onRemove

public FinderColumn onRemove(org.patternfly.component.RemoveItemHandler<FinderColumn, FinderItem> onRemove)

Specified by:

onRemove in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

onSelect

public FinderColumn onSelect(org.patternfly.handler.SelectHandler<FinderItem> selectHandler)

onPreview

public FinderColumn onPreview(PreviewHandler previewHandler)

finder

public Finder finder()

comparator

public Comparator<FinderItem> comparator()

Specified by:

comparator in interface org.patternfly.component.Ordered<HTMLElement, FinderColumn, FinderItem>

load

public Promise<Iterable<FinderItem>> load()

Specified by:

load in interface org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

reload

public Promise<Iterable<FinderItem>> reload()

Specified by:

reload in interface org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

reset

public void reset()

Specified by:

reset in interface org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

status

public org.patternfly.core.AsyncStatus status()

Specified by:

status in interface org.patternfly.component.HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

identifier

public String identifier()

Specified by:

identifier in interface org.patternfly.component.HasIdentifier<HTMLElement, FinderColumn>

has

public boolean has(String key)

Specified by:

has in interface org.patternfly.core.ComponentContext<HTMLElement, FinderColumn>

get

public <T> T get(String key)

Specified by:

get in interface org.patternfly.core.ComponentContext<HTMLElement, FinderColumn>

iterator

public Iterator<FinderItem> iterator()

Specified by:

iterator in interface Iterable<FinderItem>

size

public int size()

Specified by:

size in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

item

public FinderItem item(String identifier)

Specified by:

item in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

updateItem

public void updateItem(FinderItem item)

Specified by:

updateItem in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

clear

public void clear()

Specified by:

clear in interface org.patternfly.component.HasItems<HTMLElement, FinderColumn, FinderItem>

select

public void select(String identifier)

select

public void select(String identifier,
 boolean selected)

select

public void select(String identifier,
 boolean selected,
 boolean fireEvent)

select

public void select(FinderItem item)

select

public void select(FinderItem item,
 boolean selected)

select

public void select(FinderItem item,
 boolean selected,
 boolean fireEvent)