Class YAHOO.ext.util.Observable
Package: | YAHOO.ext.util |
Class: | Observable |
Extends: | Object |
Subclasses: | BasicDialog, ContentPanel, LayoutManager, LayoutRegion, Resizable, SplitBar, TabPanel, TabPanelItem, UpdateManager, View, AbstractColumnModel, DefaultSelectionModel, Grid |
Defined In: | yutil.js |
Abstract base class that provides a common interface for publishing events. Subclasses are expected to
to have a property "events" with all the events defined.
For example:
var Employee = function(name){
this.name = name;
this.events = {
'fired' : new YAHOO.util.CustomEvent('fired'),
'quit' : new YAHOO.util.CustomEvent('quit')
}
}
YAHOO.extend(Employee, YAHOO.ext.util.Observable);
Public Properties
This class has no public properties.
Public Methods
|
addListener(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable |
Appends an event handler to this element |
|
delayedListener(String eventName , Function handler , [Object scope ], [Number delay ]) : Function |
Observable |
Appends an event handler to this element that is delayed the specified number of milliseconds. |
|
fireEvent(String eventName , Object... args ) : void |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener |
Public Events
This class has no public events.
Method Details
addListener
public function addListener(String eventName
, Function handler
, [Object scope
], [boolean override
])
Appends an event handler to this element
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope (this object) for the handler
override
: boolean(optional) If true, scope becomes the scope
Returns:
This method is defined by Observable.
delayedListener
public function delayedListener(String eventName
, Function handler
, [Object scope
], [Number delay
])
Appends an event handler to this element that is delayed the specified number of milliseconds.
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope (this object) for the handler
delay
: Number(optional) The number of milliseconds to delay
Returns:
This method is defined by Observable.
fireEvent
public function fireEvent(String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
This method is defined by Observable.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
This method is defined by Observable.
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
This method is defined by Observable.