Package org.zkoss.zk.ui.metainfo

Class InitiatorInfo

java.lang.Object

org.zkoss.zk.ui.metainfo.InitiatorInfo

public class InitiatorInfo
extends Object

The init directive in the ZUML page.

Note: we resolve the class by using Classes.forNameByThread. In other words, it doesn't support the class defined in zscript. Why not? Since there is no way to run zscript before the init directive (and better performance).

Note: it is not serializable.

Author:

tomyeh

Constructor Summary

Constructors

Constructor	Description
InitiatorInfo(Class<? extends Initiator> cls, Map<String,String> args)	Constructs with a class, and newInitiator(org.zkoss.zk.ui.metainfo.PageDefinition, org.zkoss.zk.ui.Page) will instantiate a new instance.
InitiatorInfo(String clsnm, Map<String,String> args)	Constructs with a class name and newInitiator(org.zkoss.zk.ui.metainfo.PageDefinition, org.zkoss.zk.ui.Page) will instantiate a new instance.
InitiatorInfo(Initiator init, Map<String,String> args)	Constructs with an initiator that will be reuse each time newInitiator(org.zkoss.zk.ui.metainfo.PageDefinition, org.zkoss.zk.ui.Page) is called.

Method Summary

Modifier and Type	Method	Description
Initiator	newInitiator(PageDefinition pgdef, Page page)	Creates and returns the initiator, or null if no initiator is resolved.
Initiator	newInitiator(Evaluator eval, Page page)	Creates and returns the initiator, or null if no initiator is resolved.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InitiatorInfo

public InitiatorInfo(Class<? extends Initiator> cls,
 Map<String,String> args)

Constructs with a class, and newInitiator(org.zkoss.zk.ui.metainfo.PageDefinition, org.zkoss.zk.ui.Page) will instantiate a new instance.

Parameters:

args - the map of arguments. Ignored if null.
Notice that, once assigned, the map belongs to this object, and the caller shall not access it again

Since:

3.6.2

InitiatorInfo

public InitiatorInfo(String clsnm,
 Map<String,String> args)
              throws ClassNotFoundException

Constructs with a class name and newInitiator(org.zkoss.zk.ui.metainfo.PageDefinition, org.zkoss.zk.ui.Page) will instantiate a new instance.

Parameters:

clsnm - the class name; it could be an EL expression.

Throws:

ClassNotFoundException

Since:

3.6.2

InitiatorInfo

public InitiatorInfo(Initiator init,
 Map<String,String> args)

Constructs with an initiator that will be reuse each time newInitiator(org.zkoss.zk.ui.metainfo.PageDefinition, org.zkoss.zk.ui.Page) is called.

Since:

3.6.2

Method Details

newInitiator

public Initiator newInitiator(PageDefinition pgdef,
 Page page)
                       throws Exception

Creates and returns the initiator, or null if no initiator is resolved. Notice that Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>) was called before returned.

Throws:

Exception

newInitiator

public Initiator newInitiator(Evaluator eval,
 Page page)
                       throws Exception

Creates and returns the initiator, or null if no initiator is resolved. Notice that Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>) was called before returned.

Throws:

Exception

Since:

3.6.2