Package com.vaadin.flow.component.dialog

Class GeneratedVaadinDialog<R extends GeneratedVaadinDialog<R>>

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable
    Direct Known Subclasses:
    Dialog
    @Tag("vaadin-dialog")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.1") @NpmPackage(value="@vaadin/dialog",version="23.1.1") @NpmPackage(value="@vaadin/vaadin-dialog",version="23.1.1")
@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 com.vaadin.flow.component.Component

    Description 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:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected com.vaadin.flow.shared.Registration addOpenedChangeListener​(com.vaadin.flow.component.ComponentEventListener<GeneratedVaadinDialog.OpenedChangeEvent<R>> listener)
      Adds a listener for opened-changed events fired by the webcomponent.
      protected String getAriaLabelString()
      Description copied from corresponding location in WebComponent:
      protected boolean isOpenedBoolean()
      Description copied from corresponding location in WebComponent:
      protected void setAriaLabel​(String ariaLabel)
      Description copied from corresponding location in WebComponent:
      protected void setOpened​(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 interface com.vaadin.flow.component.AttachNotifier

        addAttachListener

      • Methods inherited from interface com.vaadin.flow.component.DetachNotifier

        addDetachListener

    • Constructor Detail

      • GeneratedVaadinDialog

        public GeneratedVaadinDialog()

    • 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 opened property 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-label attribute for assistive technologies like screen readers. An undefined value for this property (the default) means that the aria-label attribute 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 ariaLabel property from the webcomponent

      • setAriaLabel

        protected void setAriaLabel​(String ariaLabel)

        Description copied from corresponding location in WebComponent:

        Set the aria-label attribute for assistive technologies like screen readers. An undefined value for this property (the default) means that the aria-label attribute is not present at all.

        Parameters:
        ariaLabel - the String value to set

      • addOpenedChangeListener

        protected com.vaadin.flow.shared.Registration addOpenedChangeListener​(com.vaadin.flow.component.ComponentEventListener<GeneratedVaadinDialog.OpenedChangeEvent<R>> listener)
        Adds a listener for opened-changed events fired by the webcomponent.
        Parameters:
        listener - the listener
        Returns:
        a Registration for removing the event listener