Classes

Files

Class YAHOO.util.Subscriber

Object
   |
   +--YAHOO.util.Subscriber
class YAHOO.util.Subscriber
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

function fn
The callback that will be execute when the event fires 
object obj
An optional custom object that will passed to the callback when the event fires 
boolean override
The default execution scope for the event listener is defined when the event is created (usually the object which contains the event). 

Constructor Summary [top]

YAHOO.util.Subscriber
 

Method Summary [top]

boolean contains (<Function> fn, <Object> obj)
Returns true if the fn and obj match this objects properties. 

Field Detail [top]

fn

function   fn
The callback that will be execute when the event fires

obj

object   obj
An optional custom object that will passed to the callback when the event fires

override

boolean   override
The default execution scope for the event listener is defined when the event is created (usually the object which contains the event). By setting override to true, the execution scope becomes the custom object passed in by the subscriber

Constructor Detail [top]

YAHOO.util.Subscriber

YAHOO.util.Subscriber ()
Parameters:
fn - The function to execute
obj - An object to be passed along when the event fires
bOverride - If true, the obj passed in becomes the execution scope of the listener

Method Detail [top]

contains

boolean contains (<Function> fn, <Object> obj)
Returns true if the fn and obj match this objects properties. Used by the unsubscribe method to match the right subscriber.
Parameters:
fn - the function to execute
obj - an object to be passed along when the event fires
Returns:
true if the supplied arguments match this subscriber's signature.