Changeset 1546 for trunk/Docs/Class/Class.Extras.md

Timestamp:

05/05/08 10:36:32 (1 week ago)

Author:

JanK

Message:

• Class events should now be used without their on prefix, i.e. addEvent('onChainComplete', fn) becomes addEvent('chainComplete'). If you want to add events in the options you need to prefix them with 'on' now ('foo' -> 'onFoo').
  

Note: This is not a breaking change.

- other minor optimizations and doc fixes

Files:

• trunk/Docs/Class/Class.Extras.md (modified) (13 diffs)

trunk/Docs/Class/Class.Extras.md

@@ -140 +140 @@
 
 A Utility Class. Its methods can be implemented with [Class:implement][] into any [Class][].
-In [Fx][], for example, this Class is used to allow any number of functions to be added to the Fx events, like onComplete, onStart, and onCancel.
+In [Fx][], for example, this Class is used to allow any number of functions to be added to the Fx events, like 'complete', 'start', and 'cancel'.
 Events in a Class that implements [Events](#Events) must be either added as an option or with addEvent, not directly through .options.onEventName.
 
@@ -156 +156 @@
 
 - This class can be implemented into other classes to add its functionality to them.
-- Events has been designed to work well with the [Options](#Options) class when the option property begins with 'on' and is followed by a capital letter (e.g. 'onComplete').
+- Events has been designed to work well with the [Options](#Options) class when the option property begins with 'on' and is followed by a capital letter it will be added as an event (e.g. 'onComplete' will add as 'complete' event).
 
 ### Example:
@@ -163 +163 @@
                 Implements: Events,
                 initialize: function(element){
-                        ...
+                        // ...
                 },
                 complete: function(){
-                        this.fireEvent('onComplete');
+                        this.fireEvent('complete');
                 }
         });
 
         var myWidget = new Widget();
-        myWidget.addEvent('onComplete', myFunction);
+        myWidget.addEvent('complete', myFunction);
+
+### Notes:
+
+- Events starting with 'on' are still supported in all methods and are converted to their representation without 'on' (e.g. 'onComplete' becomes 'complete').
 
 
@@ -191 +195 @@
 ### Arguments:
 
-1. type     - (*string*) The type of event (e.g. 'onComplete').
+1. type     - (*string*) The type of event (e.g. 'complete').
 2. fn       - (*function*) The function to execute.
 3. internal - (*boolean*, optional) Sets the function property: internal to true. Internal property is used to prevent removal.
@@ -202 +206 @@
 
         var myFx = new Fx.Tween('element', 'opacity');
-        myFx.addEvent('onStart', myStartFunction);
-
+        myFx.addEvent('start', myStartFunction);
 
 
@@ -217 +220 @@
 ### Arguments:
 
-1. events - (*object*) An object with key/value representing: key the event name (e.g. 'onStart'), and value the function that is called when the Event occurs.
+1. events - (*object*) An object with key/value representing: key the event name (e.g. 'start'), and value the function that is called when the Event occurs.
 
 ### Returns:
@@ -227 +230 @@
         var myFx = new Fx.Tween('element', 'opacity');
         myFx.addEvents({
-                'onStart': myStartFunction,
-                'onComplete': function() {
+                'start': myStartFunction,
+                'complete': function() {
                         alert('Done.');
                 }
@@ -246 +249 @@
 ### Arguments:
 
-1. type  - (*string*) The type of event (e.g. 'onComplete').
+1. type  - (*string*) The type of event (e.g. 'complete').
 2. args  - (*mixed*, optional) The argument(s) to pass to the function. To pass more than one argument, the arguments must be in an array.
 3. delay - (*number*, optional) Delay in miliseconds to wait before executing the event (defaults to 0).
@@ -260 +263 @@
                 initialize: function(arg1, arg2){
                         //...
-                        this.fireEvent("onInitialize", [arg1, arg2], 50);
+                        this.fireEvent("initialize", [arg1, arg2], 50);
                 }
         });
@@ -277 +280 @@
 ### Arguments:
 
-1. type - (*string*) The type of event (e.g. 'onComplete').
+1. type - (*string*) The type of event (e.g. 'complete').
 2. fn   - (*function*) The function to remove.
 
@@ -300 +303 @@
 ### Arguments:
 
-1. type - (*string*, optional) The type of event to remove (e.g. 'onComplete'). If no type is specified, removes all events of all types.
+1. type - (*string*, optional) The type of event to remove (e.g. 'complete'). If no type is specified, removes all events of all types.
 
 ### Returns:
@@ -309 +312 @@
 
         var myFx = new Fx.Tween('myElement', 'opacity');
-        myFx.removeEvents('onComplete');
+        myFx.removeEvents('complete');
 
 
@@ -323 +326 @@
 A Utility Class. Its methods can be implemented with [Class:implement][] into any [Class][].
 Used to automate the setting of a Class instance's options.
-Will also add Class [Events](#Events) when the option property begins with 'on' and is followed by a capital letter (e.g. 'onComplete').
+Will also add Class [Events](#Events) when the option property begins with 'on' and is followed by a capital letter (e.g. 'onComplete' adds a 'complete' event).
 
 ### Syntax: