diff -r 000000000000 -r 40c8f766c9b8 src/cm/media/js/lib/yui/yui_3.0.0b1/api/Subscriber.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/cm/media/js/lib/yui/yui_3.0.0b1/api/Subscriber.html Mon Nov 23 15:14:29 2009 +0100 @@ -0,0 +1,491 @@ + + + + + API: event-custom Subscriber (YUI Library) + + + + + + + + + + +
+
+

Yahoo! UI Library

+

event-custom  3.0.0b1

+ Yahoo! UI Library + > event-custom + > Subscriber + +
+
+ Search: +
+   +
+
+
+
+ +
+
+
+
+
+ Filters + + + +
+
+ +

+ + + + + Class Subscriber + + + +

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

Constructor

+
+
+ Subscriber + + ( + + + + fn + + , + context + + , + args* + ) + +
+
+
Parameters:
+
+ fn + <Function> + + The wrapped function to execute +
+
+ context + <Object> + + The value of the keyword 'this' in the listener +
+
+ args* + <Array> + + 0..n additional arguments to supply the listener +
+
+ + +
+
+
+
+ +
+
+

Properties

+
+
+

args + - Array +

+
+
+ Additional arguments to propagate to the subscriber +
+
+ + + + +
+
+
+

context + - Object +

+
+
+ Optional 'this' keyword for the listener +
+
+ + + + +
+
+
+

events + - {EventTarget} +

+
+
+ Custom events for a given fire transaction. +
+
+ + + + +
+
+
+

fn + - Function +

+
+
+ The callback that will be execute when the event fires +This is wrapped by Y.rbind if obj was supplied. +
+
+ + + + +
+
+
+

id + - String +

+
+
+ Unique subscriber id +
+
+ + + + +
+
+
+
+ +
+ +
+
+

Methods

+
+
+

+ contains

+
+ + + + + boolean + contains + ( + + + fn + + + , + context + + + ) + + +
+ Returns true if the fn and obj match this objects properties. +Used by the unsubscribe method to match the right subscriber. +
+ +
+ +
+
Parameters:
+
+ fn + <Function> + + the function to execute +
+
+ context + <Object> + + optional 'this' keyword for the listener +
+
+ +
+
Returns: + + boolean +
+
true if the supplied arguments match this +subscriber's signature.
+
+ + + + +
+ +
+
+
+
+

+ notify

+
+ + + + + void + notify + ( + + + args + + + , + ce + + + ) + + +
+ Executes the subscriber. +
+ +
+ +
+
Parameters:
+
+ args + <Array> + + Arguments array for the subscriber +
+
+ ce + <CustomEvent> + + The custom event that sent the notification +
+
+ +
+
Returns: + + void +
+
+
+ + + + +
+ +
+
+
+
+

+ toString

+
+ + + + + void + toString + ( + ) + + +
+ +
+ +
+ + +
+
Returns: + + void +
+
+
+ + + + +
+ +
+
+
+
+
+ +
+ +
+ + +
+ +
+ +
+ +
+
+
+
+ + + + + + + +
+

Properties

+ +
+ +
+

Methods

+ +
+ + + +
+
+
+
+
+ Copyright © 2009 Yahoo! Inc. All rights reserved. +
+
+ + +