Class FinderItem

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLElement, FinderItem>

org.patternfly.extension.finder.FinderItem

All Implemented Interfaces:

ElementAttributeMethods<elemental2.dom.HTMLElement, FinderItem>, ElementClassListMethods<elemental2.dom.HTMLElement, FinderItem>, ElementConsumerMethods<elemental2.dom.HTMLElement, FinderItem>, ElementContainerMethods<elemental2.dom.HTMLElement, FinderItem>, ElementEventMethods<elemental2.dom.HTMLElement, FinderItem>, ElementIdMethods<elemental2.dom.HTMLElement, FinderItem>, ElementQueryMethods<elemental2.dom.HTMLElement>, ElementTextDelegate<elemental2.dom.HTMLElement, FinderItem>, ElementTextMethods<elemental2.dom.HTMLElement, FinderItem>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, FinderItem>, HTMLElementDataMethods<elemental2.dom.HTMLElement, FinderItem>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, FinderItem>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, FinderItem>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, FinderItem>, ComponentIcon<elemental2.dom.HTMLElement, FinderItem>, ComponentContext<elemental2.dom.HTMLElement, FinderItem>, HasIdentifier<elemental2.dom.HTMLElement, FinderItem>, OuiaSupport<elemental2.dom.HTMLElement, FinderItem>

public class FinderItem
extends SubComponent<elemental2.dom.HTMLElement, FinderItem>
implements ComponentContext<elemental2.dom.HTMLElement, FinderItem>, ComponentIcon<elemental2.dom.HTMLElement, FinderItem>, ElementTextDelegate<elemental2.dom.HTMLElement, FinderItem>, HasIdentifier<elemental2.dom.HTMLElement, FinderItem>

An item within a FinderColumn, representing a selectable entry with optional icon, description, and actions.

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
FinderItem	add(FinderItemActions actions)
FinderItem	add(FinderItemDescription description)
FinderItem	addActions(FinderItemActions actions)
FinderItem	addDescription(String description)
FinderItem	addDescription(FinderItemDescription description)
FinderColumn	column()
static FinderItem	emptyItem(EmptyState emptyState)
Finder	finder()
static FinderItem	finderItem(String identifier)
static FinderItem	finderItem(String identifier, String text)
static FinderItem	finderItem(String identifier, String text, String description)
FinderItem	folder()	Same as folder(true)
FinderItem	folder(boolean folder)	Adds/removes modifier(folder)
<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.
FinderItem	icon(elemental2.dom.Element icon)
String	identifier()	Retrieves the identifier associated with this component.
FinderItem	nextColumn(Supplier<FinderColumn> column)
FinderItem	onPreview(PreviewHandler previewHandler)
FinderItem	removeIcon()
<T> FinderItem	store(String key, T value)	Stores a value associated with a key.
elemental2.dom.Element	textDelegate()
FinderItem	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 ComponentContext

get, get

Methods inherited from interface ComponentIcon

icon

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 ElementTextDelegate

text, text

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 OuiaSupport

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

finderItem

public static FinderItem finderItem(String identifier)

finderItem

public static FinderItem finderItem(String identifier,
 String text)

finderItem

public static FinderItem finderItem(String identifier,
 String text,
 String description)

emptyItem

public static FinderItem emptyItem(EmptyState emptyState)

textDelegate

public elemental2.dom.Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<elemental2.dom.HTMLElement, FinderItem>

addDescription

public FinderItem addDescription(String description)

addDescription

public FinderItem addDescription(FinderItemDescription description)

add

public FinderItem add(FinderItemDescription description)

addActions

public FinderItem addActions(FinderItemActions actions)

add

public FinderItem add(FinderItemActions actions)

folder

public FinderItem folder()

Same as folder(true)

folder

public FinderItem folder(boolean folder)

Adds/removes modifier(folder)

icon

public FinderItem icon(elemental2.dom.Element icon)

Specified by:

icon in interface ComponentIcon<elemental2.dom.HTMLElement, FinderItem>

nextColumn

public FinderItem nextColumn(Supplier<FinderColumn> column)

removeIcon

public FinderItem removeIcon()

Specified by:

removeIcon in interface ComponentIcon<elemental2.dom.HTMLElement, FinderItem>

store

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

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<elemental2.dom.HTMLElement, FinderItem>

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 FinderItem that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLElement, FinderItem>

onPreview

public FinderItem onPreview(PreviewHandler previewHandler)

column

public FinderColumn column()

finder

public Finder finder()

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLElement, FinderItem>

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<elemental2.dom.HTMLElement, FinderItem>

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<elemental2.dom.HTMLElement, FinderItem>

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