org.zkoss.zk.ui.metainfo
Class VariablesInfo

java.lang.Object
  extended by org.zkoss.zk.ui.metainfo.VariablesInfo
All Implemented Interfaces:
java.io.Serializable, Condition

public class VariablesInfo
extends java.lang.Object
implements Condition, java.io.Serializable

The information about the variables element in the ZUML page.

Author:
tomyeh
See Also:
Serialized Form

Constructor Summary
VariablesInfo(EvaluatorRef evalr, java.util.Map vars, boolean local, ConditionImpl cond)
          The same as VariablesInfo(evalr, vars, locale, "none", cond).
VariablesInfo(EvaluatorRef evalr, java.util.Map vars, boolean local, java.lang.String composite, ConditionImpl cond)
          Constructor.
 
Method Summary
 void apply(Component comp)
          Applies the variable element against the parent component.
 void apply(Page page)
          Applies the variable element against the page.
 java.lang.String getComposite()
          Returns the composite type: "none", "list" or "map".
 boolean isEffective(Component comp)
          Used to evaluate whether it is effective.
 boolean isEffective(Page page)
          Used to evaluate whether it is effective.
 boolean isLocal()
          Returns if it is for local variable.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VariablesInfo

public VariablesInfo(EvaluatorRef evalr,
                     java.util.Map vars,
                     boolean local,
                     java.lang.String composite,
                     ConditionImpl cond)
Constructor.

Parameters:
evalr - the evaluator reference. It cannot be null. Retrieve it from LanguageDefinition.getEvaluatorRef() or PageDefinition.getEvaluatorRef(), depending which it belongs.
vars - a map of (String name, String value). Note: once called, the caller cannot access it any more. In other words, it becomes part of this object.
local - whether they are local variables.
composite - indicates the composite type. It can be one of "none", "list" or "map". If null or empty, "none" is assumed.
Throws:
java.lang.IllegalArgumentException - if evalr is null, or the composite type is illegal.
Since:
3.0.6

VariablesInfo

public VariablesInfo(EvaluatorRef evalr,
                     java.util.Map vars,
                     boolean local,
                     ConditionImpl cond)
The same as VariablesInfo(evalr, vars, locale, "none", cond).

Parameters:
evalr - the evaluator reference. It cannot be null. Retrieve it from LanguageDefinition.getEvaluatorRef() or PageDefinition.getEvaluatorRef(), depending which it belongs.
vars - a map of (String name, String value). Note: once called, the caller cannot access it any more. In other words, it becomes part of this object.
local - whether they are local variables.
Throws:
java.lang.IllegalArgumentException - if evalr is null
Method Detail

isLocal

public boolean isLocal()
Returns if it is for local variable.

Since:
3.0.6

getComposite

public java.lang.String getComposite()
Returns the composite type: "none", "list" or "map".

Since:
3.0.6

apply

public void apply(Component comp)
Applies the variable element against the parent component.

Parameters:
comp - the parent component (it cannot be null)

apply

public void apply(Page page)
Applies the variable element against the page. It is called if the element doesn't belong to any component.


isEffective

public boolean isEffective(Component comp)
Description copied from interface: Condition
Used to evaluate whether it is effective.

Specified by:
isEffective in interface Condition
Parameters:
comp - used as the self variable. Ignored if null.

isEffective

public boolean isEffective(Page page)
Description copied from interface: Condition
Used to evaluate whether it is effective.

Specified by:
isEffective in interface Condition
Parameters:
page - used as the self variable. Ignored if null.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo