Class Listener

Object
   |
   +--Listener

Direct Known Subclasses:

ModelBase

class Listener

Defined in Listener.js

Author: Cameron Shorter

Field Detail

listeners

Object listeners

An array [params] of (listener, target).

values

Object values

An array [params] of values. These values might not be used if the set/get functions are overwritten.

Listener

Listener()

Base Listener class that is instanciated by all objects which provide event listeners.

Author: Cameron Shorter

addFirstListener

void addFirstListener(param, listener, target)

Add a listener function at the start of the list.

Parameters:
param - Parameter name; if this parameter changes then an event is sent to all interested listeners.
listener - The function to call when the parameter changes.
target - The object which owns the listener function.

addListener

void addListener(param, listener, target)

Add a listener function which will be called when param is updated; The listener function should usually be: paint(target).

Parameters:
param - Parameter name; if this parameter changes then an event is sent to all interested listeners.
listener - The function to call when the parameter changes.
target - The object which owns the listener function.

callListeners

void callListeners(param,value)

Call all the listeners that have registered interest in this parameter using addListener.

Parameters:
param - The parameter that has changed.
value - The new parameter value.

getParam

Object getParam(param)

Return the param value, or return null if it does not exist. This function may be overloaded to store the param elsewhere (eg in an XML document).

Parameters:
param - The parameter to get.

Returns:
The value of the param.

removeListener

void removeListener(param,listener,target)

Remove a listener so that it is not called anymore when a param changes.

Parameters:
param - Parameter name; if this parameter changes then an event is sent to all interested listeners.
listener - The function to call when the parameter changes.
target - The object which owns the listener function.

setParam

void setParam(param,value)

Update parameter and call all interested listeners. This function may be overloaded to store the parameter in a elsewhere (eg in an XML document).

Parameters:
param - The parameter to change.