Class AlertGroup

java.lang.Object

org.patternfly.component.BaseComponent<HTMLUListElement, AlertGroup>

org.patternfly.component.alert.AlertGroup

All Implemented Interfaces:

Iterable<Alert>, ElementAttributeMethods<HTMLUListElement, AlertGroup>, ElementClassListMethods<HTMLUListElement, AlertGroup>, ElementConsumerMethods<HTMLUListElement, AlertGroup>, ElementContainerMethods<HTMLUListElement, AlertGroup>, ElementEventMethods<HTMLUListElement, AlertGroup>, ElementIdMethods<HTMLUListElement, AlertGroup>, ElementQueryMethods<HTMLUListElement>, HTMLElementAttributeMethods<HTMLUListElement, AlertGroup>, HTMLElementDataMethods<HTMLUListElement, AlertGroup>, HTMLElementStyleMethods<HTMLUListElement, AlertGroup>, HTMLElementVisibilityMethods<HTMLUListElement, AlertGroup>, IsElement<HTMLUListElement>, TypedBuilder<HTMLUListElement, AlertGroup>, Component, HasItems<HTMLUListElement, AlertGroup, Alert>

public class AlertGroup
extends BaseComponent<HTMLUListElement, AlertGroup>
implements HasItems<HTMLUListElement, AlertGroup, Alert>

An alert group stacks and positions 2 or more alerts in a live region, either in a layer over the main content of a page or inline with the page content. Alert groups should always rank alerts by age, stacking new alerts on top of old ones as they surface.

See Also:

• https://www.patternfly.org/components/alert#alert-group-examples

Method Summary

Modifier and Type	Method	Description
AlertGroup	add(Alert alert)
static AlertGroup	alertGroup(AlertGroupType type)	Creates a new alert group of the given type without a timeout.
static AlertGroup	alertGroup(AlertGroupType type, int timeout)	Creates a new alert group of the given type and timeout.
void	clear()
boolean	contains(String identifier)
boolean	isEmpty()
Alert	item(String identifier)
Iterator<Alert>	iterator()
AlertGroup	onAdd(BiConsumer<AlertGroup, Alert> onAdd)
AlertGroup	onRemove(BiConsumer<AlertGroup, Alert> onRemove)
void	removeItem(String identifier)
int	size()
AlertGroup	that()
static AlertGroup	toastAlertGroup()

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

Method Details

alertGroup

public static AlertGroup alertGroup(AlertGroupType type)

Creates a new alert group of the given type without a timeout.

If the type is AlertGroupType.toast the alert group is added to the body or if it already has been added the existing alert group is returned (singleton pattern).

alertGroup

public static AlertGroup alertGroup(AlertGroupType type,
 int timeout)

Creates a new alert group of the given type and timeout.

If the type is AlertGroupType.toast the alert group is added to the body or if it already has been added the existing toast alert group is returned (singleton pattern).

toastAlertGroup

public static AlertGroup toastAlertGroup()

add

public AlertGroup add(Alert alert)

Specified by:

add in interface HasItems<HTMLUListElement, AlertGroup, Alert>

that

public AlertGroup that()

Specified by:

that in interface TypedBuilder<HTMLUListElement, AlertGroup>

onAdd

public AlertGroup onAdd(BiConsumer<AlertGroup, Alert> onAdd)

Specified by:

onAdd in interface HasItems<HTMLUListElement, AlertGroup, Alert>

onRemove

public AlertGroup onRemove(BiConsumer<AlertGroup, Alert> onRemove)

Specified by:

onRemove in interface HasItems<HTMLUListElement, AlertGroup, Alert>

iterator

public Iterator<Alert> iterator()

Specified by:

iterator in interface Iterable<Alert>

size

public int size()

Specified by:

size in interface HasItems<HTMLUListElement, AlertGroup, Alert>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLUListElement, AlertGroup, Alert>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLUListElement, AlertGroup, Alert>

item

public Alert item(String identifier)

Specified by:

item in interface HasItems<HTMLUListElement, AlertGroup, Alert>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLUListElement, AlertGroup, Alert>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLUListElement, AlertGroup, Alert>