Client-side Firing"

From Documentation
m
Line 15: Line 15:
 
</source>
 
</source>
  
The event will be ''propagated'' to the widget's parent, parent's parent and so on.
+
The event will be ''propagated'' to the widget's parent, parent's parent and so on, until all ancestors are notified, or the propagation has been stopped by <javadoc method="stop(_global_.Map)" directory="jsdoc">zk.Event</javadoc>.
[[zk.Widget#fire]] fires a client event (an instance of [[zk.Event]]), and the client event is converted to an AU request if all the following conditions are satisfied.
 
  
* The widget is a peer of a component, that is, it was created automatically to represent a component. Notice that [[zk.Widget#inServer|inServer]] indicates if a widget is a peer of a component.
+
After the widget and all of its ancestors are notified, this event is converted to an AU request and sent to the server, if
* The event propagation is not stopped (i.e., [[zk.Widget#stop]] not set.
+
 
* The event is listened by a server-side listener (<code>org.zkoss.zk.ui.Listener</code>), or it is [[#Important Events|an important event]].
+
#The widget has a peer component, i.e., the widget was created by ZK Client Engine because of the instantiation of a component at the server.
 +
#Or, the <tt>toServer</tt> option has been specified in <javadoc directory="jsdoc" method="opts">zk.Event</javadoc> of the event.
  
 
=Fire Event to Desktop=
 
=Fire Event to Desktop=

Revision as of 03:55, 17 December 2010

In general, an AU request is caused by a widget event (Event) that is going to be sent to the server. It happens when a widget event is targeting a widget that is created at the server, or with the toServer option (specified in Event.opts). In additions, you could invoke Au.fire() explicitly to fire an AU request to the server.

Fire Event to Widget

An event can be fired to a widget by use of Widget.fire(String, Object, Map, int) and Widget.fireX(Event, int). For example,

onCloseClick: function () {
 this.fire('onClose');
}

The event will be propagated to the widget's parent, parent's parent and so on, until all ancestors are notified, or the propagation has been stopped by Event.stop(Map).

After the widget and all of its ancestors are notified, this event is converted to an AU request and sent to the server, if

  1. The widget has a peer component, i.e., the widget was created by ZK Client Engine because of the instantiation of a component at the server.
  2. Or, the toServer option has been specified in Event.opts of the event.

Fire Event to Desktop

Fire Event Directly to Server

Version History

Last Update : 2010/12/17


Version Date Content
     



Last Update : 2010/12/17

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