YAHOO.util.Subscriber

Subscriber

Object
   |
   +--YAHOO.util.Subscriber

Ubicada en yahoo.js

Métodos

boolean	contains(<Function> fn, <Object> obj)	Returns true if the fn and obj match this objects properties.
Object	getScope(<Object> defaultScope)	Returns the execution context for this listener.
Object	toString()

YAHOO.util.Subscriber

YAHOO.util.Subscriber (<Function> fn, <Object> obj, <boolean> overrideContext)

Stores the subscriber information to be used when the event fires.

Parámetros:

fn	The function to execute
obj	An object to be passed along when the event fires
overrideContext	If true, the obj passed in becomes the execution context of the listener

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.

Parámetros:

fn	the function to execute
obj	an object to be passed along when the event fires

Retorna:

true if the supplied arguments match this subscriber's signature.

getScope

Object getScope (<Object> defaultScope)

Returns the execution context for this listener. If overrideContext was set to true the custom obj will be the context. If overrideContext is an object, that is the context, otherwise the default context will be used.

Parámetros:

defaultScope

the context to use if this listener does not override it.

toString

Object toString ()

Propiedades

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|object overrideContext

The default execution context for the event listener is defined when the event is created (usually the object which contains the event). By setting overrideContext to true, the execution context becomes the custom object passed in by the subscriber. If overrideContext is an object, that object becomes the context.

Desarrollado por SIU.
Documentación generada con JSDoc