Package org.zkoss.zk.ui.metainfo

Class WidgetAttribute

java.lang.Object

org.zkoss.zk.ui.metainfo.WidgetAttribute

All Implemented Interfaces:

Serializable, Condition

public class WidgetAttribute
extends Object

Represents a DOM attribute of the peer widget.

Since:

5.0.3

Author:

tomyeh

See Also:

• WidgetListener
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	_name
protected final ExValue	_value

Constructor Summary

Constructors

Constructor	Description
WidgetAttribute(EvaluatorRef evalr, String name, String value, ConditionImpl cond)

Method Summary

Modifier and Type	Method	Description
void	assign(Component comp)
ConditionImpl	getCondition()	Returns the effectiveness condition.
EvaluatorRef	getEvaluatorRef()	Returns the evaluator reference.
String	getName()	Returns the event name, such as, onClick.
String	getRawValue()	Returns the value passed to the constructor.
String	getValue(Component comp)	Returns the value associated with this event handler.
boolean	isEffective(Component comp)	Used to evaluate whether it is effective.
boolean	isEffective(Page page)	Used to evaluate whether it is effective.
void	setCondition(ConditionImpl cond)	Sets the effectiveness condition.
boolean	withCondition()	Tests if the condition is set

Methods inherited from class java.lang.Object

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

Field Details

_name

protected final String _name

_value

protected final ExValue _value

Constructor Details

WidgetAttribute

public WidgetAttribute(EvaluatorRef evalr,
 String name,
 String value,
 ConditionImpl cond)

Parameters:

name - the event name, such as onClick

value - the value. EL is allowed and it will be coerced to String

Throws:

IllegalArgumentException - if value is null

Method Details

getName

public String getName()

Returns the event name, such as, onClick.

getValue

public String getValue(Component comp)

Returns the value associated with this event handler.

getRawValue

public String getRawValue()

Returns the value passed to the constructor. In other words, it might contains EL.

assign

public void assign(Component comp)

getEvaluatorRef

public EvaluatorRef getEvaluatorRef()

Returns the evaluator reference.

getCondition

public ConditionImpl getCondition()

Returns the effectiveness condition.

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.