Useful Java Utilities"

From Documentation
m (ZK-4372: Extract Notification functionalities from Clients)
Line 70: Line 70:
 
  [since 6.0.1]
 
  [since 6.0.1]
 
[http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/util/Clients.html#showNotification(java.lang.String) Clients.showNotification()]
 
[http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/util/Clients.html#showNotification(java.lang.String) Clients.showNotification()]
 +
[since 9.0.0]
 +
It is advised to use [http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/util/Notification.html Notification class] which was introduced in ZK 9 instead.
  
 
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 an arrow pointing to it).
 
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 an arrow pointing to it).
Line 110: Line 112:
 
<source lang='java'>
 
<source lang='java'>
 
Clients.showNotification("msg1 <br/> msg2 <br/>");
 
Clients.showNotification("msg1 <br/> msg2 <br/>");
 +
</source>
 +
 +
=Notification=
 +
[since 9.0.0]
 +
 +
[http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/util/Notification.html org.zkoss.zk.ui.util.Notification]
 +
 +
This class offers a collection of methods showing 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 an arrow pointing to it).
 +
 +
<source lang="java">
 +
Notification.show(msg); // display a global notification box
 +
Notification.show(msg, component); // display a notification box pointing to a component
 
</source>
 
</source>
  
Line 124: Line 138:
 
| 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
 +
|-
 +
| 9.0.0
 +
| Sep 2019
 +
| [http://tracker.zkoss.org/browse/ZK-4372 ZK-4372]: Extract Notification functionalities from Clients
 
|}
 
|}
  
 
{{ZKDevelopersReferencePageFooter}}
 
{{ZKDevelopersReferencePageFooter}}

Revision as of 10:30, 16 September 2019


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(Component cmp)

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()

[since 9.0.0]

It is advised to use Notification class which was introduced in ZK 9 instead.

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 an 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

Closable

[since 6.5.0]

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

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

ZKDevRef UIPattern UsefulJavaUtil Clients showNotification04.png


Multiline

To show a multiline message, just append
in the message string.

Clients.showNotification("msg1 <br/> msg2 <br/>");

Notification

[since 9.0.0]

org.zkoss.zk.ui.util.Notification

This class offers a collection of methods showing 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 an arrow pointing to it).

Notification.show(msg); // display a global notification box
Notification.show(msg, component); // display a notification box pointing to a component

Version History

Last Update : 2019/09/16


Version Date Content
6.0.1 March 2012 Add Clients.showNotification()
6.5.0 July 2012 ZK-1145: Notification supports closable
9.0.0 Sep 2019 ZK-4372: Extract Notification functionalities from Clients



Last Update : 2019/09/16

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