The org.zkoss.zk.ui.util.Initiator interface"

From Documentation
m
m
Line 1: Line 1:
 
  {{ZKConfigurationReferencePageHeader}}
 
  {{ZKConfigurationReferencePageHeader}}
'''Property:'''
+
 
  org.zkoss.zk.ui.util.Initiator interface
+
'''Listener:'''
 +
  org.zkoss.zk.ui.util.Initiator
  
 
  [since 5.0.7]
 
  [since 5.0.7]
  
<javadoc type="interface">org.zkoss.zk.ui.util.Initiator</javadoc> is implemented by a listener class that can used to handle the initialization of a page as if it is specified in [[ZUML Reference/ZUML/Processing Instructions/init|the init directive]]. It is called system-level initiators.
+
A listener could implement <javadoc type="interface">org.zkoss.zk.ui.util.Initiator</javadoc> to handle the initialization of a ZUML page, as if it is specified in [[ZUML Reference/ZUML/Processing Instructions/init|the init directive]]. This kind of listeners is called system-level initiators.
  
 
Each time a ZK page is created, ZK will instantiate one instance for each registered system-level initiator and the invoke <javadoc method="doInit(org.zkoss.zk.ui.Page, java.util.Map)" type="interface">org.zkoss.zk.ui.util.Initiator</javadoc> and other methods.
 
Each time a ZK page is created, ZK will instantiate one instance for each registered system-level initiator and the invoke <javadoc method="doInit(org.zkoss.zk.ui.Page, java.util.Map)" type="interface">org.zkoss.zk.ui.util.Initiator</javadoc> and other methods.

Revision as of 06:18, 20 April 2011


DocumentationZK Configuration Referencezk.xmlThe listener ElementThe org.zkoss.zk.ui.util.Initiator interface
The org.zkoss.zk.ui.util.Initiator interface


Listener:

org.zkoss.zk.ui.util.Initiator
[since 5.0.7]

A listener could implement Initiator to handle the initialization of a ZUML page, as if it is specified in the init directive. This kind of listeners is called system-level initiators.

Each time a ZK page is created, ZK will instantiate one instance for each registered system-level initiator and the invoke Initiator.doInit(Page, Map) and other methods.

If you want to process only certain pages, you can check the request path by calling Desktop.getRequestPath() (the desktop instance can be found thru the give component).

Since an individual instance will be instantiated for each page, the implementation needs not to be thread safe.



Last Update : 2011/04/20

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