|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.impl.ZScriptInitiator
public class ZScriptInitiator
An initiator used to evaluate a zscript file.
Used internally by Parser
to evaluate
the init directive with zscript:
<?init zscript="xxx"?>
Constructor Summary | |
---|---|
ZScriptInitiator(ZScript script)
|
Method Summary | |
---|---|
void |
doAfterCompose(Page page)
Called after all components are created (aka., composed), and before any event is processed. |
boolean |
doCatch(java.lang.Throwable ex)
Called when an exception occurs during the evaluation of the page. |
void |
doFinally()
Do the cleanup after the page has been evaluated. |
void |
doInit(Page page,
java.util.Map args)
Does the initializes before the page is evaluated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ZScriptInitiator(ZScript script)
Method Detail |
---|
public void doInit(Page page, java.util.Map args) throws java.lang.Exception
Initiator
Note: when it is called, Page.getDesktop()
,
Page.getId()
and Page.getTitle()
all return null, since
the page is not initialized yet.
To get the current desktop, you have to use
Execution.getDesktop()
(from
Executions.getCurrent()
) instead.
On the other hand, you can set the page's ID, title or style in
this method (to override the declarations in the page definition)
by Page.setId(java.lang.String)
, Page.setTitle(java.lang.String)
and Page.setStyle(java.lang.String)
.
In additions, Page.getRequestPath()
and Page.getAttribute(java.lang.String, int)
are all available.
doInit
in interface Initiator
page
- the page being evaluatedargs
- a map of arguments.
Prior to 3.6.2, it is an array. To upgrade, use args.get("arg0")
instead of args[0], args.get("arg1") instead of args[1] and so on.
Of course, it is better to have a more meaningful name for
each argument.
If no argument is specified, args is an empty map (never null).
java.lang.Exception
public void doAfterCompose(Page page) throws java.lang.Exception
Initiator
Note: if InitiatorExt
is also implemented,
this method won't be called. Rather, InitiatorExt.doAfterCompose(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Component[])
will be called instead.
For example, the data-binding managers could process the binding at this callback.
It won't be called if an un-caught exception occurs when creating components.
doAfterCompose
in interface Initiator
page
- the page that new components are attached to. It is the same
as Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map)
's page argument.
java.lang.Exception
public boolean doCatch(java.lang.Throwable ex)
Initiator
If you don't want to handle the exception, simply returns false.
boolean doCatch(Throwable ex) {return false;}
An exception thrown in this method is simply logged. It has no effect on the execution. If you want to ignore the exception, just return true.
Notice: this method won't be called if the exception occurs
in Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map)
.
doCatch
in interface Initiator
ex
- the exception being thrown
public void doFinally()
Initiator
Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map)
throws an exception.
However,it is always called no matter whether Initiator.doCatch(java.lang.Throwable)
is called.
An exception thrown in this method is simply logged. It has no effect on the execution.
doFinally
in interface Initiator
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |