Class ConfirmDialog

Constructor Detail

• ConfirmDialog

  public ConfirmDialog()

  Creates an empty dialog with a Confirm button

• ConfirmDialog

  public ConfirmDialog​(String header,
                       String text,
                       String confirmText,
                       ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener)

  Creates a dialog with a Confirm button with its click listener and a given texts

  Parameters:

  header - the header text

  text - the confirmation message text

  confirmText - the text inside Confirm button

  confirmListener - the event listener for `confirm` event

  See Also:

  setHeader(String), setText(String), setConfirmButton(String, ComponentEventListener)

• ConfirmDialog

  public ConfirmDialog​(String header,
                       String text,
                       String confirmText,
                       ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener,
                       String cancelText,
                       ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener)

  Creates a two button dialog with Confirm and Cancel buttons

  Parameters:

  header - the header text

  text - the confirmation message text

  confirmText - the text inside Confirm button

  confirmListener - the event listener for `confirm` event

  cancelText - the text inside Cancel button

  cancelListener - the event listener for `cancel` event

  See Also:

  setHeader(String), setText(String), setConfirmButton(String, ComponentEventListener), setCancelButton(String, ComponentEventListener)

• ConfirmDialog

  public ConfirmDialog​(String header,
                       String text,
                       String confirmText,
                       ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener,
                       String rejectText,
                       ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener,
                       String cancelText,
                       ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener)

  Creates a three button dialog with Confirm, Reject and Cancel buttons

  Parameters:

  header - the header text

  text - the confirmation message text

  confirmText - the text inside Confirm button

  confirmListener - the event listener for `confirm` event

  rejectText - the text inside Reject button

  rejectListener - the event listener for `reject` event

  cancelText - the text inside Cancel button

  cancelListener - the event listener for `cancel` event

  See Also:

  setHeader(String), setText(String), setConfirmButton(String, ComponentEventListener), setCancelButton(String, ComponentEventListener), setRejectButton(String, ComponentEventListener)

Method Detail

• setWidth

  public void setWidth​(String width)

  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 width value is null then width is removed.

  Specified by:

  setWidth in interface HasSize

  Parameters:

  width - the width to set, may be null

• setHeight

  public void setHeight​(String height)

  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 height value is null then height is removed.

  Specified by:

  setHeight in interface HasSize

  Parameters:

  height - the height to set, may be null

• updateHeight

  public void updateHeight()

• getStyle

  public Style getStyle()

  Description copied from interface: HasStyle

  Gets the style instance for managing inline styles for the element of this component.

  Specified by:

  getStyle in interface HasStyle

  Returns:

  the style object for the element, not null

  Throws:

  UnsupportedOperationException - ConfirmDialog does not support adding styles to overlay

• onAttach

  protected void onAttach​(AttachEvent attachEvent)

  Description copied from class: Component

  Called when the component is attached to a UI.

  The default implementation does nothing.

  This method is invoked before the AttachEvent is fired for the component.

  Overrides:

  onAttach in class Component

  Parameters:

  attachEvent - the attach event

• 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,
                              ComponentEventListener<ConfirmDialog.RejectEvent> rejectListener)

  Sets Reject button text and `reject` event listener. Makes Reject button visible

  Parameters:

  buttonText - the text inside Reject button

  rejectListener - the event listener for `reject` event

• setRejectButton

  public void setRejectButton​(String buttonText,
                              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 button

  rejectListener - the event listener for `reject` event

  theme - the theme applied for a Reject button

• setRejectButton

  public void setRejectButton​(Component component)

  Sets custom Reject button

  Parameters:

  component - the component to display instead of default Reject button

• setRejectButton

  public void setRejectButton​(Element element)

  Sets custom Reject button

  Parameters:

  element - the element to display instead of default Reject button

• setCancelButton

  public void setCancelButton​(String buttonText,
                              ComponentEventListener<ConfirmDialog.CancelEvent> cancelListener)

  Sets Cancel button text and `cancel` event listener. Makes Cancel button visible

  Parameters:

  buttonText - the text inside Cancel button

  cancelListener - the event listener for `cancel` event

• setCancelButton

  public void setCancelButton​(String buttonText,
                              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 button

  cancelListener - the event listener for `cancel` event

  theme - the theme applied for a Cancel button

• setCancelButton

  public void setCancelButton​(Component component)

  Sets custom cancel button

  Parameters:

  component - the component to display instead of default Cancel button

• setCancelButton

  public void setCancelButton​(Element element)

  Sets custom cancel button

  Parameters:

  element - the element to display instead of default Cancel button

• setConfirmButton

  public void setConfirmButton​(String buttonText,
                               ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener)

  Sets Confirm button text and `confirm` event listener

  Parameters:

  buttonText - the text inside Confirm button

  confirmListener - the event listener for `confirm` event

• setConfirmButton

  public void setConfirmButton​(String buttonText,
                               ComponentEventListener<ConfirmDialog.ConfirmEvent> confirmListener,
                               String theme)

  Sets Confirm button text, `confirm` event listener and Confirm button theme

  Parameters:

  buttonText - the text inside Confirm button

  confirmListener - the event listener for `confirm` event

  theme - the theme applied for a Confirm button

• setConfirmButton

  public void setConfirmButton​(Component component)

  Sets custom confirm button

  Parameters:

  component - the element to display instead of default Confirm button

• setConfirmButton

  public void setConfirmButton​(Element element)

  Sets custom confirm button

  Parameters:

  element - the element to display instead of default Confirm button

• setText

  public void setText​(String message)

  Sets confirmation message text

• setText

  public void setText​(Component component)

  Sets custom confirmation message element

  Parameters:

  component - the component to display instead of default confirmation text node

• setText

  public void setText​(Element element)

  Sets custom confirmation message element

  Parameters:

  element - the element to display instead of default confirmation text node

• setConfirmText

  public void setConfirmText​(String confirmText)

  Sets Confirm button text

• setConfirmButtonTheme

  public void setConfirmButtonTheme​(String confirmTheme)

  Sets Confirm button theme

• addConfirmListener

  public Registration addConfirmListener​(ComponentEventListener<ConfirmDialog.ConfirmEvent> listener)

  Adds `confirm` event listener

• setCancelText

  public void setCancelText​(String cancelText)

  Sets Cancel button text

• setCancelButtonTheme

  public void setCancelButtonTheme​(String cancelTheme)

  Sets Cancel button theme

• addCancelListener

  public Registration addCancelListener​(ComponentEventListener<ConfirmDialog.CancelEvent> listener)

  Adds `cancel` event listener

• setRejectText

  public void setRejectText​(String rejectText)

  Sets Reject button text

• setRejectButtonTheme

  public void setRejectButtonTheme​(String rejectTheme)

  Sets Reject button theme

• addRejectListener

  public Registration addRejectListener​(ComponentEventListener<ConfirmDialog.RejectEvent> listener)

  Adds `reject` event listener

• setHeader

  public void setHeader​(String header)

  Sets confirmation dialog header text

• setHeader

  public void setHeader​(Component component)

  Sets confirmation dialog custom header element

  Parameters:

  component - the component to display instead of default header text

• setHeader

  public void setHeader​(Element element)

  Sets confirmation dialog custom header element

  Parameters:

  element - the element to display instead of default header text

• open

  public void open()

  Opens the dialog.

  Note: You don't need to add the dialog component before opening it, cause opening a dialog will automatically add it to the <body> if it's not yet attached anywhere.

• 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.

• isOpened

  @Synchronize(property="opened",
               value="opened-changed")
  public boolean isOpened()

• setOpened

  public void setOpened​(boolean opened)

  Opens or closes the dialog.

  Note: Confirm-dialog will be attached or detached from the DOM automatically, if it was not added manually.

  Parameters:

  opened - true to open the confirm-dialog, false to 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:

  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