init"
Maya001122 (talk | contribs) (Created page with '== The init Directive == <source lang="xml" > <?init class="..." [arg0="..."] [arg1="..."] [arg2="..."] [arg3="..."]?> <?init zscript="..."?> </source> There are two formats.…') |
Maya001122 (talk | contribs) |
||
| Line 8: | Line 8: | ||
There are two formats. The first format is to specify a class that is used to do the application-specific initialization. The second format is to specify a <tt>zscript</tt> file to do the application-specific initialization. | There are two formats. The first format is to specify a class that is used to do the application-specific initialization. The second format is to specify a <tt>zscript</tt> file to do the application-specific initialization. | ||
| − | The initialization takes place before the page is evaluated and attached to a desktop. Thus, the <tt>getDesktop</tt>, <tt>getId</tt> and <tt>getTitle</tt> method will return null, when initializing. To retrieve the current desktop, you could use the < | + | The initialization takes place before the page is evaluated and attached to a desktop. Thus, the <tt>getDesktop</tt>, <tt>getId</tt> and <tt>getTitle</tt> method will return null, when initializing. To retrieve the current desktop, you could use the <javadoc>org.zkoss.zk.ui.Execution</javadoc> interface. |
| − | You could specify any number of the <tt>init</tt> directive. The specified class must implement the < | + | You could specify any number of the <tt>init</tt> directive. The specified class must implement the <javadoc>org.zkoss.zk.ui.util.Initator</javadoc> interface. |
<source lang="xml" > | <source lang="xml" > | ||
| Line 29: | Line 29: | ||
</source> | </source> | ||
| − | A class name that must implement the < | + | A class name that must implement the <javadoc>org.zkoss.zk.ui.util.Initator</javadoc> interface. Unlike the <tt>init</tt> directive, the class name cannot be the class that is defined in zscript codes. |
An instance of the specified class is constructed and its <tt>doInit</tt> method is called in the Page Initial phase (i.e., before the page is evaluated). The <tt>doFinally</tt> method is called after the page has been evaluated. The <tt>doCatch</tt> method is called if an exception occurs during the evaluation. | An instance of the specified class is constructed and its <tt>doInit</tt> method is called in the Page Initial phase (i.e., before the page is evaluated). The <tt>doFinally</tt> method is called after the page has been evaluated. The <tt>doCatch</tt> method is called if an exception occurs during the evaluation. | ||
Revision as of 04:14, 8 July 2010
The init Directive
<?init class="..." [arg0="..."] [arg1="..."] [arg2="..."] [arg3="..."]?>
<?init zscript="..."?>
There are two formats. The first format is to specify a class that is used to do the application-specific initialization. The second format is to specify a zscript file to do the application-specific initialization.
The initialization takes place before the page is evaluated and attached to a desktop. Thus, the getDesktop, getId and getTitle method will return null, when initializing. To retrieve the current desktop, you could use the Execution interface.
You could specify any number of the init directive. The specified class must implement the Initator interface.
<?init class="MyInit1"?>
<?init class="MyInit2"?>
Since 3.6.2, you can use any (readable) name instead of arg0 and so on. For example,
<?init class="org.zkoss.zkplus.databind.AnnotateDataBinderInit" root="./abc"?>
class
[Optional]
A class name that must implement the Initator interface. Unlike the init directive, the class name cannot be the class that is defined in zscript codes.
An instance of the specified class is constructed and its doInit method is called in the Page Initial phase (i.e., before the page is evaluated). The doFinally method is called after the page has been evaluated. The doCatch method is called if an exception occurs during the evaluation.
Thus, you could also use it for cleanup and error handling.
zscript
[Optional]
A script file that will be evaluated in the Page Initial phase.
arg0, arg1...
[Optional]
You could specify any number of arguments. It will be passed to the doInit method if the first format is used. Since 3.6.2, you can use any name for the arguments, but, in the prior version, the first argument is arg0, the second is arg1 and follows.