Package org.patternfly.component.alert

Class Alert

java.lang.Object

org.patternfly.component.BaseComponent<elemental2.dom.HTMLDivElement,Alert>

org.patternfly.component.alert.Alert

All Implemented Interfaces:

Attachable, Container<elemental2.dom.HTMLDivElement,Alert>, Finder<elemental2.dom.HTMLDivElement>, HasElement<elemental2.dom.HTMLDivElement,Alert>, HasHTMLElement<elemental2.dom.HTMLDivElement,Alert>, IsElement<elemental2.dom.HTMLDivElement>, TypedBuilder<elemental2.dom.HTMLDivElement,Alert>, Closeable<elemental2.dom.HTMLDivElement,Alert>, Component, Expandable<elemental2.dom.HTMLDivElement,Alert>, WithIcon<elemental2.dom.HTMLDivElement,Alert>, WithIdentifier<elemental2.dom.HTMLDivElement,Alert>, ComponentContext<elemental2.dom.HTMLDivElement,Alert>, Modifiers.Inline<elemental2.dom.HTMLDivElement,Alert>, Modifiers.Plain<elemental2.dom.HTMLDivElement,Alert>

public class Alert
extends BaseComponent<elemental2.dom.HTMLDivElement,Alert>
implements ComponentContext<elemental2.dom.HTMLDivElement,Alert>, Modifiers.Inline<elemental2.dom.HTMLDivElement,Alert>, Modifiers.Plain<elemental2.dom.HTMLDivElement,Alert>, Closeable<elemental2.dom.HTMLDivElement,Alert>, Expandable<elemental2.dom.HTMLDivElement,Alert>, Attachable, WithIdentifier<elemental2.dom.HTMLDivElement,Alert>, WithIcon<elemental2.dom.HTMLDivElement,Alert>

An alert is a notification that provides brief information to the user without blocking their workflow.

See Also:

• https://www.patternfly.org/components/alert

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
Alert	add(AlertDescription description)
Alert	addActionGroup(AlertActionGroup actionGroup)
Alert	addDescription(String description)	Wraps the description inside a <p/> element, adds it to a AlertDescription and finally adds it to this alert.
Alert	addDescription(AlertDescription description)
static Alert	alert(Severity type, String title)
static Alert	alert(Severity type, String identifier, String title)
Alert	ariaCloseLabel(String label)
Alert	ariaLabel(String label)
void	attach(elemental2.dom.MutationRecord mutationRecord)
Alert	closable()
Alert	closable(CloseHandler<Alert> closeHandler)
void	close(elemental2.dom.Event event, boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(elemental2.dom.MutationRecord mutationRecord)
void	expand(boolean fireEvent)
Alert	expandable()
Alert	expandable(ToggleHandler<Alert> toggleHandler)
<T> T	get(String key)
boolean	has(String key)
Alert	icon(elemental2.dom.Element icon)
String	identifier()
Alert	liveRegion()	Make this alert a live region alert.
Alert	onClose(CloseHandler<Alert> closeHandler)
Alert	removeIcon()
<T> Alert	store(String key, T value)
Alert	that()
Alert	timeout()
Alert	timeout(int timeout)
Alert	truncate()
Alert	truncate(int lines)

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.patternfly.component.Closeable

close, close

Methods inherited from interface org.patternfly.core.ComponentContext

get, get

Methods inherited from interface org.jboss.elemento.Container

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

Methods inherited from interface org.patternfly.component.Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, innerHtml, on, on, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

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

inline, inline

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

plain, plain

Methods inherited from interface org.patternfly.component.WithIcon

icon

Field Details

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

• Constant Field Values

Method Details

alert

public static Alert alert(Severity type,
 String title)

alert

public static Alert alert(Severity type,
 String identifier,
 String title)

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addActionGroup

public Alert addActionGroup(AlertActionGroup actionGroup)

addDescription

public Alert addDescription(String description)

Wraps the description inside a <p/> element, adds it to a AlertDescription and finally adds it to this alert. Useful if your description is just a simple string.

addDescription

public Alert addDescription(AlertDescription description)

add

public Alert add(AlertDescription description)

closable

public Alert closable()

closable

public Alert closable(CloseHandler<Alert> closeHandler)

icon

public Alert icon(elemental2.dom.Element icon)

Specified by:

icon in interface WithIcon<elemental2.dom.HTMLDivElement,Alert>

removeIcon

public Alert removeIcon()

Specified by:

removeIcon in interface WithIcon<elemental2.dom.HTMLDivElement,Alert>

expandable

public Alert expandable()

expandable

public Alert expandable(ToggleHandler<Alert> toggleHandler)

liveRegion

public Alert liveRegion()

Make this alert a live region alert. Live region alerts allow you to expose dynamic content changes in a way that can be announced by assistive technologies.

Set the following ARIA attributes:

• aria-live: "polite"
• aria-atomic: false

See Also:

• https://www.patternfly.org/components/alert/accessibility#accessibility
• https://www.patternfly.org/components/alert/accessibility#aria-live

timeout

public Alert timeout()

timeout

public Alert timeout(int timeout)

truncate

public Alert truncate()

truncate

public Alert truncate(int lines)

store

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

Specified by:

store in interface ComponentContext<elemental2.dom.HTMLDivElement,Alert>

that

public Alert that()

Specified by:

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

ariaLabel

public Alert ariaLabel(String label)

ariaCloseLabel

public Alert ariaCloseLabel(String label)

onClose

public Alert onClose(CloseHandler<Alert> closeHandler)

Specified by:

onClose in interface Closeable<elemental2.dom.HTMLDivElement,Alert>

identifier

public String identifier()

Specified by:

identifier in interface WithIdentifier<elemental2.dom.HTMLDivElement,Alert>

has

public boolean has(String key)

Specified by:

has in interface ComponentContext<elemental2.dom.HTMLDivElement,Alert>

get

public <T> T get(String key)

Specified by:

get in interface ComponentContext<elemental2.dom.HTMLDivElement,Alert>

close

public void close(elemental2.dom.Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<elemental2.dom.HTMLDivElement,Alert>

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<elemental2.dom.HTMLDivElement,Alert>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<elemental2.dom.HTMLDivElement,Alert>