Useful Java Utilities"

From Documentation
Line 94: Line 94:
 
[[Image:ZKDevRef_UIPattern_UsefulJavaUtil_Clients_showNotification03.png]]
 
[[Image:ZKDevRef_UIPattern_UsefulJavaUtil_Clients_showNotification03.png]]
  
  [since 6.1.0]
+
  [since 6.5.0]
 
Notification now supports closable to let user close the notification box manually.
 
Notification now supports closable to let user close the notification box manually.
  
Line 112: Line 112:
 
| Add Clients.showNotification()
 
| Add Clients.showNotification()
 
|-
 
|-
| 6.1.0
+
| 6.5.0
 
| July 2012
 
| July 2012
 
| [http://tracker.zkoss.org/browse/ZK-1145 ZK-1145]: Notification supports closable
 
| [http://tracker.zkoss.org/browse/ZK-1145 ZK-1145]: Notification supports closable

Revision as of 06:29, 25 July 2012


Useful Java Utilities


In this section we introduce some of the most commonly used Java utility classes.

Executions

org.zkoss.zk.ui.Executions

getCurrent

Executions.getCurrent()

Retrieves the current execution (request/response).

createComponents

Executions.createComponents()

With this method, you can create components defined in another zul file and attach them to the current page.

sendRedirect

Executions.sendRedirect()

Redirects to another URL. If the parameter is left null, it will redirect to the current page.


 

Sessions

org.zkoss.zk.ui.Sessions

getCurrent

Sessions.getCurrent()

Retrieves the current session.


 

Clients

org.zkoss.zk.ui.util.Clients

This class offers a collection of methods which manipulate client side via AU Response.

evalJavaScript

Clients.evalJavaScript()

This method sends an AU Response to execute the given JavaScript on client side, which is the standard way of calling JavaScript from server side in ZK. For example,

Clients.evalJavaScript("zk.log('Hi.');");

scrollIntoView

Clients.scrollIntoView()

Scrolls the parent of the given component, so the given one become visible in the view.

showBusy/clearBusy

Clients.showBusy()

Clients.clearBusy()

Display/dismiss a busy icon, so user knows server is working or has finished working on something. For example,

Clients.showBusy(window, "Waiting for server...");

ZKDevRef UIPattern UsefulJavaUtil Clients showBusy.png

showNotification

[since 6.0.1]

Clients.showNotification()

Show a notification box, which is dismissed upon left click (like Popup). You can either display a global notification (bigger) or one specific to another component (smaller with arrow pointing to it).

Clients.showNotification(msg); // display a global notification box
Clients.showNotification(msg, component); // display a notification box pointing to a component

ZKDevRef UIPattern UsefulJavaUtil Clients showNotification01.png

You can also specify its position, style, and duration (for auto-dismiss):

Clients.showNotification(msg, type, component, position, duration);

Type determines the style of the notification box.

ZKDevRef UIPattern UsefulJavaUtil Clients showNotification02.png

Here are the available positions:

ZKDevRef UIPattern UsefulJavaUtil Clients showNotification03.png

[since 6.5.0]

Notification now supports closable to let user close the notification box manually.

Clients.showNotification(msg, closable); // add close icon on the top right corner of notification box

ZKDevRef UIPattern UsefulJavaUtil Clients showNotification04.png

Version History

Last Update : 2012/07/25


Version Date Content
6.0.1 March 2012 Add Clients.showNotification()
6.5.0 July 2012 ZK-1145: Notification supports closable



Last Update : 2012/07/25

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