org.zkoss.zk.ui.metainfo
Class VariablesInfo

java.lang.Object
  org.zkoss.zk.ui.metainfo.VariablesInfo

All Implemented Interfaces:

java.io.Serializable, NodeInfo, Condition

public class VariablesInfo
extends java.lang.Object

The information about the variables element in the ZUML page.

Author:

tomyeh

See Also:

Serialized Form

Constructor Summary

VariablesInfo(NodeInfo parent, java.util.Map<java.lang.String,java.lang.String> vars, boolean local, ConditionImpl cond)
The same as VariablesInfo(parent, vars, locale, "none", cond).

VariablesInfo(NodeInfo parent, java.util.Map<java.lang.String,java.lang.String> vars, boolean local, java.lang.String composite, ConditionImpl cond)
Constructor.

Method Summary

void	appendChild(NodeInfo child) Append a child
void	apply(Component comp) Applies the variable element against the parent component.
void	apply(Page page) Applies the variable element against the page.
java.util.List<NodeInfo>	getChildren() Returns a readonly list of children.
java.lang.String	getComposite() Returns the composite type: "none", "list" or "map".
Evaluator	getEvaluator() Returns the evaluator.
EvaluatorRef	getEvaluatorRef() Returns the evaluator reference.
PageDefinition	getPageDefinition() Returns the page definition, i.e., the root node, or null if not available.
NodeInfo	getParent() Returns the parent, or null if it has no parent.
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.
boolean	removeChild(NodeInfo child) Removes a child.
void	setCondition(ConditionImpl cond) Sets the effectiveness condition.
java.lang.String	toString()
boolean	withCondition() Tests if the condition is set

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablesInfo

public VariablesInfo(NodeInfo parent,
                     java.util.Map<java.lang.String,java.lang.String> vars,
                     boolean local,
                     java.lang.String composite,
                     ConditionImpl cond)

Constructor.

Parameters:

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 the composite type is illegal.

Since:

3.0.6

VariablesInfo

public VariablesInfo(NodeInfo parent,
                     java.util.Map<java.lang.String,java.lang.String> vars,
                     boolean local,
                     ConditionImpl cond)

The same as VariablesInfo(parent, vars, locale, "none", cond).

Parameters:

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.

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setCondition

public void setCondition(ConditionImpl cond)

Sets the effectiveness condition.

withCondition

public boolean withCondition()

Tests if the condition is set

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.

getEvaluatorRef

public EvaluatorRef getEvaluatorRef()

Description copied from interface: NodeInfo

Returns the evaluator reference.

Specified by:

getEvaluatorRef in interface NodeInfo

getPageDefinition

public PageDefinition getPageDefinition()

Description copied from interface: NodeInfo

Returns the page definition, i.e., the root node, or null if not available.

Specified by:

getPageDefinition in interface NodeInfo

getEvaluator

public Evaluator getEvaluator()

Description copied from interface: NodeInfo

Returns the evaluator.

All nodes in the same ZUML tree has the same evaluator reference (inherited from the root node, PageDefinition.getEvaluatorRef()).

Specified by:

getEvaluator in interface NodeInfo

getParent

public NodeInfo getParent()

Description copied from interface: NodeInfo

Returns the parent, or null if it has no parent.

Specified by:

getParent in interface NodeInfo

getChildren

public java.util.List<NodeInfo> getChildren()

Description copied from interface: NodeInfo

Returns a readonly list of children.

Note: the returned list is readonly. To modify, please use NodeInfo.appendChild(org.zkoss.zk.ui.metainfo.NodeInfo) and NodeInfo.removeChild(org.zkoss.zk.ui.metainfo.NodeInfo) instead.

Specified by:

getChildren in interface NodeInfo

appendChild

public void appendChild(NodeInfo child)

Description copied from interface: NodeInfo

Append a child

Specified by:

appendChild in interface NodeInfo

removeChild

public boolean removeChild(NodeInfo child)

Description copied from interface: NodeInfo

Removes a child.

Specified by:

removeChild in interface NodeInfo