Class Alert

java.lang.Object

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

org.patternfly.component.alert.Alert

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLDivElement, Alert>, ElementClassListMethods<HTMLDivElement, Alert>, ElementConsumerMethods<HTMLDivElement, Alert>, ElementContainerMethods<HTMLDivElement, Alert>, ElementEventMethods<HTMLDivElement, Alert>, ElementIdMethods<HTMLDivElement, Alert>, ElementQueryMethods<HTMLDivElement>, HTMLElementAttributeMethods<HTMLDivElement, Alert>, HTMLElementDataMethods<HTMLDivElement, Alert>, HTMLElementStyleMethods<HTMLDivElement, Alert>, HTMLElementVisibilityMethods<HTMLDivElement, Alert>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement, Alert>, Closeable<HTMLDivElement, Alert>, Component, ComponentIcon<HTMLDivElement, Alert>, Expandable<HTMLDivElement, Alert>, HasIdentifier<HTMLDivElement, Alert>, ComponentContext<HTMLDivElement, Alert>, Modifiers.Inline<HTMLDivElement, Alert>, Modifiers.Plain<HTMLDivElement, Alert>

public class Alert
extends BaseComponent<HTMLDivElement, Alert>
implements Closeable<HTMLDivElement, Alert>, ComponentContext<HTMLDivElement, Alert>, ComponentIcon<HTMLDivElement, Alert>, Expandable<HTMLDivElement, Alert>, Attachable, HasIdentifier<HTMLDivElement, Alert>, Modifiers.Inline<HTMLDivElement, Alert>, Modifiers.Plain<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(MutationRecord mutationRecord)
Alert	closable()
Alert	closable(CloseHandler<Alert> closeHandler)
void	close(Event event, boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
void	expand(boolean fireEvent)
Alert	expandable()
Alert	expandable(ToggleHandler<Alert> toggleHandler)
<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.
Alert	icon(Element icon)
String	identifier()	Retrieves the identifier associated with this component.
Alert	liveRegion()	Make this alert a live region alert.
Alert	onClose(CloseHandler<Alert> closeHandler)
Alert	removeIcon()
<T> Alert	store(String key, T value)	Stores a value associated with a key.
Alert	that()
Alert	timeout()
Alert	timeout(int timeout)
double	timestamp()
Alert	truncate()
Alert	truncate(int lines)

Methods inherited from class BaseComponent

componentType, element, registerComponent

Methods inherited from class Object

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

Methods inherited from interface Closeable

close, close

Methods inherited from interface ComponentContext

get, get

Methods inherited from interface ComponentIcon

icon

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 Expandable

collapse, expand, expanded, toggle, toggle

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.Inline

inline, inline

Methods inherited from interface Modifiers.Plain

plain, plain

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(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(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(Element icon)

Specified by:

icon in interface ComponentIcon<HTMLDivElement, Alert>

removeIcon

public Alert removeIcon()

Specified by:

removeIcon in interface ComponentIcon<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)

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<HTMLDivElement, Alert>

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

Specified by:

that in interface TypedBuilder<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<HTMLDivElement, Alert>

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<HTMLDivElement, Alert>

Returns:

the identifier of the component

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<HTMLDivElement, Alert>

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<HTMLDivElement, Alert>

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

close

public void close(Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<HTMLDivElement, Alert>

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLDivElement, Alert>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLDivElement, Alert>

timestamp

public double timestamp()