diff -r 322d0feea350 -r 89ef5ed3c48b src/cm/media/js/lib/yui/yui_3.10.3/api/classes/Do.Halt.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/cm/media/js/lib/yui/yui_3.10.3/api/classes/Do.Halt.html Tue Jul 16 14:29:46 2013 +0200 @@ -0,0 +1,1723 @@ + + + + + Do.Halt - YUI 3 + + + + + + + + +
+
+
+ +

+ +
+
+ API Docs for: 3.10.3 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ + +
+
+
+

Do.Halt Class

+
+ + + + + + + + + + + Module: event-custom-base
+ Parent Module: event-custom + + + + +
+ + + +
+

Return a Halt object when you want to terminate the execution +of all subsequent subscribers as well as the wrapped method +if it has not exectued yet. Useful for Do.before subscribers.

+
+ + +
+

Constructor

+
+

Do.Halt

+ + +
+ (
    + +
  • + + msg + +
  • + +
  • + + retVal + +
  • + +
) +
+ + + + + + + + + + + + + + + + +
+ + + +

+ + Defined in + + + + + event-custom/js/event-do.js:337 + +

+ + + + + +
+ +
+ +
+ + +
+

Parameters:

+ +
    + +
  • + + msg + String + + + + +
    +

    (optional) Explanation of why the termination was done

    +
    + + +
  • + +
  • + + retVal + Any + + + + +
    +

    Return value passed to code that invoked the wrapped + function.

    +
    + + +
  • + +
+
+ + + + + +
+ +
+ + +
+ + +
+
+

Item Index

+ + + + + + + + +
+ + + + + + + + +
+
+ +
+
+
+
+
+
+ + + + + + + + + +