Package org.zkoss.zul

Class Messagebox

java.lang.Object
org.zkoss.zul.Messagebox

public class Messagebox extends Object
Author:
tomyeh
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    The button types.
    static class 
    The event that will be received by the listener when the user clicks a button.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    A Abort button.
    static final int
    A Cancel button.
    static final String
    A symbol consisting of a white X in a circle with a red background.
    static final String
    A symbol consisting of an exclamation point in a triangle with a yellow background
    static final int
    A IGNORE button.
    static final String
    A symbol of a lower case letter i in a circle.
    static final int
    A No button.
    static final String
    Contains no symbols.
    static final int
    A OK button.
    static final String
    The event to indicate the Abort button being clicked.
    static final String
    The event to indicate the Cancel button being clicked.
    static final String
    The event to indicate the Ignore button being clicked.
    static final String
    The event to indicate the No button being clicked.
    static final String
    The event to indicate the OK button being clicked.
    static final String
    The event to indicate the RETRY button being clicked.
    static final String
    The event to indicate the Yes button being clicked.
    static final String
    A symbol consisting of a question mark in a circle.
    static final int
    A Retry button.
    static final int
    A Yes button.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    Returns the template used to create the message dialog.
    static void
    Sets the template used to create the message dialog.
    static int
    show(int messageCode, int titleCode, int buttons, String icon)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, int titleCode, int buttons, String icon, int focus)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, int titleCode, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, Object[] args, int titleCode, int buttons, String icon)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, Object[] args, int titleCode, int buttons, String icon, int focus)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, Object[] args, int titleCode, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, Object arg, int titleCode, int buttons, String icon)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, Object arg, int titleCode, int buttons, String icon, int focus)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(int messageCode, Object arg, int titleCode, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
    Shows a message box by specifying a message code, and returns what button is pressed.
    static int
    show(String message)
    Shows a message box and returns what button is pressed.
    static int
    show(String message, String title, int buttons, String icon)
    Shows a message box and returns what button is pressed.
    static int
    show(String message, String title, int buttons, String icon, int focus)
    Shows a message box and returns what button is pressed.
    static int
    show(String message, String title, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
    Shows a message box and returns what button is pressed.
    static int
    show(String message, String title, int buttons, String icon, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
    Shows a message box and returns what button is pressed.
    show(String message, String title, Messagebox.Button[] buttons, String[] btnLabels, String icon, Messagebox.Button focus, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
    Shows a message box and returns what button is pressed.
    show(String message, String title, Messagebox.Button[] buttons, String[] btnLabels, String icon, Messagebox.Button focus, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener, Map<String,String> params)
    Shows a message box and returns what button is pressed.
    show(String message, String title, Messagebox.Button[] buttons, String icon, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
    Shows a message box and returns what button is pressed.
    show(String message, String title, Messagebox.Button[] buttons, String icon, Messagebox.Button focus, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
    Shows a message box and returns what button is pressed.
    show(String message, Messagebox.Button[] buttons, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
    Shows a message box and returns what button is pressed.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • QUESTION

      public static final String QUESTION
      A symbol consisting of a question mark in a circle.

      Since 3.5.0, they are actually style class names to display the icon.

      See Also:
    • EXCLAMATION

      public static final String EXCLAMATION
      A symbol consisting of an exclamation point in a triangle with a yellow background

      Since 3.5.0, they are actually style class names to display the icon.

      See Also:
    • INFORMATION

      public static final String INFORMATION
      A symbol of a lower case letter i in a circle.

      Since 3.5.0, they are actually style class names to display the icon.

      See Also:
    • ERROR

      public static final String ERROR
      A symbol consisting of a white X in a circle with a red background.

      Since 3.5.0, they are actually style class names to display the icon.

      See Also:
    • NONE

      public static final String NONE
      Contains no symbols.
    • OK

      public static final int OK
      A OK button.
      See Also:
    • CANCEL

      public static final int CANCEL
      A Cancel button.
      See Also:
    • YES

      public static final int YES
      A Yes button.
      See Also:
    • NO

      public static final int NO
      A No button.
      See Also:
    • ABORT

      public static final int ABORT
      A Abort button.
      See Also:
    • RETRY

      public static final int RETRY
      A Retry button.
      See Also:
    • IGNORE

      public static final int IGNORE
      A IGNORE button.
      See Also:
    • ON_YES

      public static final String ON_YES
      The event to indicate the Yes button being clicked.
      Since:
      5.0.8
      See Also:
    • ON_NO

      public static final String ON_NO
      The event to indicate the No button being clicked.
      Since:
      5.0.8
      See Also:
    • ON_RETRY

      public static final String ON_RETRY
      The event to indicate the RETRY button being clicked.
      Since:
      5.0.8
      See Also:
    • ON_ABORT

      public static final String ON_ABORT
      The event to indicate the Abort button being clicked.
      Since:
      5.0.8
      See Also:
    • ON_IGNORE

      public static final String ON_IGNORE
      The event to indicate the Ignore button being clicked.
      Since:
      5.0.8
      See Also:
    • ON_OK

      public static final String ON_OK
      The event to indicate the OK button being clicked.
      Since:
      5.0.8
      See Also:
    • ON_CANCEL

      public static final String ON_CANCEL
      The event to indicate the Cancel button being clicked.
      Since:
      5.0.8
      See Also:
  • Constructor Details

    • Messagebox

      public Messagebox()
  • Method Details

    • show

      public static Messagebox.Button show(String message, String title, Messagebox.Button[] buttons, String[] btnLabels, String icon, Messagebox.Button focus, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener, Map<String,String> params)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - an array of buttons to show. The buttons will be displayed in the same order in the array.
      btnLabels - the label used for each button specified in the buttons argument. If null, the default label will be used.
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      focus - one of button to have to focus. If null, the first button will gain the focus.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled (system default), this method always return Messagebox.Button.OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked with an instance of Messagebox.ClickEvent. You can identify which button is clicked by examining Messagebox.ClickEvent.getButton() or Event.getName(). If the close button is clicked, the onClose event is sent and Messagebox.ClickEvent.getButton() return null;
      params - the parameters passed to the template. Ignored if null. Notice it will override the default parameters if there is any conflict. You could pass anything as long as the template (setTemplate(java.lang.String)) recognized. For the default template, typical parameters are
      width: the width of the dialog.
      icon: the URI of the icon sclass: the CSS class name of the top level Window (since 7.0.1)
      Returns:
      the button being pressed. Note: if the event processing thread is disabled (system default), it always returns Messagebox.Button.OK.
      Since:
      6.0.0
    • show

      public static Messagebox.Button show(String message, String title, Messagebox.Button[] buttons, String[] btnLabels, String icon, Messagebox.Button focus, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - an array of buttons to show. The buttons will be displayed in the same order in the array.
      btnLabels - the label used for each button specified in the buttons argument. If null, the default label will be used.
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      focus - one of button to have to focus. If null, the first button will gain the focus.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled (system default), this method always return Messagebox.Button.OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked with an instance of Messagebox.ClickEvent. You can identify which button is clicked by examining Messagebox.ClickEvent.getButton() or Event.getName(). If the close button is clicked, the onClose event is sent and Messagebox.ClickEvent.getButton() return null;
      Returns:
      the button being pressed. Note: if the event processing thread is disabled (system default), it always returns Messagebox.Button.OK.
      Since:
      6.0.0
    • show

      public static Messagebox.Button show(String message, String title, Messagebox.Button[] buttons, String icon, Messagebox.Button focus, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - an array of buttons to show. The buttons will be displayed in the same order in the array.
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      focus - one of button to have to focus. If null, the first button will gain the focus.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled (system default), this method always return Messagebox.Button.OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked with an instance of Messagebox.ClickEvent. You can identify which button is clicked by examining Messagebox.ClickEvent.getButton() or Event.getName(). If the close button is clicked, the onClose event is sent and Messagebox.ClickEvent.getButton() return null;
      Returns:
      the button being pressed. Note: if the event processing thread is disabled (system default), it always returns Messagebox.Button.OK.
      Since:
      6.0.0
    • show

      public static Messagebox.Button show(String message, String title, Messagebox.Button[] buttons, String icon, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
      Shows a message box and returns what button is pressed. A shortcut to show(message, title, buttons, icon, null, listener).
      Since:
      6.0.0
    • show

      public static Messagebox.Button show(String message, Messagebox.Button[] buttons, org.zkoss.zk.ui.event.EventListener<Messagebox.ClickEvent> listener)
      Shows a message box and returns what button is pressed. A shortcut to show(message, null, buttons, INFORMATION, null, listener).
      Since:
      6.0.0
    • show

      public static int show(String message, String title, int buttons, String icon)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - a combination of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE. If zero, OK is assumed
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
    • show

      public static int show(String message, String title, int buttons, String icon, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - a combination of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE. If zero, OK is assumed
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled, this method always return OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked. You can identify which button is clicked by examining the event name (Event.getName()) as shown in the following table. Alternatively, you can examine the value of Event.getData(), which must be an integer representing the button, such as OK, YES and so on.
      Button NameEvent Name
      OKonOK (ON_OK)
      CancelonCancel (ON_CANCEL)
      YesonYes (ON_YES)
      NoonNo (ON_NO)
      RetryonRetry (ON_RETRY)
      AbortonAbort (ON_ABORT)
      IgnoreonIgnore (ON_IGNORE)
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.4
    • show

      public static int show(String message, String title, int buttons, String icon, int focus)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - a combination of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE. If zero, OK is assumed
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.0
    • show

      public static int show(String message, String title, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
      Shows a message box and returns what button is pressed.
      Parameters:
      title - the title. If null, WebApp.getAppName() is used.
      buttons - a combination of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE. If zero, OK is assumed
      icon - one of predefined images: QUESTION, EXCLAMATION, ERROR, NONE, or any style class name(s) to show an image.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled, this method always return OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked. You can identify which button is clicked by examining the event name (Event.getName()) as shown in the following table. Alternatively, you can examine the value of Event.getData(), which must be an integer representing the button, such as OK, YES and so on.
      ButtonEvent Name
      OKonOK (ON_OK)
      CancelonCancel (ON_CANCEL)
      YesonYes (ON_YES)
      NoonNo (ON_NO)
      RetryonRetry (ON_RETRY)
      AbortonAbort (ON_ABORT)
      IgnoreonIgnore (ON_IGNORE)
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.4
    • show

      public static int show(String message)
      Shows a message box and returns what button is pressed. A shortcut to show(message, null, OK, INFORMATION).
    • show

      public static int show(int messageCode, Object[] args, int titleCode, int buttons, String icon)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
    • show

      public static int show(int messageCode, Object[] args, int titleCode, int buttons, String icon, int focus)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.0
    • show

      public static int show(int messageCode, Object[] args, int titleCode, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled, this method always return OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked. You can identify which button is clicked by examining the event name (Event.getName()) as shown in the following table. Alternatively, you can examine the value of Event.getData(), which must be an integer representing the button, such as OK, YES and so on.
      ButtonEvent Name
      OKonOK (ON_OK)
      CancelonCancel (ON_CANCEL)
      YesonYes (ON_YES)
      NoonNo (ON_NO)
      RetryonRetry (ON_RETRY)
      AbortonAbort (ON_ABORT)
      IgnoreonIgnore (ON_IGNORE)
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.4
    • show

      public static int show(int messageCode, Object arg, int titleCode, int buttons, String icon)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
    • show

      public static int show(int messageCode, Object arg, int titleCode, int buttons, String icon, int focus)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.0
    • show

      public static int show(int messageCode, Object arg, int titleCode, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled, this method always return OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked. You can identify which button is clicked by examining the event name (Event.getName()) as shown in the following table. Alternatively, you can examine the value of Event.getData(), which must be an integer representing the button, such as OK, YES and so on.
      ButtonEvent Name
      OKonOK (ON_OK)
      CancelonCancel (ON_CANCEL)
      YesonYes (ON_YES)
      NoonNo (ON_NO)
      RetryonRetry (ON_RETRY)
      AbortonAbort (ON_ABORT)
      IgnoreonIgnore (ON_IGNORE)
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.4
    • show

      public static int show(int messageCode, int titleCode, int buttons, String icon)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
    • show

      public static int show(int messageCode, int titleCode, int buttons, String icon, int focus)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      Since:
      3.0.0
    • show

      public static int show(int messageCode, int titleCode, int buttons, String icon, int focus, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)
      Shows a message box by specifying a message code, and returns what button is pressed.
      Parameters:
      titleCode - the message code for the title. If non-positive, the default title is used.
      focus - one of button to have to focus. If 0, the first button will gain the focus. One of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE.
      listener - the event listener which is invoked when a button is clicked. Ignored if null. It is useful if the event processing thread is disabled (Configuration.enableEventThread(boolean)). If the event processing thread is disabled, this method always return OK. To know which button is pressed, you have to pass an event listener. Then, when the user clicks a button, the event listener is invoked. You can identify which button is clicked by examining the event name (Event.getName()) as shown in the following table. Alternatively, you can examine the value of Event.getData(), which must be an integer representing the button, such as OK, YES and so on.
      ButtonEvent Name
      OKonOK (ON_OK)
      CancelonCancel (ON_CANCEL)
      YesonYes (ON_YES)
      NoonNo (ON_NO)
      RetryonRetry (ON_RETRY)
      AbortonAbort (ON_ABORT)
      IgnoreonIgnore (ON_IGNORE)
      The close button on the right-top corner (x)
      since 5.0.2
      onClose
      Returns:
      the button being pressed (one of OK, CANCEL, YES, NO, ABORT, RETRY, and IGNORE). Note: if the event processing thread is disabled, it always returns OK.
      Since:
      3.0.4
    • setTemplate

      public static void setTemplate(String uri)
      Sets the template used to create the message dialog.

      The template must follow the default template: ~./zul/html/messagebox.zul

      In other words, just adjust the label and layout and don't change the component's ID.

    • getTemplate

      public static String getTemplate()
      Returns the template used to create the message dialog.