Class ToggleGroup

java.lang.Object

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

org.patternfly.component.togglegroup.ToggleGroup

All Implemented Interfaces:

Iterable<ToggleGroupItem>, ElementAttributeMethods<HTMLElement, ToggleGroup>, ElementClassListMethods<HTMLElement, ToggleGroup>, ElementConsumerMethods<HTMLElement, ToggleGroup>, ElementContainerMethods<HTMLElement, ToggleGroup>, ElementEventMethods<HTMLElement, ToggleGroup>, ElementIdMethods<HTMLElement, ToggleGroup>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, ToggleGroup>, HTMLElementDataMethods<HTMLElement, ToggleGroup>, HTMLElementStyleMethods<HTMLElement, ToggleGroup>, HTMLElementVisibilityMethods<HTMLElement, ToggleGroup>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, ToggleGroup>, Component, HasItems<HTMLElement, ToggleGroup, ToggleGroupItem>, org.patternfly.core.OuiaSupport<HTMLElement, ToggleGroup>, org.patternfly.style.Modifiers.Compact<HTMLElement, ToggleGroup>, org.patternfly.style.Modifiers.Disabled<HTMLElement, ToggleGroup>, org.patternfly.style.Modifiers.FullWidth<HTMLElement, ToggleGroup>

public class ToggleGroup
extends BaseComponent<HTMLElement, ToggleGroup>
implements org.patternfly.style.Modifiers.Compact<HTMLElement, ToggleGroup>, org.patternfly.style.Modifiers.Disabled<HTMLElement, ToggleGroup>, org.patternfly.style.Modifiers.FullWidth<HTMLElement, ToggleGroup>, HasItems<HTMLElement, ToggleGroup, ToggleGroupItem>

A toggle group is a group of controls that can be used to quickly switch between actions or states.

See Also:

• https://www.patternfly.org/components/toggle-group

Method Summary

Modifier and Type	Method	Description
ToggleGroup	add(ToggleGroupItem item)	Adds an item to the component.
ToggleGroup	ariaLabel(String label)
void	clear()	Clears all items from the component.
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
ToggleGroup	disabled(boolean disabled)
boolean	isDisabled()
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
ToggleGroupItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<ToggleGroupItem>	iterator()
ToggleGroup	onAdd(AddItemHandler<ToggleGroup, ToggleGroupItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
ToggleGroup	onMultiSelect(org.patternfly.handler.MultiSelectHandler<ToggleGroup, ToggleGroupItem> selectHandler)
ToggleGroup	onRemove(RemoveItemHandler<ToggleGroup, ToggleGroupItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
ToggleGroup	onSingleSelect(org.patternfly.handler.SelectHandler<ToggleGroupItem> selectHandler)
ToggleGroup	onUpdate(UpdateItemHandler<ToggleGroup, ToggleGroupItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
void	removeItem(String identifier)	Removes an item from the component based on the provided identifier.
void	select(String identifier)
void	select(String identifier, boolean selected)
void	select(String identifier, boolean selected, boolean fireEvent)
void	select(ToggleGroupItem item)
void	select(ToggleGroupItem item, boolean selected)
void	select(ToggleGroupItem item, boolean selected, boolean fireEvent)
int	size()	Retrieves the total number of items currently contained in the component.
ToggleGroup	that()
static ToggleGroup	toggleGroup(SelectionMode selectionMode)
void	updateItem(ToggleGroupItem item)	Updates an existing item in the component.

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, 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 org.patternfly.style.Modifiers.Compact

compact, compact

Methods inherited from interface org.patternfly.style.Modifiers.Disabled

disabled

Methods inherited from interface org.patternfly.style.Modifiers.FullWidth

fullWidth, fullWidth

Methods inherited from interface org.patternfly.core.OuiaSupport

initOuia, initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

toggleGroup

public static ToggleGroup toggleGroup(SelectionMode selectionMode)

add

public ToggleGroup add(ToggleGroupItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, ToggleGroup, ToggleGroupItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

disabled

public ToggleGroup disabled(boolean disabled)

Specified by:

disabled in interface org.patternfly.style.Modifiers.Disabled<HTMLElement, ToggleGroup>

that

public ToggleGroup that()

Specified by:

that in interface TypedBuilder<HTMLElement, ToggleGroup>

ariaLabel

public ToggleGroup ariaLabel(String label)

onAdd

public ToggleGroup onAdd(AddItemHandler<ToggleGroup, ToggleGroupItem> 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, ToggleGroup, ToggleGroupItem>

Parameters:

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

Returns:

the builder instance after adding the callback

onMultiSelect

public ToggleGroup onMultiSelect(org.patternfly.handler.MultiSelectHandler<ToggleGroup, ToggleGroupItem> selectHandler)

onUpdate

public ToggleGroup onUpdate(UpdateItemHandler<ToggleGroup, ToggleGroupItem> 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, ToggleGroup, ToggleGroupItem>

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 ToggleGroup onRemove(RemoveItemHandler<ToggleGroup, ToggleGroupItem> 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, ToggleGroup, ToggleGroupItem>

Parameters:

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

Returns:

the builder instance after adding the callback

onSingleSelect

public ToggleGroup onSingleSelect(org.patternfly.handler.SelectHandler<ToggleGroupItem> selectHandler)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface org.patternfly.style.Modifiers.Disabled<HTMLElement, ToggleGroup>

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

select

public void select(ToggleGroupItem item,
 boolean selected)

select

public void select(ToggleGroupItem item,
 boolean selected,
 boolean fireEvent)

iterator

public Iterator<ToggleGroupItem> iterator()

Specified by:

iterator in interface Iterable<ToggleGroupItem>

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, ToggleGroup, ToggleGroupItem>

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, ToggleGroup, ToggleGroupItem>

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, ToggleGroup, ToggleGroupItem>

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 ToggleGroupItem 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, ToggleGroup, ToggleGroupItem>

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

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, ToggleGroup, ToggleGroupItem>

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, ToggleGroup, ToggleGroupItem>

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, ToggleGroup, ToggleGroupItem>