Widget Events"
m |
|||
| Line 8: | Line 8: | ||
In additions, ZK Client Engine intercepts most DOM events and encapsulate them into widgets events, such that it is easier and more efficient for component developers to handle events at widget-level (rather than DOM-level, <javadoc directory="jsdoc">jq.Event</javadoc>). | In additions, ZK Client Engine intercepts most DOM events and encapsulate them into widgets events, such that it is easier and more efficient for component developers to handle events at widget-level (rather than DOM-level, <javadoc directory="jsdoc">jq.Event</javadoc>). | ||
| − | |||
| − | |||
| − | |||
=Event Listening for Application Developers= | =Event Listening for Application Developers= | ||
| Line 19: | Line 16: | ||
==Event Propgation == | ==Event Propgation == | ||
A widget event will be ''propagated'' to the parent widget, parent's parent and so on, until stopped (<javadoc method="stop(_global_.Map)" directory="jsdoc">zk.Event</javadoc>). Then, if the event is required by the server, it will be sent to the server, and converted to an instance of <javadoc type="interface">org.zkoss.zk.au.AuRequest</javadoc> at the server<ref>For more information, please refer to the [[ZK Client-side Reference/Communication/AU Requests|AU Requests]] section.</ref>. | A widget event will be ''propagated'' to the parent widget, parent's parent and so on, until stopped (<javadoc method="stop(_global_.Map)" directory="jsdoc">zk.Event</javadoc>). Then, if the event is required by the server, it will be sent to the server, and converted to an instance of <javadoc type="interface">org.zkoss.zk.au.AuRequest</javadoc> at the server<ref>For more information, please refer to the [[ZK Client-side Reference/Communication/AU Requests|AU Requests]] section.</ref>. | ||
| + | |||
| + | <blockquote> | ||
| + | ---- | ||
| + | <references/> | ||
| + | </blockquote> | ||
| + | |||
| + | =Event Firing= | ||
| + | To fire a widget event, you could invoke <javadoc method="fire(_global_.String, zk.Object, _global_.Map, int)" directory="jsdoc">zk.Widget</javadoc> or <javadoc method="fireX(zk.Event, int)" directory="jsdoc">zk.Widget</javadoc>. | ||
| + | |||
| + | Then, the listeners registered with <javadoc method="listen(_global_.Map, int)" directory="jsdoc">zk.Widget</javadoc> will be invoked one-by-one. Then, it will be sent to the server, if an event listener has been registered at the server or it is an import event<ref>For more information, please refer to the [[ZK Client-side Reference/Communication/AU Requests|AU Requests]] section.</ref>. | ||
| + | |||
| + | A client-side event listener could stop the sending of a widget event to the server by invoking <javadoc method="stop(_global_.Map)" directory="jsdoc">zk.Event</javadoc> with <code>{au:true}</code>, such as | ||
| + | |||
| + | <source lang="javascript"> | ||
| + | evt.stop({au: true}); | ||
| + | </source> | ||
<blockquote> | <blockquote> | ||
Revision as of 08:41, 20 December 2010
A widget event is the widget-level event (Event).
Like Event at the server side, the widget event can be any thing, and can be triggered by a widget or an application to notify a widget-level or application-level event, such as a window has been moved.
In additions, ZK Client Engine intercepts most DOM events and encapsulate them into widgets events, such that it is easier and more efficient for component developers to handle events at widget-level (rather than DOM-level, Event).
Event Listening for Application Developers
To listen a widget event, you could invoke Widget.listen(Map, int).
Event Listening for Component Developers
Event Propgation
A widget event will be propagated to the parent widget, parent's parent and so on, until stopped (Event.stop(Map)). Then, if the event is required by the server, it will be sent to the server, and converted to an instance of AuRequest at the server[1].
- ↑ For more information, please refer to the AU Requests section.
Event Firing
To fire a widget event, you could invoke Widget.fire(String, Object, Map, int) or Widget.fireX(Event, int).
Then, the listeners registered with Widget.listen(Map, int) will be invoked one-by-one. Then, it will be sent to the server, if an event listener has been registered at the server or it is an import event[1].
A client-side event listener could stop the sending of a widget event to the server by invoking Event.stop(Map) with {au:true}, such as
evt.stop({au: true});
- ↑ For more information, please refer to the AU Requests section.
Version History
| Version | Date | Content |
|---|---|---|