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>, HasAsyncItems<HTMLElement, FinderColumn, FinderItem>, HasIdentifier<HTMLElement, FinderColumn>, HasItems<HTMLElement, FinderColumn, FinderItem>, Ordered<HTMLElement, FinderColumn, FinderItem>, ComponentContext<HTMLElement, FinderColumn>

public class FinderColumn
extends SubComponent<HTMLElement, FinderColumn>
implements ComponentContext<HTMLElement, FinderColumn>, HasAsyncItems<HTMLElement, FinderColumn, FinderItem>, HasIdentifier<HTMLElement, FinderColumn>, Ordered<HTMLElement, FinderColumn, FinderItem>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_NAME

Fields inherited from interface 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(AsyncItems<FinderColumn, FinderItem> items)
FinderColumn	add(FinderColumnHeader header)
FinderColumn	add(FinderColumnSearch search)
FinderColumn	add(FinderItem item)	Adds an item to the component.
FinderColumn	addHeader(FinderColumnHeader header)
FinderColumn	addSearch(FinderColumnSearch search)
void	clear()	Clears all items from the component.
Comparator<FinderItem>	comparator()	Retrieves the comparator used for ordering elements in a component.
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
static FinderColumn	finderColumn(String identifier)
<T> T	get(String key)	Retrieves the value associated with the given key from the ComponentContext.
boolean	has(String key)	Determines whether a value is stored with the specified key.
String	identifier()	Retrieves the identifier associated with this component.
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
FinderItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<FinderItem>	iterator()
Promise<Iterable<FinderItem>>	load()
FinderColumn	onAdd(AddItemHandler<FinderColumn, FinderItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
FinderColumn	onPreview(PreviewHandler previewHandler)
FinderColumn	onRemove(RemoveItemHandler<FinderColumn, FinderItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
FinderColumn	onSelect(SelectHandler<FinderItem> selectHandler)
FinderColumn	onUpdate(UpdateItemHandler<FinderColumn, FinderItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
FinderColumn	ordered(Comparator<FinderItem> comparator)	Orders the elements contained in the component using the specified comparator.
FinderColumn	pinnable()	Same as pinnable(true)
FinderColumn	pinnable(boolean pinnable)	Adds/removes modifier(pinnable)
Promise<Iterable<FinderItem>>	reload()
void	removeItem(String identifier)	Removes an item from the component based on the provided 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)
int	size()	Retrieves the total number of items currently contained in the component.
AsyncStatus	status()
<T> FinderColumn	store(String key, T value)	Stores a value associated with a key.
FinderColumn	that()
void	updateItem(FinderItem item)	Updates an existing item in the component.

Methods inherited from class SubComponent

element, registerSubComponent

Methods inherited from class Object

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

Methods inherited from interface 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 HasAsyncItems

addItems

Methods inherited from interface 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 Ordered

addOrdered, defaultOrder, ordered

Field Details

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

finderColumn

public static FinderColumn finderColumn(String identifier)

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)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

add

public FinderColumn add(AsyncItems<FinderColumn, FinderItem> items)

Specified by:

add in interface HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

active

public FinderColumn active()

Same as active(true)

active

public FinderColumn active(boolean active)

Adds/removes modifier(active)

ordered

public FinderColumn ordered(Comparator<FinderItem> comparator)

Description copied from interface: Ordered

Orders the elements contained in the component using the specified comparator. The comparator determines the order in which the elements are arranged.

Specified by:

ordered in interface Ordered<HTMLElement, FinderColumn, FinderItem>

Parameters:

comparator - the comparator used to define the ordering of the elements

Returns:

the builder instance with the elements ordered

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)

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<HTMLElement, FinderColumn>

Type Parameters:

T - the type of the value being stored

Parameters:

key - the key associated with the value

value - the value to be stored

that

public FinderColumn that()

Specified by:

that in interface TypedBuilder<HTMLElement, FinderColumn>

onAdd

public FinderColumn onAdd(AddItemHandler<FinderColumn, FinderItem> onAdd)

Description copied from interface: HasItems

Registers a callback to be invoked whenever a new item is added to the component.

Specified by:

onAdd in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

onAdd - a AddItemHandler that takes the builder instance and the item being added as arguments

Returns:

the builder instance after adding the callback

onUpdate

public FinderColumn onUpdate(UpdateItemHandler<FinderColumn, FinderItem> onUpdate)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is updated in the component.

Specified by:

onUpdate in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

onUpdate - a UpdateItemHandler that takes the component, the previous state of the item, and the updated state of the item as arguments

Returns:

the builder instance after adding the callback

onRemove

public FinderColumn onRemove(RemoveItemHandler<FinderColumn, FinderItem> onRemove)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is removed from the component.

Specified by:

onRemove in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

onRemove - a RemoveItemHandler that takes the component and the item being removed as arguments

Returns:

the builder instance after adding the callback

onSelect

public FinderColumn onSelect(SelectHandler<FinderItem> selectHandler)

onPreview

public FinderColumn onPreview(PreviewHandler previewHandler)

comparator

public Comparator<FinderItem> comparator()

Description copied from interface: Ordered

Retrieves the comparator used for ordering elements in a component.

Specified by:

comparator in interface Ordered<HTMLElement, FinderColumn, FinderItem>

Returns:

the comparator that determines the order of elements

load

public Promise<Iterable<FinderItem>> load()

Specified by:

load in interface HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

reload

public Promise<Iterable<FinderItem>> reload()

Specified by:

reload in interface HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

reset

public void reset()

Specified by:

reset in interface HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

status

public AsyncStatus status()

Specified by:

status in interface HasAsyncItems<HTMLElement, FinderColumn, FinderItem>

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<HTMLElement, FinderColumn>

Returns:

the identifier of the component

has

public boolean has(String key)

Description copied from interface: ComponentContext

Determines whether a value is stored with the specified key.

Specified by:

has in interface ComponentContext<HTMLElement, FinderColumn>

Parameters:

key - the key to check

Returns:

true if a value is stored with the specified key, false otherwise

get

public <T> T get(String key)

Description copied from interface: ComponentContext

Retrieves the value associated with the given key from the ComponentContext.

Specified by:

get in interface ComponentContext<HTMLElement, FinderColumn>

Type Parameters:

T - the type of the value being retrieved

Parameters:

key - the key associated with the value

Returns:

the value associated with the key, or null if no value is found

iterator

public Iterator<FinderItem> iterator()

Specified by:

iterator in interface Iterable<FinderItem>

size

public int size()

Description copied from interface: HasItems

Retrieves the total number of items currently contained in the component.

Specified by:

size in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Returns:

the number of items contained in the component

isEmpty

public boolean isEmpty()

Description copied from interface: HasItems

Checks whether the collection of items in the component is empty.

Specified by:

isEmpty in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Returns:

true if the component contains no items; false otherwise

contains

public boolean contains(String identifier)

Description copied from interface: HasItems

Checks whether the component contains an item associated with the given identifier.

Specified by:

contains in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

identifier - the identifier of the item to be checked

Returns:

true if the component contains an item associated with the provided identifier, false otherwise

item

public FinderItem item(String identifier)

Description copied from interface: HasItems

Retrieves the item associated with the specified identifier from the component.

Specified by:

item in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

identifier - the identifier of the item to be retrieved

Returns:

the item associated with the given identifier, or null if no item is found

updateItem

public void updateItem(FinderItem item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

item - the item to be updated

removeItem

public void removeItem(String identifier)

Description copied from interface: HasItems

Removes an item from the component based on the provided identifier.

Specified by:

removeItem in interface HasItems<HTMLElement, FinderColumn, FinderItem>

Parameters:

identifier - the identifier of the item to be removed

clear

public void clear()

Description copied from interface: HasItems

Clears all items from the component. This method removes any existing items within the component, leaving it empty. Any associated or registered callbacks related to the removal of items may be invoked as part of this operation.

Specified by:

clear in interface 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)