Package org.patternfly.component.togglegroup

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>, Modifiers.Compact<HTMLElement,ToggleGroup>, Modifiers.Disabled<HTMLElement,ToggleGroup>

public class ToggleGroup
extends BaseComponent<HTMLElement,ToggleGroup>
implements Modifiers.Compact<HTMLElement,ToggleGroup>, Modifiers.Disabled<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)
ToggleGroup	ariaLabel(String label)
void	clear()
boolean	contains(String identifier)
ToggleGroup	disabled(boolean disabled)
boolean	isDisabled()
boolean	isEmpty()
ToggleGroupItem	item(String identifier)
Iterator<ToggleGroupItem>	iterator()
ToggleGroup	onAdd(BiConsumer<ToggleGroup,ToggleGroupItem> onAdd)
ToggleGroup	onMultiSelect(MultiSelectHandler<ToggleGroup,ToggleGroupItem> selectHandler)
ToggleGroup	onRemove(BiConsumer<ToggleGroup,ToggleGroupItem> onRemove)
ToggleGroup	onSingleSelect(SelectHandler<ToggleGroupItem> selectHandler)
void	removeItem(String 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()
ToggleGroup	that()
static ToggleGroup	toggleGroup(SelectionMode selectionMode)

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element, registerComponent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.HasItems

addItem, addItems, items

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

compact, compact

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

disabled

Method Details

toggleGroup

public static ToggleGroup toggleGroup(SelectionMode selectionMode)

add

public ToggleGroup add(ToggleGroupItem item)

Specified by:

add in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

disabled

public ToggleGroup disabled(boolean disabled)

Specified by:

disabled in interface 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(BiConsumer<ToggleGroup,ToggleGroupItem> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

onMultiSelect

public ToggleGroup onMultiSelect(MultiSelectHandler<ToggleGroup,ToggleGroupItem> selectHandler)

onRemove

public ToggleGroup onRemove(BiConsumer<ToggleGroup,ToggleGroupItem> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

onSingleSelect

public ToggleGroup onSingleSelect(SelectHandler<ToggleGroupItem> selectHandler)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface 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()

Specified by:

size in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

item

public ToggleGroupItem item(String identifier)

Specified by:

item in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement,ToggleGroup,ToggleGroupItem>