Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Dialog.DialogCloseActionEvent` `vaadin-dialog-close-action` is sent when the user clicks outside the overlay or presses the escape key.

Nested classes/interfaces inherited from class com.vaadin.flow.component.dialog.GeneratedVaadinDialog
GeneratedVaadinDialog.OpenedChangeEvent<R extends GeneratedVaadinDialog<R>>

Constructor Summary

Constructors
Constructor and Description

Dialog()
Creates an empty dialog.

Dialog(Component... components)
Creates a dialog with given components inside.

Method Summary

All Methods
Modifier and Type	Method and Description
`void`	`add(Component... components)` Adds the given components into this dialog.
`Registration`	`addAttachListener(ComponentEventListener<AttachEvent> listener)` Adds a attach listener to this component.
`void`	`addComponentAtIndex(int index, Component component)` Adds the given component into this dialog at the given index.
`Registration`	`addDetachListener(ComponentEventListener<DetachEvent> listener)` Adds a detach listener to this component.
`Registration`	`addDialogCloseActionListener(ComponentEventListener<Dialog.DialogCloseActionEvent> listener)` Add a listener that controls whether the dialog should be closed or not.
`Registration`	`addOpenedChangeListener(ComponentEventListener<GeneratedVaadinDialog.OpenedChangeEvent<Dialog>> listener)` Add a lister for event fired by the `opened-changed` events.
`void`	`close()` Closes the dialog.
`Stream<Component>`	`getChildren()` Gets the child components of this component.
`String`	`getHeight()` Gets the height defined for the component.
`String`	`getWidth()` Gets the width defined for the component.
`boolean`	`isCloseOnEsc()` Gets whether this dialog can be closed by hitting the esc-key or not.
`boolean`	`isCloseOnOutsideClick()` Gets whether this dialog can be closed by clicking outside of it or not.
`boolean`	`isOpened()` Gets the open state from the dialog.
`void`	`open()` Opens the dialog.
`void`	`remove(Component... components)` Removes the given child components from this component.
`void`	`removeAll()` Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the `Element` API.
`void`	`setCloseOnEsc(boolean closeOnEsc)` Sets whether this dialog can be closed by hitting the esc-key or not.
`void`	`setCloseOnOutsideClick(boolean closeOnOutsideClick)` Sets whether this dialog can be closed by clicking outside of it or not.
`void`	`setHeight(String value)` Sets the height of the component.
`void`	`setOpened(boolean opened)` Opens or closes the dialog.
`void`	`setWidth(String value)` Sets the width of the component.

Methods inherited from class com.vaadin.flow.component.dialog.GeneratedVaadinDialog
getAriaLabelString, isOpenedBoolean, setAriaLabel

Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, 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.HasComponents
add, addComponentAsFirst

Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled

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

Methods inherited from interface com.vaadin.flow.component.HasSize
getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidthFull

- Constructor Detail
  - Dialog
```
public Dialog()
```
    Creates an empty dialog.
  - Dialog
```
public Dialog(Component... components)
```
    Creates a dialog with given components inside.
    
    Parameters:
    
    components - the components inside the dialog
    
    See Also:
    
    add(Component...)
- Method Detail
  - setWidth
```
public void setWidth(String value)
```
    Description copied from interface: HasSize
    
    Sets the width of the component.
    The width should be in a format understood by the browser, e.g. "100px" or "2.5em".
    If the provided width value is null then width is removed.
    
    Specified by:
    
    setWidth in interface HasSize
    
    Parameters:
    
    value - the width to set, may be null
  - setHeight
```
public void setHeight(String value)
```
    Description copied from interface: HasSize
    
    Sets the height of the component.
    The height should be in a format understood by the browser, e.g. "100px" or "2.5em".
    If the provided height value is null then height is removed.
    
    Specified by:
    
    setHeight in interface HasSize
    
    Parameters:
    
    value - the height to set, may be null
  - getWidth
```
public String getWidth()
```
    Description copied from interface: HasSize
    
    Gets the width defined for the component.
    Note that this does not return the actual size of the component but the width which has been set using HasSize.setWidth(String).
    
    Specified by:
    
    getWidth in interface HasSize
    
    Returns:
    
    the width which has been set for the component
  - getHeight
```
public String getHeight()
```
    Description copied from interface: HasSize
    
    Gets the height defined for the component.
    Note that this does not return the actual size of the component but the height which has been set using HasSize.setHeight(String).
    
    Specified by:
    
    getHeight in interface HasSize
    
    Returns:
    
    the height which has been set for the component
  - addDialogCloseActionListener
```
public Registration addDialogCloseActionListener(ComponentEventListener<Dialog.DialogCloseActionEvent> listener)
```
    Add a listener that controls whether the dialog should be closed or not.
    The listener is informed when the user wants to close the dialog by clicking outside the dialog, or by pressing escape. Then you can decide whether to close or to keep opened the dialog. It means that dialog won't be closed automatically unless you call close() method explicitly in the listener implementation.
    NOTE: adding this listener changes behavior of the dialog. Dialog is closed automatically in case there are no any close listeners. And the close() method should be called explicitly to close the dialog in case there are close listeners.
    
    Parameters:
    
    listener -
    
    Returns:
    
    registration for removal of listener
    
    See Also:
    
    close()
  - add
```
public void add(Component... components)
```
    Adds the given components into this dialog.
    The elements in the DOM will not be children of the <vaadin-dialog> element, but will be inserted into an overlay that is attached into the <body>.
    
    Specified by:
    
    add in interface HasComponents
    
    Parameters:
    
    components - the components to add
  - remove
```
public void remove(Component... components)
```
    Description copied from interface: HasComponents
    
    Removes the given child components from this component.
    
    Specified by:
    
    remove in interface HasComponents
    
    Parameters:
    
    components - the components to remove
  - removeAll
```
public void removeAll()
```
    Description copied from interface: HasComponents
    
    Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the Element API. it also removes the children that were added only at the client-side.
    
    Specified by:
    
    removeAll in interface HasComponents
  - addComponentAtIndex
```
public void addComponentAtIndex(int index,
                                Component component)
```
    Adds the given component into this dialog at the given index.
    The element in the DOM will not be child of the <vaadin-dialog> element, but will be inserted into an overlay that is attached into the <body>.
    
    Specified by:
    
    addComponentAtIndex in interface HasComponents
    
    Parameters:
    
    index - the index, where the component will be added.
    
    component - the component to add
  - isCloseOnEsc
```
public boolean isCloseOnEsc()
```
    Gets whether this dialog can be closed by hitting the esc-key or not.
    By default, the dialog is closable with esc.
    
    Returns:
    
    true if this dialog can be closed with the esc-key, false otherwise
  - setCloseOnEsc
```
public void setCloseOnEsc(boolean closeOnEsc)
```
    Sets whether this dialog can be closed by hitting the esc-key or not.
    By default, the dialog is closable with esc.
    
    Parameters:
    
    closeOnEsc - true to enable closing this dialog with the esc-key, false to disable it
  - isCloseOnOutsideClick
```
public boolean isCloseOnOutsideClick()
```
    Gets whether this dialog can be closed by clicking outside of it or not.
    By default, the dialog is closable with an outside click.
    
    Returns:
    
    true if this dialog can be closed by an outside click, false otherwise
  - setCloseOnOutsideClick
```
public void setCloseOnOutsideClick(boolean closeOnOutsideClick)
```
    Sets whether this dialog can be closed by clicking outside of it or not.
    By default, the dialog is closable with an outside click.
    
    Parameters:
    
    closeOnOutsideClick - true to enable closing this dialog with an outside click, false to disable it
  - open
```
public void open()
```
    Opens the dialog.
    Note: You don't need to add the dialog component anywhere before opening it. Since <vaadin-dialog>'s location in the DOM doesn't really matter, opening a dialog will automatically add it to the <body> if necessary.
  - close
```
public void close()
```
    Closes the dialog.
    Note: This method also removes the dialog component from the DOM after closing it, unless you have added the component manually.
  - setOpened
```
public void setOpened(boolean opened)
```
    Opens or closes the dialog.
    Note: You don't need to add the dialog component anywhere before opening it. Since <vaadin-dialog>'s location in the DOM doesn't really matter, opening a dialog will automatically add it to the <body> if necessary.
    
    Overrides:
    
    setOpened in class GeneratedVaadinDialog<Dialog>
    
    Parameters:
    
    opened - true to open the dialog, false to close it
  - isOpened
```
public boolean isOpened()
```
    Gets the open state from the dialog.
    
    Returns:
    
    the opened property from the dialog
  - getChildren
```
public Stream<Component> getChildren()
```
    Description copied from class: Component
    
    Gets the child components of this component.
    The default implementation finds child components by traversing each child Element tree.
    If the component is injected to a PolymerTemplate using the @Id annotation the getChildren method will only return children added from the server side and will not return any children declared in the template file.
    
    Overrides:
    
    getChildren in class Component
    
    Returns:
    
    the child components of this component
    
    See Also:
    
    Id
  - addOpenedChangeListener
```
public Registration addOpenedChangeListener(ComponentEventListener<GeneratedVaadinDialog.OpenedChangeEvent<Dialog>> listener)
```
    Add a lister for event fired by the opened-changed events.
    
    Overrides:
    
    addOpenedChangeListener in class GeneratedVaadinDialog<Dialog>
    
    Parameters:
    
    listener - the listener
    
    Returns:
    
    a Registration for removing the event listener
  - addAttachListener
```
public Registration addAttachListener(ComponentEventListener<AttachEvent> listener)
```
    Adds a attach listener to this component.
    Note: To listen for opening the dialog, you should use addOpenedChangeListener(ComponentEventListener).
    
    Specified by:
    
    addAttachListener in interface AttachNotifier
    
    Parameters:
    
    listener - the listener to add, not null
    
    Returns:
    
    a handle that can be used for removing the listener
  - addDetachListener
```
public Registration addDetachListener(ComponentEventListener<DetachEvent> listener)
```
    Adds a detach listener to this component.
    Note: To listen for closing the dialog, you should use addOpenedChangeListener(ComponentEventListener), as the component is not necessarily removed from the DOM when closing.
    
    Specified by:
    
    addDetachListener in interface DetachNotifier
    
    Parameters:
    
    listener - the listener to add, not null
    
    Returns:
    
    a handle that can be used for removing the listener

Constructors
Constructor and Description
`Dialog()` Creates an empty dialog.
`Dialog(Component... components)` Creates a dialog with given components inside.

com.vaadin.flow.component.dialog.

Class Dialog

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.dialog.GeneratedVaadinDialog

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.flow.component.dialog.GeneratedVaadinDialog

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

Methods inherited from class java.lang.Object

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

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

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

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

Constructor Detail

Dialog

Dialog

Method Detail

setWidth

setHeight

getWidth

getHeight

addDialogCloseActionListener

add

remove

removeAll

addComponentAtIndex

isCloseOnEsc

setCloseOnEsc

isCloseOnOutsideClick

setCloseOnOutsideClick

open

close

setOpened

isOpened

getChildren

addOpenedChangeListener

addAttachListener

addDetachListener