Package org.zkoss.zk.ui.metainfo

Class WidgetListener

java.lang.Object

org.zkoss.zk.ui.metainfo.WidgetListener

All Implemented Interfaces:

Serializable, Condition

Direct Known Subclasses:

WidgetOverride

public class WidgetListener
extends Object

Represents a client-side event listener for the peer widget. Notice that, unlike WidgetOverride, getScript(org.zkoss.zk.ui.Component) has only the function's body (without function (event)).

Since:

5.0.0

Author:

tomyeh

See Also:

• EventHandler
• WidgetOverride
• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
WidgetListener(EvaluatorRef evalr, String name, String script, 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	getRawScript()	Returns the script passed to the constructor.
String	getScript(Component comp)	Returns the script 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

_script

protected final ExValue _script

Constructor Details

WidgetListener

public WidgetListener(EvaluatorRef evalr,
 String name,
 String script,
 ConditionImpl cond)

Parameters:

name - the event name, such as onClick

script - the script snippet. EL is allowed.

Throws:

IllegalArgumentException - if name or script is null

Method Details

getName

public String getName()

Returns the event name, such as, onClick.

getScript

public String getScript(Component comp)

Returns the script associated with this event handler.

Since:

5.0.2

getRawScript

public String getRawScript()

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

Since:

5.0.2

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.