com.vaadin.flow.component.notification.
Class GeneratedVaadinNotification<R extends GeneratedVaadinNotification<R>>
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.notification.GeneratedVaadinNotification<R>
-
All Implemented Interfaces:
Direct Known Subclasses:
@Generated(value={"Generator: com.vaadin.generator.ComponentGenerator#1.0-SNAPSHOT","WebComponent: Vaadin.NotificationElement#1.0.0","Flow#1.0-SNAPSHOT"}) @Tag(value="vaadin-notification") @HtmlImport(value="frontend://bower_components/vaadin-notification/src/vaadin-notification.html") public abstract class GeneratedVaadinNotification<R extends GeneratedVaadinNotification<R>> extends Component
Description copied from corresponding location in WebComponent:
<vaadin-notification>
is a Polymer 2 element providing accessible and customizable notifications (toasts).<vaadin-notification> <template> Your work has been saved </template> </vaadin-notification>
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
GeneratedVaadinNotification.OpenedChangeEvent<R extends GeneratedVaadinNotification<R>>
-
Constructor Summary
Constructors Constructor and Description GeneratedVaadinNotification()
-
Method Summary
All Methods Modifier and Type Method and Description protected Registration
addOpenedChangeListener(ComponentEventListener<GeneratedVaadinNotification.OpenedChangeEvent<R>> listener)
Adds a listener for
opened-changed
events fired by the webcomponent.protected void
close()
Description copied from corresponding location in WebComponent:
protected double
getDurationDouble()
Description copied from corresponding location in WebComponent:
protected String
getPositionString()
Description copied from corresponding location in WebComponent:
protected boolean
isOpenedBoolean()
Description copied from corresponding location in WebComponent:
protected void
open()
Description copied from corresponding location in WebComponent:
protected void
setDuration(double duration)
Description copied from corresponding location in WebComponent:
protected void
setOpened(boolean opened)
Description copied from corresponding location in WebComponent:
protected void
setPosition(String position)
Description copied from corresponding location in WebComponent:
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Method Detail
-
getDurationDouble
protected double getDurationDouble()
Description copied from corresponding location in WebComponent:
The duration in milliseconds to show the notification. Set to
0
or a negative number to disable the notification auto-closing.This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
duration
property from the webcomponent
-
setDuration
protected void setDuration(double duration)
Description copied from corresponding location in WebComponent:
The duration in milliseconds to show the notification. Set to
0
or a negative number to disable the notification auto-closing.Parameters:
duration
- the double value to set
-
isOpenedBoolean
@Synchronize(property="opened", value="opened-changed") protected boolean isOpenedBoolean()
Description copied from corresponding location in WebComponent:
True if the notification is currently displayed.
This property is synchronized automatically from client side when a 'opened-changed' event happens.
Returns:
the
opened
property from the webcomponent
-
setOpened
protected void setOpened(boolean opened)
Description copied from corresponding location in WebComponent:
True if the notification is currently displayed.
Parameters:
opened
- the boolean value to set
-
getPositionString
protected String getPositionString()
Description copied from corresponding location in WebComponent:
Alignment of the notification in the viewport Valid values are
top-stretch|top-start|top-center|top-end|middle|bottom-start|bottom-center|bottom-end|bottom-stretch
This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
position
property from the webcomponent
-
setPosition
protected void setPosition(String position)
Description copied from corresponding location in WebComponent:
Alignment of the notification in the viewport Valid values are
top-stretch|top-start|top-center|top-end|middle|bottom-start|bottom-center|bottom-end|bottom-stretch
Parameters:
position
- the String value to set
-
open
protected void open()
Description copied from corresponding location in WebComponent:
Opens the notification.
-
close
protected void close()
Description copied from corresponding location in WebComponent:
Closes the notification.
-
addOpenedChangeListener
protected Registration addOpenedChangeListener(ComponentEventListener<GeneratedVaadinNotification.OpenedChangeEvent<R>> listener)
Adds a listener for
opened-changed
events fired by the webcomponent.Parameters:
listener
- the listenerReturns:
a
Registration
for removing the event listener
-
-