We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.dialog.
Class GeneratedVaadinDialog<R extends GeneratedVaadinDialog<R>>
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.dialog.GeneratedVaadinDialog<R>
-
All Implemented Interfaces:
Direct Known Subclasses:
@Tag("vaadin-dialog") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.15") @NpmPackage(value="@vaadin/dialog",version="23.1.15") @NpmPackage(value="@vaadin/vaadin-dialog",version="23.1.15") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/dialog/src/vaadin-dialog.js") @JsModule("@vaadin/polymer-legacy-adapter/template-renderer.js") public abstract class GeneratedVaadinDialog<R extends GeneratedVaadinDialog<R>> extends ComponentDescription copied from corresponding location in WebComponent:
<vaadin-dialog>is a Web Component for customized modal dialogs.<vaadin-dialog opened> <template> Sample dialog </template> </vaadin-dialog>
Styling
See
<vaadin-overlay>documentation for<vaadin-dialog-overlay>parts.See ThemableMixin ? how to apply styles for shadow parts
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGeneratedVaadinDialog.OpenedChangeEvent<R extends GeneratedVaadinDialog<R>>
-
Constructor Summary
Constructors Constructor Description GeneratedVaadinDialog()
-
Method Summary
All Methods Modifier and Type Method Description protected RegistrationaddOpenedChangeListener(ComponentEventListener<GeneratedVaadinDialog.OpenedChangeEvent<R>> listener)Adds a listener for
opened-changedevents fired by the webcomponent.protected StringgetAriaLabelString()Description copied from corresponding location in WebComponent:
protected booleanisOpenedBoolean()Description copied from corresponding location in WebComponent:
protected voidsetAriaLabel(String ariaLabel)Description copied from corresponding location in WebComponent:
protected voidsetOpened(boolean opened)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, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Method Detail
-
isOpenedBoolean
@Synchronize(property="opened", value="opened-changed") protected boolean isOpenedBoolean()Description copied from corresponding location in WebComponent:
True if the overlay is currently displayed.
This property is synchronized automatically from client side when a 'opened-changed' event happens.
Returns:
the
openedproperty from the webcomponent
-
setOpened
protected void setOpened(boolean opened)Description copied from corresponding location in WebComponent:
True if the overlay is currently displayed.
Parameters:
opened- the boolean value to set
-
getAriaLabelString
protected String getAriaLabelString()Description copied from corresponding location in WebComponent:
Set the
aria-labelattribute for assistive technologies like screen readers. Anundefinedvalue for this property (the default) means that thearia-labelattribute is not present at all.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
ariaLabelproperty from the webcomponent
-
setAriaLabel
protected void setAriaLabel(String ariaLabel)Description copied from corresponding location in WebComponent:
Set the
aria-labelattribute for assistive technologies like screen readers. Anundefinedvalue for this property (the default) means that thearia-labelattribute is not present at all.Parameters:
ariaLabel- the String value to set
-
addOpenedChangeListener
protected Registration addOpenedChangeListener(ComponentEventListener<GeneratedVaadinDialog.OpenedChangeEvent<R>> listener)Adds a listener for
opened-changedevents fired by the webcomponent.Parameters:
listener- the listenerReturns:
a
Registrationfor removing the event listener
-
-