Notifications"
From Documentation
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ZKClient-sideReferencePageHeader}} | {{ZKClient-sideReferencePageHeader}} | ||
− | In this section we discuss the | + | In this section, we discuss the notifications on the client side. |
− | + | There are 3 ways to notify: | |
+ | # widget events (<javadoc directory="jsdoc">zk.Event</javadoc>) | ||
+ | #: A widget event is a widget-level event. It is used either to encapsulate a DOM event, or to represent a notification specific to a widget, or to an application. | ||
+ | # DOM events (<javadoc directory="jsdoc">jq.Event</javadoc>) | ||
+ | #: A DOM event (Event) is the DOM-level (i.e., low-level) event that is usually triggered by the browser. It is usually listened by a widget itself, rather than the client application. | ||
+ | # client activity watches | ||
+ | #: A client activity watch is a notification for special activities that are not available as DOM events or widget events, for example, the notification when a widget is becoming invisible. | ||
− | For a complete reference, please refer to [http://zkoss.org/javadoc/latest/jsdoc/ JavaScript APIs]. | + | It is generally suggested to listen to widget events (rather than DOM events) if possible since it is easier and more efficient. |
+ | |||
+ | They are mainly used for component development. Application developers '''rarely need''' it. For a complete reference, please refer to [http://zkoss.org/javadoc/latest/jsdoc/ JavaScript APIs]. | ||
{{ZKClient-sideReferenceHeadingToc}} | {{ZKClient-sideReferenceHeadingToc}} | ||
{{ZKClient-sideReferencePageFooter}} | {{ZKClient-sideReferencePageFooter}} |
Latest revision as of 07:11, 14 July 2023
In this section, we discuss the notifications on the client side.
There are 3 ways to notify:
- widget events (Event)
- A widget event is a widget-level event. It is used either to encapsulate a DOM event, or to represent a notification specific to a widget, or to an application.
- DOM events (Event)
- A DOM event (Event) is the DOM-level (i.e., low-level) event that is usually triggered by the browser. It is usually listened by a widget itself, rather than the client application.
- client activity watches
- A client activity watch is a notification for special activities that are not available as DOM events or widget events, for example, the notification when a widget is becoming invisible.
It is generally suggested to listen to widget events (rather than DOM events) if possible since it is easier and more efficient.
They are mainly used for component development. Application developers rarely need it. For a complete reference, please refer to JavaScript APIs.