Class ToggleGroupItem

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLDivElement, ToggleGroupItem>

org.patternfly.component.togglegroup.ToggleGroupItem

All Implemented Interfaces:

ElementAttributeMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementClassListMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementConsumerMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementContainerDelegate<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementContainerMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementEventMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementIdMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementQueryMethods<elemental2.dom.HTMLDivElement>, ElementTextMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, HTMLElementAttributeMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, HTMLElementDataMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, HTMLElementStyleMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, HTMLElementVisibilityMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, IsElement<elemental2.dom.HTMLDivElement>, TypedBuilder<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ComponentIcon<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ComponentIconAndText<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ComponentContext<elemental2.dom.HTMLDivElement, ToggleGroupItem>, HasIdentifier<elemental2.dom.HTMLDivElement, ToggleGroupItem>, OuiaSupport<elemental2.dom.HTMLDivElement, ToggleGroupItem>, Modifiers.Disabled<elemental2.dom.HTMLDivElement, ToggleGroupItem>

public class ToggleGroupItem
extends SubComponent<elemental2.dom.HTMLDivElement, ToggleGroupItem>
implements ComponentContext<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ComponentIcon<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ComponentIconAndText<elemental2.dom.HTMLDivElement, ToggleGroupItem>, Modifiers.Disabled<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementContainerDelegate<elemental2.dom.HTMLDivElement, ToggleGroupItem>, ElementTextMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>, HasIdentifier<elemental2.dom.HTMLDivElement, ToggleGroupItem>

A toggle group item within a ToggleGroup component.

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
elemental2.dom.Element	containerDelegate()
ToggleGroupItem	disabled(boolean disabled)	Adds/removes modifier(disabled)
<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.
ToggleGroupItem	icon(elemental2.dom.Element icon)
ToggleGroupItem	iconAndText(elemental2.dom.Element icon, String text, IconPosition iconPosition)
String	identifier()	Retrieves the identifier associated with this component.
boolean	isDisabled()
ToggleGroupItem	onClick(ComponentHandler<ToggleGroupItem> clickHandler)
ToggleGroupItem	removeIcon()
<T> ToggleGroupItem	store(String key, T value)	Stores a value associated with a key.
String	text()
ToggleGroupItem	text(String text)
ToggleGroupItem	that()
static ToggleGroupItem	toggleGroupItem(String identifier)
static ToggleGroupItem	toggleGroupItem(String identifier, String text)

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 ComponentIconAndText

iconAndText, iconAndText

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 ElementContainerDelegate

add, add, add

Methods inherited from interface ElementContainerMethods

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

disabled

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

toggleGroupItem

public static ToggleGroupItem toggleGroupItem(String identifier)

toggleGroupItem

public static ToggleGroupItem toggleGroupItem(String identifier,
 String text)

containerDelegate

public elemental2.dom.Element containerDelegate()

Specified by:

containerDelegate in interface ElementContainerDelegate<elemental2.dom.HTMLDivElement, ToggleGroupItem>

disabled

public ToggleGroupItem disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<elemental2.dom.HTMLDivElement, ToggleGroupItem>

icon

public ToggleGroupItem icon(elemental2.dom.Element icon)

Specified by:

icon in interface ComponentIcon<elemental2.dom.HTMLDivElement, ToggleGroupItem>

iconAndText

public ToggleGroupItem iconAndText(elemental2.dom.Element icon,
 String text,
 IconPosition iconPosition)

Specified by:

iconAndText in interface ComponentIconAndText<elemental2.dom.HTMLDivElement, ToggleGroupItem>

removeIcon

public ToggleGroupItem removeIcon()

Specified by:

removeIcon in interface ComponentIcon<elemental2.dom.HTMLDivElement, ToggleGroupItem>

text

public ToggleGroupItem text(String text)

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>

store

public <T> ToggleGroupItem 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.HTMLDivElement, ToggleGroupItem>

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

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLDivElement, ToggleGroupItem>

onClick

public ToggleGroupItem onClick(ComponentHandler<ToggleGroupItem> clickHandler)

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLDivElement, ToggleGroupItem>

Returns:

the identifier of the component

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Modifiers.Disabled<elemental2.dom.HTMLDivElement, ToggleGroupItem>

text

public String text()

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLDivElement, ToggleGroupItem>

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.HTMLDivElement, ToggleGroupItem>

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.HTMLDivElement, ToggleGroupItem>

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