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>

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

Method Summary

Modifier and Type	Method	Description
Finder	add(FinderColumn item)
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()
boolean	contains(String identifier)
void	detach(MutationRecord mutationRecord)
static Finder	finder()
boolean	isEmpty()
FinderColumn	item(String identifier)
Iterator<FinderColumn>	iterator()
Finder	onAdd(AddItemHandler<Finder, FinderColumn> onAdd)
Finder	onRemove(RemoveItemHandler<Finder, FinderColumn> onRemove)
Finder	onUpdate(UpdateItemHandler<Finder, FinderColumn> onUpdate)
void	removeItem(String identifier)
int	size()
Finder	that()
void	updateItem(FinderColumn item)

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

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)

Specified by:

add in interface HasItems<HTMLElement, Finder, FinderColumn>

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)

Specified by:

onAdd in interface HasItems<HTMLElement, Finder, FinderColumn>

onUpdate

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

Specified by:

onUpdate in interface HasItems<HTMLElement, Finder, FinderColumn>

onRemove

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

Specified by:

onRemove in interface HasItems<HTMLElement, Finder, FinderColumn>

iterator

public Iterator<FinderColumn> iterator()

Specified by:

iterator in interface Iterable<FinderColumn>

size

public int size()

Specified by:

size in interface HasItems<HTMLElement, Finder, FinderColumn>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement, Finder, FinderColumn>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement, Finder, FinderColumn>

item

public FinderColumn item(String identifier)

Specified by:

item in interface HasItems<HTMLElement, Finder, FinderColumn>

updateItem

public void updateItem(FinderColumn item)

Specified by:

updateItem in interface HasItems<HTMLElement, Finder, FinderColumn>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement, Finder, FinderColumn>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement, Finder, FinderColumn>