Package com.storedobject.vaadin

Class Alert

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.notification.Notification

com.storedobject.vaadin.Alert

All Implemented Interfaces:

ClickNotifier, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.Component>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.notification.NotificationVariant>, Serializable

Direct Known Subclasses:

Alert

public class Alert
extends com.vaadin.flow.component.notification.Notification
implements com.vaadin.flow.component.HasText, ClickNotifier

Slightly enhanced version of Vaadin's Notification. Supports HTML text and the notification is "clickable" (an associated action can be defined).

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.notification.Notification

com.vaadin.flow.component.notification.Notification.OpenedChangeEvent, com.vaadin.flow.component.notification.Notification.Position

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Alert(StyledText htmlContent, Consumer<Alert> clickAction)	Constructor.
protected	Alert(StyledText htmlContent, Consumer<Alert> clickAction, com.vaadin.flow.component.notification.NotificationVariant style)	Constructor.
	Alert(String htmlText)	Constructor.
	Alert(String htmlText, com.vaadin.flow.component.notification.NotificationVariant style)	Constructor.
	Alert(String caption, String htmlText)	Constructor.
	Alert(String caption, String htmlText, com.vaadin.flow.component.notification.NotificationVariant style)	Constructor.
	Alert(String caption, String htmlText, Consumer<Alert> clickAction)	Constructor.
	Alert(String caption, String htmlText, Consumer<Alert> clickAction, com.vaadin.flow.component.notification.NotificationVariant style)	Constructor.
	Alert(String htmlText, Consumer<Alert> clickAction)	Constructor.
	Alert(String htmlText, Consumer<Alert> clickAction, com.vaadin.flow.component.notification.NotificationVariant style)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> listener)
void	clicked()	This method is invoked when clicked on the alert.
void	delete()	Delete (and close) the alert so that it's no more associated with Application.
boolean	deleteOnClose()	Check whether this alert should be removed when closed or not.
Consumer<Alert>	getClickAction()	Get the click action associated with this alert.
StyledText	getContent()	Get the content as "styled text".
String	getText()	Get the text of the alert.
void	removeClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> listener)	Remove a listener.
com.vaadin.flow.shared.Registration	replaceClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> oldListener, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> newListener)	Replace a listener.
static void	setDefaultPosition(com.vaadin.flow.component.notification.Notification.Position defaultPosition)	Set the default position of alerts.
void	setText(String text)	Set some text on the alert.
void	show()	Show the alert.

Methods inherited from class com.vaadin.flow.component.notification.Notification

add, addAttachListener, addComponentAtIndex, addDetachListener, addOpenedChangeListener, close, getClassNames, getDuration, getPosition, getStyle, isAssertive, isOpened, onAttach, onDetach, open, setAssertive, setClassName, setDuration, setOpened, setPosition, show, show, show

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickShortcut, addDoubleClickListener, addSingleClickListener

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, addComponentAsFirst, remove, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, hasClassName, removeClassName, removeClassNames, setClassName

Methods inherited from interface com.vaadin.flow.component.HasText

getWhiteSpace, setWhiteSpace

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, removeThemeVariants

Constructor Details

Alert

public Alert(String htmlText)

Constructor.

Parameters:

htmlText - HTML text

Alert

public Alert(String htmlText,
 Consumer<Alert> clickAction)

Constructor.

Parameters:

htmlText - HTML text

clickAction - Click action

Alert

public Alert(String caption,
 String htmlText)

Constructor.

Parameters:

caption - Caption

htmlText - HTML text

Alert

public Alert(String caption,
 String htmlText,
 Consumer<Alert> clickAction)

Constructor.

Parameters:

caption - Caption

htmlText - HTML text

clickAction - Click action

Alert

public Alert(String htmlText,
 com.vaadin.flow.component.notification.NotificationVariant style)

Constructor.

Parameters:

htmlText - HTML text

style - Style

Alert

public Alert(String htmlText,
 Consumer<Alert> clickAction,
 com.vaadin.flow.component.notification.NotificationVariant style)

Constructor.

Parameters:

htmlText - HTML text

clickAction - Click action

style - Style

Alert

public Alert(String caption,
 String htmlText,
 com.vaadin.flow.component.notification.NotificationVariant style)

Constructor.

Parameters:

caption - Caption

htmlText - HTML text

style - Style

Alert

public Alert(String caption,
 String htmlText,
 Consumer<Alert> clickAction,
 com.vaadin.flow.component.notification.NotificationVariant style)

Constructor.

Parameters:

caption - Caption

htmlText - HTML text

clickAction - Click action

style - Style

Alert

protected Alert(StyledText htmlContent,
 Consumer<Alert> clickAction)

Constructor.

Parameters:

htmlContent - HTML content

clickAction - Click action

Alert

protected Alert(StyledText htmlContent,
 Consumer<Alert> clickAction,
 com.vaadin.flow.component.notification.NotificationVariant style)

Constructor.

Parameters:

htmlContent - HTML content

clickAction - Click action

style - Style

Method Details

addClickListener

public com.vaadin.flow.shared.Registration addClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> listener)

Specified by:

addClickListener in interface com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.Component>

removeClickListener

public void removeClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> listener)

Description copied from interface: ClickNotifier

Remove a listener.

Specified by:

removeClickListener in interface ClickNotifier

Parameters:

listener - Listener

replaceClickListener

public com.vaadin.flow.shared.Registration replaceClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> oldListener,
 com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.Component>> newListener)

Description copied from interface: ClickNotifier

Replace a listener.

Specified by:

replaceClickListener in interface ClickNotifier

Parameters:

oldListener - Old listener

newListener - New listener

Returns:

Registration.

show

public void show()

Show the alert. (Same as Notification.open()).

clicked

public void clicked()

This method is invoked when clicked on the alert. Default behaviour of this method is to execute the action that is already defined or if no action is defined, it will be closed.

setText

public void setText(String text)

Set some text on the alert. If the text is non-empty, alert will be shown.

Specified by:

setText in interface com.vaadin.flow.component.HasText

Overrides:

setText in class com.vaadin.flow.component.notification.Notification

Parameters:

text - Text to show

getText

public String getText()

Get the text of the alert.

Specified by:

getText in interface com.vaadin.flow.component.HasText

Returns:

Text.

getContent

public StyledText getContent()

Get the content as "styled text".

Returns:

Styled text.

getClickAction

public Consumer<Alert> getClickAction()

Get the click action associated with this alert.

Returns:

The click action if any.

delete

public void delete()

Delete (and close) the alert so that it's no more associated with Application.

deleteOnClose

public boolean deleteOnClose()

Check whether this alert should be removed when closed or not.

Returns:

True if this should be removed when closed.

setDefaultPosition

public static void setDefaultPosition(com.vaadin.flow.component.notification.Notification.Position defaultPosition)

Set the default position of alerts.

Parameters:

defaultPosition - Position.