Package org.zkoss.zk.ui.metainfo

Class AttributesInfo

java.lang.Object

org.zkoss.zk.ui.metainfo.AttributesInfo

All Implemented Interfaces:

Serializable, NodeInfo, Condition

public class AttributesInfo
extends Object

Represents a map of custom attributes of a component definition (ComponentDefinition). It is equivalent to the custom-attributes element.

Note: it is serializable.

Author:

tomyeh

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AttributesInfo(NodeInfo parent, Map<String,String> attrs, String scope, String composite, ConditionImpl cond)	Constructor.
AttributesInfo(NodeInfo parent, Map<String,String> attrs, String scope, ConditionImpl cond)	The same as AttributesInfo(parent, attrs, scope, "none", cond).

Method Summary

Modifier and Type	Method	Description
void	appendChild(NodeInfo child)	Append a child
void	apply(Component comp)	Applies the custom attributes.
void	apply(Page page)	Applies the custom attributes.
Map<String,Object>	getAttrs()	Returns the internal attributes if any.
List<NodeInfo>	getChildren()	Returns a readonly list of children.
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.
String	getScope()	Returns the scope, or null if it is not associated with a scope.
boolean	isEffective(Component comp)	Used to evaluate whether it is effective.
boolean	isEffective(Page page)	Used to evaluate whether it is effective.
boolean	removeChild(NodeInfo child)	Removes a child.
void	setCondition(ConditionImpl cond)	Sets the effectiveness condition.
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 Details

AttributesInfo

public AttributesInfo(NodeInfo parent,
 Map<String,String> attrs,
 String scope,
 String composite,
 ConditionImpl cond)

Constructor.

Parameters:

attrs - the custom attributes (String name, String value). Once called, the caller shall not access attrs again -- it belongs to this object.

scope - specifies the scope.

composite - indicates the composite type. It can be one of "none", "list" or "map". If null or empty, "none" is assumed.

Throws:

IllegalArgumentException - if the composite type is illegal.

Since:

3.0.6

AttributesInfo

public AttributesInfo(NodeInfo parent,
 Map<String,String> attrs,
 String scope,
 ConditionImpl cond)

The same as AttributesInfo(parent, attrs, scope, "none", cond).

Parameters:

attrs - the custom attributes (String name, String value). Once called, the caller shall not access attrs again -- it belongs to this object.

scope - specifies the scope.

Method Details

getScope

public String getScope()

Returns the scope, or null if it is not associated with a scope.

Notice that, prior to 5.0.8, "component" is returned if it is not associated with a scope (which is not correct since this info might be associated with a page).

Since:

3.0.6

getComposite

public String getComposite()

Returns the composite type: "none", "list" or "map".

Since:

3.0.6

apply

public void apply(Component comp)

Applies the custom attributes.

Note: this method does nothing if Condition.isEffective(org.zkoss.zk.ui.Component) returns false.

apply

public void apply(Page page)

Applies the custom attributes.

Note: this method does nothing if Condition.isEffective(org.zkoss.zk.ui.Component) returns false.

getAttrs

public Map<String,Object> getAttrs()

Returns the internal attributes if any.

Since:

10.0.0

toString

public String toString()

Overrides:

toString in class 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 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