Package org.patternfly.component.alert

Class Alert

java.lang.Object

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

org.patternfly.component.alert.Alert

All Implemented Interfaces:

Attachable, Container<HTMLDivElement,Alert>, Finder<HTMLDivElement>, HasElement<HTMLDivElement,Alert>, HasHTMLElement<HTMLDivElement,Alert>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement,Alert>, Component, ComponentReference<AlertGroup>, Closeable<HTMLDivElement,Alert>, Expandable<HTMLDivElement,Alert>, Modifiers.Inline<HTMLDivElement,Alert>, Modifiers.Plain<HTMLDivElement,Alert>

public class Alert
extends BaseComponent<HTMLDivElement,Alert>
implements Modifiers.Inline<HTMLDivElement,Alert>, Modifiers.Plain<HTMLDivElement,Alert>, Closeable<HTMLDivElement,Alert>, Expandable<HTMLDivElement,Alert>, Attachable, ComponentReference<AlertGroup>

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

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
Alert	add(AlertActionGroup actionGroup)
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(AlertType type, 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)
Alert	customIcon(String iconClass)
Alert	customIcon(InlineIcon icon)
Alert	customIcon(PredefinedIcon icon)
void	detach(MutationRecord mutationRecord)
void	expand(boolean fireEvent)
Alert	expandable()
Alert	expandable(ToggleHandler<Alert> toggleHandler)
Alert	liveRegion()	Make this alert a live region alert.
AlertGroup	mainComponent()	If this alert is not part of an AlertGroup, this method will return null!
Alert	onClose(CloseHandler<Alert> closeHandler)
void	passComponent(AlertGroup alertGroup)
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.core.Closeable

close, close

Methods inherited from interface org.jboss.elemento.Container

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

Methods inherited from interface org.patternfly.core.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, css, id, id, innerHtml, on, textContent, textNode, toggle, toggle, toggle

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

inline, inline

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

plain, plain

Field Detail

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

Method Detail

alert

public static Alert alert(AlertType type,
                          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

passComponent

public void passComponent(AlertGroup alertGroup)

Specified by:

passComponent in interface ComponentReference<AlertGroup>

mainComponent

public AlertGroup mainComponent()

If this alert is not part of an AlertGroup, this method will return null!

Specified by:

mainComponent in interface ComponentReference<AlertGroup>

addActionGroup

public Alert addActionGroup(AlertActionGroup actionGroup)

add

public Alert add(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)

customIcon

public Alert customIcon(String iconClass)

customIcon

public Alert customIcon(PredefinedIcon icon)

customIcon

public Alert customIcon(InlineIcon icon)

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)

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>

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>