Widget Events"
m |
m |
||
| Line 1: | Line 1: | ||
{{ZKClient-sideReferencePageHeader}} | {{ZKClient-sideReferencePageHeader}} | ||
| − | + | __TOC__ | |
| + | A widget event is the widget-level event (<javadoc directory="jsdoc">zk.Event</javadoc>). | ||
| + | |||
| + | Like <javadoc>org.zkoss.zk.event.Event</javadoc> 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, <javadoc directory="jsdoc">jq.Event</javadoc>). | ||
| + | |||
| + | =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>. | ||
| + | =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>. | 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>. | ||
| + | =Event Listening for Application Developers= | ||
To listen a widget event, you could invoke <javadoc method="listen(_global_.Map, int)" directory="jsdoc">zk.Widget</javadoc>. | To listen a widget event, you could invoke <javadoc method="listen(_global_.Map, int)" directory="jsdoc">zk.Widget</javadoc>. | ||
| + | |||
| + | =Event Listening for Component Developers= | ||
=Version History= | =Version History= | ||
Revision as of 07:37, 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 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].
Event Firing
To fire a widget event, you could invoke Widget.fire(String, Object, Map, int) or Widget.fireX(Event, int).
Event Listening for Application Developers
To listen a widget event, you could invoke Widget.listen(Map, int).
Event Listening for Component Developers
Version History
| Version | Date | Content |
|---|---|---|
- ↑ For more information, please refer to the AU Requests section.