Class ConfirmDialog
- All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier,com.vaadin.flow.component.DetachNotifier,com.vaadin.flow.component.HasComponents,com.vaadin.flow.component.HasElement,com.vaadin.flow.component.HasEnabled,com.vaadin.flow.component.HasOrderedComponents,com.vaadin.flow.component.HasSize,com.vaadin.flow.component.HasStyle,Serializable
Confirm Dialog consists of:
- Title
- Message
- Footer
- “Cancel” button
- “Reject” button
- “Confirm” button
Each Confirm Dialog should have a title and/or message. The “Confirm” button is shown by default, while the two other buttons are not (they must be explicitly enabled to be displayed).
- Author:
- Vaadin Ltd
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class`cancel` is sent when the user clicks Cancel button or presses Escape key.static class`confirm` is sent when the user clicks Confirm buttonstatic class`reject` is sent when the user clicks Reject button -
Constructor Summary
ConstructorsConstructorDescriptionCreates an empty dialog with a Confirm buttonConfirmDialog(String header, String text, String confirmText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener) Creates a dialog with a Confirm button with its click listener and a given textsConfirmDialog(String header, String text, String confirmText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener, String cancelText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener) Creates a two button dialog with Confirm and Cancel buttonsConfirmDialog(String header, String text, String confirmText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener, String rejectText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener, String cancelText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener) Creates a three button dialog with Confirm, Reject and Cancel buttons -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(com.vaadin.flow.component.Component... components) Deprecated.since v24.4, not supportedvoidDeprecated.since v24.4, not supportedvoidadd(Collection<com.vaadin.flow.component.Component> components) Deprecated.since v24.4, not supportedcom.vaadin.flow.shared.RegistrationaddCancelListener(com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> listener) Adds `cancel` event listenervoidaddComponentAsFirst(com.vaadin.flow.component.Component component) Deprecated.since v24.4, not supportedvoidaddComponentAtIndex(int index, com.vaadin.flow.component.Component component) Deprecated.since v24.4, not supportedcom.vaadin.flow.shared.RegistrationaddConfirmListener(com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> listener) Adds `confirm` event listenercom.vaadin.flow.shared.RegistrationaddRejectListener(com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> listener) Adds `reject` event listenervoidclose()Closes the dialog.Gets the `aria-describedby` attribute of the dialog overlay.com.vaadin.flow.dom.ClassListcom.vaadin.flow.component.ComponentgetComponentAt(int index) Deprecated.since v24.4, not supportedintDeprecated.since v24.4, not supportedcom.vaadin.flow.dom.StylegetStyle()getWidth()intindexOf(com.vaadin.flow.component.Component component) Deprecated.since v24.4, not supportedbooleanGets whether this dialog can be closed by hitting the esc-key or not.booleanisOpened()protected voidonAttach(com.vaadin.flow.component.AttachEvent attachEvent) voidopen()Opens the dialog.voidremove(com.vaadin.flow.component.Component... components) Deprecated.since v24.4, not supportedvoidremove(Collection<com.vaadin.flow.component.Component> components) Deprecated.since v24.4, not supportedvoidDeprecated.since v24.4, not supportedvoidreplace(com.vaadin.flow.component.Component oldComponent, com.vaadin.flow.component.Component newComponent) Deprecated.since v24.4, not supportedvoidsetAriaDescribedBy(String describedBy) Sets the `aria-describedby` attribute of the dialog overlay.voidsetCancelable(boolean cancelable) Whether to show or hide Cancel button.voidsetCancelButton(com.vaadin.flow.component.Component component) Sets custom cancel buttonvoidsetCancelButton(com.vaadin.flow.dom.Element element) Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedvoidsetCancelButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener) Sets Cancel button text and `cancel` event listener.voidsetCancelButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener, String theme) Sets Cancel button text, `cancel` event listener and Cancel button theme.voidsetCancelButtonTheme(String cancelTheme) Sets Cancel button themevoidsetCancelText(String cancelText) Sets Cancel button textvoidsetClassName(String className) Sets the CSS class names of the dialog overlay element.voidsetCloseOnEsc(boolean closeOnEsc) Sets whether this dialog can be closed by hitting the esc-key or not.voidsetConfirmButton(com.vaadin.flow.component.Component component) Sets custom confirm buttonvoidsetConfirmButton(com.vaadin.flow.dom.Element element) Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedvoidsetConfirmButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener) Sets Confirm button text and `confirm` event listenervoidsetConfirmButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener, String theme) Sets Confirm button text, `confirm` event listener and Confirm button themevoidsetConfirmButtonTheme(String confirmTheme) Sets Confirm button themevoidsetConfirmText(String confirmText) Sets Confirm button textvoidsetHeader(com.vaadin.flow.component.Component component) Sets confirmation dialog custom headervoidsetHeader(com.vaadin.flow.dom.Element element) Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedvoidSets confirmation dialog header textvoidSets the height of the component content area.voidsetOpened(boolean opened) Opens or closes the dialog.voidsetRejectable(boolean rejectable) Whether to show or hide Reject button.voidsetRejectButton(com.vaadin.flow.component.Component component) Sets custom Reject buttonvoidsetRejectButton(com.vaadin.flow.dom.Element element) Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedvoidsetRejectButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener) Sets Reject button text and `reject` event listener.voidsetRejectButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener, String theme) Sets Reject button text, `reject` event listener, Reject button theme.voidsetRejectButtonTheme(String rejectTheme) Sets Reject button themevoidsetRejectText(String rejectText) Sets Reject button textvoidsetText(com.vaadin.flow.component.Component component) Sets custom confirmation messagevoidsetText(com.vaadin.flow.dom.Element element) Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedvoidSets confirmation message textvoidSets the width of the component content area.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, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods inherited from interface com.vaadin.flow.component.HasOrderedComponents
getChildrenMethods inherited from interface com.vaadin.flow.component.HasSize
getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidthUnit, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, hasClassName, removeClassName, removeClassNames, setClassName
-
Constructor Details
-
ConfirmDialog
public ConfirmDialog()Creates an empty dialog with a Confirm button -
ConfirmDialog
public ConfirmDialog(String header, String text, String confirmText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener) Creates a dialog with a Confirm button with its click listener and a given texts- Parameters:
header- the header texttext- the confirmation message textconfirmText- the text inside Confirm buttonconfirmListener- the event listener for `confirm` event- See Also:
-
ConfirmDialog
public ConfirmDialog(String header, String text, String confirmText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener, String cancelText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener) Creates a two button dialog with Confirm and Cancel buttons- Parameters:
header- the header texttext- the confirmation message textconfirmText- the text inside Confirm buttonconfirmListener- the event listener for `confirm` eventcancelText- the text inside Cancel buttoncancelListener- the event listener for `cancel` event- See Also:
-
ConfirmDialog
public ConfirmDialog(String header, String text, String confirmText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener, String rejectText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener, String cancelText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener) Creates a three button dialog with Confirm, Reject and Cancel buttons- Parameters:
header- the header texttext- the confirmation message textconfirmText- the text inside Confirm buttonconfirmListener- the event listener for `confirm` eventrejectText- the text inside Reject buttonrejectListener- the event listener for `reject` eventcancelText- the text inside Cancel buttoncancelListener- the event listener for `cancel` event- See Also:
-
-
Method Details
-
getWidth
- Specified by:
getWidthin interfacecom.vaadin.flow.component.HasSize
-
setWidth
Sets the width of the component content area.The width should be in a format understood by the browser, e.g. "100px" or "2.5em" (Using relative unit, such as percentage, will lead to unexpected results).
If the provided
widthvalue is null then width is removed.- Specified by:
setWidthin interfacecom.vaadin.flow.component.HasSize- Parameters:
width- the width to set, may benull
-
getHeight
- Specified by:
getHeightin interfacecom.vaadin.flow.component.HasSize
-
setHeight
Sets the height of the component content area.The height should be in a format understood by the browser, e.g. "100px" or "2.5em" (Using relative unit, such as percentage, will lead to unexpected results).
If the provided
heightvalue is null then height is removed.- Specified by:
setHeightin interfacecom.vaadin.flow.component.HasSize- Parameters:
height- the height to set, may benull
-
setClassName
Sets the CSS class names of the dialog overlay element. This method overwrites any previous set class names.- Specified by:
setClassNamein interfacecom.vaadin.flow.component.HasStyle- Parameters:
className- a space-separated string of class names to set, ornullto remove all class names
-
getClassNames
public com.vaadin.flow.dom.ClassList getClassNames()- Specified by:
getClassNamesin interfacecom.vaadin.flow.component.HasStyle
-
getStyle
public com.vaadin.flow.dom.Style getStyle()- Specified by:
getStylein interfacecom.vaadin.flow.component.HasStyle- Throws:
UnsupportedOperationException- ConfirmDialog does not support adding styles to overlay
-
setAriaDescribedBy
Sets the `aria-describedby` attribute of the dialog overlay.By default, all elements inside the message area are linked through the `aria-describedby` attribute. However, there are cases where this can confuse screen reader users (e.g. the dialog may present a password confirmation form). For these cases, it's better to associate only the elements that will help describe the confirmation dialog through this API.
To restore the generated value, pass `null` as argument
- Parameters:
describedBy- the attribute value
-
getAriaDescribedBy
Gets the `aria-describedby` attribute of the dialog overlay.Note that this will only return a value if
setAriaDescribedBy(String)was called before.- Returns:
- an optional aria-describedby of the dialog overlay, or an empty optional if no aria-describedby has been set
-
setCancelable
public void setCancelable(boolean cancelable) Whether to show or hide Cancel button. -
setRejectable
public void setRejectable(boolean rejectable) Whether to show or hide Reject button. -
setRejectButton
public void setRejectButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener) Sets Reject button text and `reject` event listener. Makes Reject button visible- Parameters:
buttonText- the text inside Reject buttonrejectListener- the event listener for `reject` event
-
setRejectButton
public void setRejectButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener, String theme) Sets Reject button text, `reject` event listener, Reject button theme. Makes Reject button visible- Parameters:
buttonText- the text inside Reject buttonrejectListener- the event listener for `reject` eventtheme- the theme applied for a Reject button
-
setRejectButton
public void setRejectButton(com.vaadin.flow.component.Component component) Sets custom Reject button- Parameters:
component- the component to display instead of default Reject button
-
setRejectButton
Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedSets custom Reject button- Parameters:
element- the element to display instead of default Reject button
-
setCancelButton
public void setCancelButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener) Sets Cancel button text and `cancel` event listener. Makes Cancel button visible- Parameters:
buttonText- the text inside Cancel buttoncancelListener- the event listener for `cancel` event
-
setCancelButton
public void setCancelButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener, String theme) Sets Cancel button text, `cancel` event listener and Cancel button theme. Makes Cancel button visible- Parameters:
buttonText- the text inside Cancel buttoncancelListener- the event listener for `cancel` eventtheme- the theme applied for a Cancel button
-
setCancelButton
public void setCancelButton(com.vaadin.flow.component.Component component) Sets custom cancel button- Parameters:
component- the component to display instead of default Cancel button
-
setCancelButton
Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedSets custom cancel button- Parameters:
element- the element to display instead of default Cancel button
-
setConfirmButton
public void setConfirmButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener) Sets Confirm button text and `confirm` event listener- Parameters:
buttonText- the text inside Confirm buttonconfirmListener- the event listener for `confirm` event
-
setConfirmButton
public void setConfirmButton(String buttonText, com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener, String theme) Sets Confirm button text, `confirm` event listener and Confirm button theme- Parameters:
buttonText- the text inside Confirm buttonconfirmListener- the event listener for `confirm` eventtheme- the theme applied for a Confirm button
-
setConfirmButton
public void setConfirmButton(com.vaadin.flow.component.Component component) Sets custom confirm button- Parameters:
component- the component to display instead of default Confirm button
-
setConfirmButton
Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedSets custom confirm button- Parameters:
element- the element to display instead of default Confirm button
-
setText
Sets confirmation message text -
setText
public void setText(com.vaadin.flow.component.Component component) Sets custom confirmation message- Parameters:
component- the component to display instead of default confirmation text node
-
setText
Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedSets custom confirmation message element- Parameters:
element- the element to display instead of default confirmation text node
-
setConfirmText
Sets Confirm button text -
setConfirmButtonTheme
Sets Confirm button theme -
addConfirmListener
public com.vaadin.flow.shared.Registration addConfirmListener(com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.ConfirmEvent> listener) Adds `confirm` event listener -
setCancelText
Sets Cancel button text -
setCancelButtonTheme
Sets Cancel button theme -
addCancelListener
public com.vaadin.flow.shared.Registration addCancelListener(com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.CancelEvent> listener) Adds `cancel` event listener -
setRejectText
Sets Reject button text -
setRejectButtonTheme
Sets Reject button theme -
addRejectListener
public com.vaadin.flow.shared.Registration addRejectListener(com.vaadin.flow.component.ComponentEventListener<ConfirmDialog.RejectEvent> listener) Adds `reject` event listener -
setHeader
Sets confirmation dialog header text -
setHeader
public void setHeader(com.vaadin.flow.component.Component component) Sets confirmation dialog custom header- Parameters:
component- the component to display instead of default header text
-
setHeader
Deprecated, for removal: This API element is subject to removal in a future version.Usage of Element API at Component level should be avoidedSets confirmation dialog custom header element- Parameters:
element- the element to display instead of default header text
-
open
public void open()Opens the dialog.If a dialog was not added manually to a parent component, it will be automatically added to the
UIwhen opened, and automatically removed from the UI when closed. Note that the dialog is then scoped to the UI, and not the current view. As such, when navigating away from a view, the dialog will still be opened or stay open. In order to close the dialog when navigating away from a view, it should either be explicitly added as a child to the view, or it should be explicitly closed when leaving the view. -
close
public void close()Closes the dialog.This automatically removes the dialog from the
UI, unless it was manually added to a parent component. -
isOpened
public boolean isOpened() -
setOpened
public void setOpened(boolean opened) Opens or closes the dialog.If a dialog was not added manually to a parent component, it will be automatically added to the
UIwhen opened, and automatically removed from the UI when closed. Note that the dialog is then scoped to the UI, and not the current view. As such, when navigating away from a view, the dialog will still be opened or stay open. In order to close the dialog when navigating away from a view, it should either be explicitly added as a child to the view, or it should be explicitly closed when leaving the view.- Parameters:
opened-trueto open the confirm-dialog,falseto close it
-
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:
trueif this dialog can be closed with the esc-key,falseotherwise
-
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-trueto enable closing this dialog with the esc-key,falseto disable it
-
add
Deprecated.since v24.4, not supportedConfirm dialog does not support adding content. UsesetText(Component)instead to initialize content as a component.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
addin interfacecom.vaadin.flow.component.HasComponents
-
add
Deprecated.since v24.4, not supportedConfirm dialog does not support adding content. UsesetText(Component)instead to initialize content as a component.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
addin interfacecom.vaadin.flow.component.HasComponents
-
add
Deprecated.since v24.4, not supportedConfirm dialog does not support adding content. UsesetText(String)instead to initialize content as text.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
addin interfacecom.vaadin.flow.component.HasComponents
-
remove
Deprecated.since v24.4, not supportedConfirm dialog does not support removing content.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
removein interfacecom.vaadin.flow.component.HasComponents
-
remove
Deprecated.since v24.4, not supportedConfirm dialog does not support removing content.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
removein interfacecom.vaadin.flow.component.HasComponents
-
removeAll
Deprecated.since v24.4, not supportedConfirm dialog does not support removing content.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
removeAllin interfacecom.vaadin.flow.component.HasComponents
-
addComponentAtIndex
@Deprecated public void addComponentAtIndex(int index, com.vaadin.flow.component.Component component) Deprecated.since v24.4, not supportedConfirm dialog does not support adding content. UsesetText(Component)instead to initialize content as a component.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
addComponentAtIndexin interfacecom.vaadin.flow.component.HasComponents
-
addComponentAsFirst
Deprecated.since v24.4, not supportedConfirm dialog does not support adding content. UsesetText(Component)instead to initialize content as a component.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
addComponentAsFirstin interfacecom.vaadin.flow.component.HasComponents
-
replace
@Deprecated public void replace(com.vaadin.flow.component.Component oldComponent, com.vaadin.flow.component.Component newComponent) Deprecated.since v24.4, not supportedConfirm dialog does not support replacing content.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
replacein interfacecom.vaadin.flow.component.HasOrderedComponents
-
indexOf
Deprecated.since v24.4, not supportedConfirm dialog does not support multiple components.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
indexOfin interfacecom.vaadin.flow.component.HasOrderedComponents
-
getComponentCount
Deprecated.since v24.4, not supportedConfirm dialog does not support multiple components.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
getComponentCountin interfacecom.vaadin.flow.component.HasOrderedComponents
-
getComponentAt
Deprecated.since v24.4, not supportedConfirm dialog does not support multiple components.This method is inherited from
HasOrderedComponentsand has been marked as deprecated to indicate that it is not supported.- Specified by:
getComponentAtin interfacecom.vaadin.flow.component.HasOrderedComponents
-
onAttach
protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent) - Overrides:
onAttachin classcom.vaadin.flow.component.Component
-