Message Box"

From Documentation
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{ZKDevelopersGuidePageHeader}}
+
{{ZKDevelopersReferencePageHeader}}
  
=== Message Boxes with Servlet Thread ===
+
= Message Boxes with Servlet Thread =
  
 
When <javadoc method="show(java.lang.String)">org.zkoss.zul.Messagebox</javadoc> is called, it returns immediately after showing the message dialog. Furthermore, it always returns <tt>Messagebox.OK</tt>. Thus, it is meaningless to show buttons other than the OK button. For example, the <tt>if</tt> clause in the following example is never true.
 
When <javadoc method="show(java.lang.String)">org.zkoss.zul.Messagebox</javadoc> is called, it returns immediately after showing the message dialog. Furthermore, it always returns <tt>Messagebox.OK</tt>. Thus, it is meaningless to show buttons other than the OK button. For example, the <tt>if</tt> clause in the following example is never true.
Line 43: Line 43:
 
   
 
   
 
'''Note''': The event name for the OK button is <tt>onOK</tt>, not <tt>onOk</tt>.
 
'''Note''': The event name for the OK button is <tt>onOK</tt>, not <tt>onOk</tt>.
 +
'''Notice''': If you want to make it run under clustering environment,  you shall implement <javadoc  type="interface">org.zkoss.zk.ui.event.SerializableEventListener</javadoc>.  For more information, please refer to [[ZK Developer's  Reference/Clustering/Programming Tips|ZK Developer's Reference:  Clustering]].
  
=== Message Boxes with Event Thread Thread ===
+
= Message Boxes with Event Thread =
  
 
If the event thread is enabled,  <javadoc method="show(java.lang.String)">org.zkoss.zul.Messagebox</javadoc> will suspend the thread until the end user makes the choice. Thus, the following code works correctly.
 
If the event thread is enabled,  <javadoc method="show(java.lang.String)">org.zkoss.zul.Messagebox</javadoc> will suspend the thread until the end user makes the choice. Thus, the following code works correctly.
Line 55: Line 56:
 
</source>
 
</source>
  
{{ZKDevelopersGuidePageFooter}}
+
=Version History=
 +
{{LastUpdated}}
 +
{| border='1px' | width="100%"
 +
! Version !! Date !! Content
 +
|-
 +
| &nbsp;
 +
| &nbsp;
 +
| &nbsp;
 +
|}
 +
 
 +
{{ZKDevelopersReferencePageFooter}}

Revision as of 09:11, 13 October 2011

Message Boxes with Servlet Thread

When Messagebox.show(String) is called, it returns immediately after showing the message dialog. Furthermore, it always returns Messagebox.OK. Thus, it is meaningless to show buttons other than the OK button. For example, the if clause in the following example is never true.

 if (Messagebox.show("Delete?", "Prompt", Messagebox.YES|Messagebox.NO,
     Messagebox.QUESTION) == Messagebox.YES) {
     this_never_executes();
 }

Rather, you have to provide an event listener as follows.

 Messagebox.show("Delete?", "Prompt", Messagebox.YES|Messagebox.NO,
     Messagebox.QUESTION,
     new EventListener() {
         public void onEvent(Event evt) {
             switch (((Integer)evt.getData()).intValue()) {
             case Messagebox.YES: doYes(); break; //the Yes button is pressed
             case Messagebox.NO: doNo(); break; //the No button is pressed
             }
         }
     }
 );

The event listener you provided is invoked when the user clicks one of the buttons. Then, you can identify which button is clicked by examining the data (Event's getData). The data is an integer whose value is the button's identifier, such as Messagebox.YES.

Alternatively, you can examine the event name:

 public void onEvent(Event evt) {
     if ("onYes".equals(evt.getName())) {
         doYes(); //the Yes button is pressed
     } else if ("onNo".equals(evt.getName())) {
         doNo(); //the No button is pressed
     }
 }

Note: The event name for the OK button is onOK, not onOk. Notice: If you want to make it run under clustering environment, you shall implement SerializableEventListener. For more information, please refer to ZK Developer's Reference: Clustering.

Message Boxes with Event Thread

If the event thread is enabled, Messagebox.show(String) will suspend the thread until the end user makes the choice. Thus, the following code works correctly.

 if (Messagebox.show("Delete?", "Prompt", Messagebox.YES|Messagebox.NO,
     Messagebox.QUESTION) == Messagebox.YES) {
     //execute only if the YES button is clicked
 }

Version History

Last Update : 2011/10/13


Version Date Content
     



Last Update : 2011/10/13

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.