Class Finder

java.lang.Object

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

org.patternfly.extension.finder.Finder

All Implemented Interfaces:

Iterable<FinderColumn>, Attachable, ElementAttributeMethods<HTMLElement, Finder>, ElementClassListMethods<HTMLElement, Finder>, ElementConsumerMethods<HTMLElement, Finder>, ElementContainerMethods<HTMLElement, Finder>, ElementEventMethods<HTMLElement, Finder>, ElementIdMethods<HTMLElement, Finder>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, Finder>, HTMLElementDataMethods<HTMLElement, Finder>, HTMLElementStyleMethods<HTMLElement, Finder>, HTMLElementVisibilityMethods<HTMLElement, Finder>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, Finder>, Component, HasItems<HTMLElement, Finder, FinderColumn>, Modifiers.Bordered<HTMLElement, Finder>

public class Finder
extends BaseComponent<HTMLElement, Finder>
implements Attachable, Modifiers.Bordered<HTMLElement, Finder>, HasItems<HTMLElement, Finder, FinderColumn>

Method Summary

Modifier and Type	Method	Description
Finder	add(FinderColumn item)	Adds an item to the component.
Finder	add(FinderPreview preview)	Adds the specified FinderPreview instance to the finder.
Finder	addColumn(FinderColumn column)	Same as HasItems.addItem(HasIdentifier)
<T> Finder	addColumns(Iterable<T> items, Function<T, FinderColumn> display)	Same as HasItems.addItems(Iterable, Function)
Finder	addPreview(FinderPreview preview)	Adds the specified FinderPreview instance to the finder.
void	attach(MutationRecord mutationRecord)
void	clear()	Clears all items from the component.
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
void	detach(MutationRecord mutationRecord)
static Finder	finder()
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
FinderColumn	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<FinderColumn>	iterator()
Finder	onAdd(AddItemHandler<Finder, FinderColumn> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
Finder	onRemove(RemoveItemHandler<Finder, FinderColumn> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
Finder	onUpdate(UpdateItemHandler<Finder, FinderColumn> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
FinderPath	path()
void	removeItem(String identifier)	Removes an item from the component based on the provided identifier.
int	size()	Retrieves the total number of items currently contained in the component.
Finder	that()
void	updateItem(FinderColumn item)	Updates an existing item in the component.

Methods inherited from class BaseComponent

componentType, element, registerComponent

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 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 Modifiers.Bordered

bordered, bordered

Method Details

finder

public static Finder finder()

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addColumns

public <T> Finder addColumns(Iterable<T> items,
 Function<T, FinderColumn> display)

Same as HasItems.addItems(Iterable, Function)

addColumn

public Finder addColumn(FinderColumn column)

Same as HasItems.addItem(HasIdentifier)

add

public Finder add(FinderColumn item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, Finder, FinderColumn>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

addPreview

public Finder addPreview(FinderPreview preview)

Adds the specified FinderPreview instance to the finder. This method ensures that any previously added preview is safely removed before adding the new one.

Parameters:

preview - the FinderPreview instance to add. Represents the preview component to be added to the finder.

Returns:

the current Finder instance, allowing for method chaining.

add

public Finder add(FinderPreview preview)

Adds the specified FinderPreview instance to the finder. This method ensures that any previously added preview is safely removed before adding the new one.

Preview can be managed on a column basis by using FinderColumn.onPreview(PreviewHandler) or on an item basis by using FinderItem.onPreview(PreviewHandler).

Parameters:

preview - the FinderPreview instance to add. Represents the preview component to be added to the finder.

Returns:

the current Finder instance, allowing for method chaining.

that

public Finder that()

Specified by:

that in interface TypedBuilder<HTMLElement, Finder>

onAdd

public Finder onAdd(AddItemHandler<Finder, FinderColumn> 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, Finder, FinderColumn>

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 Finder onUpdate(UpdateItemHandler<Finder, FinderColumn> 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, Finder, FinderColumn>

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 Finder onRemove(RemoveItemHandler<Finder, FinderColumn> 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, Finder, FinderColumn>

Parameters:

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

Returns:

the builder instance after adding the callback

path

public FinderPath path()

iterator

public Iterator<FinderColumn> iterator()

Specified by:

iterator in interface Iterable<FinderColumn>

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, Finder, FinderColumn>

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, Finder, FinderColumn>

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, Finder, FinderColumn>

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 FinderColumn 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, Finder, FinderColumn>

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(FinderColumn item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, Finder, FinderColumn>

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, Finder, FinderColumn>

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, Finder, FinderColumn>