Changeset 1546

Timestamp:

05/05/08 10:36:32 (6 days 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

Location:

trunk

Files:

• Compatibility/Request/Request.JSON.js (modified) (1 diff)
• Compatibility/Request/Request.js (modified) (1 diff)
• Demos/Fx.Slide/demo.js (modified) (2 diffs)
• Demos/Sortables/index.html (modified) (1 diff)
• Docs/Class/Class.Extras.md (modified) (13 diffs)
• Docs/Fx/Fx.md (modified) (3 diffs)
• Docs/Plugins/Accordion.md (modified) (2 diffs)
• Docs/Plugins/Drag.Move.md (modified) (1 diff)
• Docs/Plugins/Drag.md (modified) (2 diffs)
• Docs/Plugins/Group.md (modified) (2 diffs)
• Docs/Plugins/Scroller.md (modified) (1 diff)
• Docs/Plugins/Slider.md (modified) (4 diffs)
• Docs/Plugins/Sortables.md (modified) (1 diff)
• Docs/Plugins/Tips.md (modified) (5 diffs)
• Docs/Request/Request.HTML.md (modified) (1 diff)
• Docs/Request/Request.md (modified) (6 diffs)
• Docs/Utilities/Swiff.md (modified) (1 diff)
• Source/Class/Class.Extras.js (modified) (4 diffs)
• Source/Core/Core.js (modified) (3 diffs)
• Source/Fx/Fx.js (modified) (1 diff)
• Source/Plugins/Accordion.js (modified) (2 diffs)
• Source/Plugins/Drag.Move.js (modified) (3 diffs)
• Source/Plugins/Drag.js (modified) (5 diffs)
• Source/Plugins/Fx.Scroll.js (modified) (1 diff)
• Source/Plugins/Fx.Slide.js (modified) (1 diff)
• Source/Plugins/Scroller.js (modified) (2 diffs)
• Source/Plugins/Slider.js (modified) (4 diffs)
• Source/Plugins/SmoothScroll.js (modified) (1 diff)
• Source/Plugins/Sortables.js (modified) (3 diffs)
• Source/Plugins/Tips.js (modified) (1 diff)
• Source/Request/Request.js (modified) (4 diffs)
• Specs/Class/Class.Extras.js (modified) (7 diffs)

trunk/Compatibility/Request/Request.JSON.js

@@ -19 +19 @@
         
         failure: function(){
-                this.fireEvent('onFailure', this.xhr);
+                this.fireEvent('failure', this.xhr);
         }
 

trunk/Compatibility/Request/Request.js

@@ -30 +30 @@
         
         failure: function(){
-                this.fireEvent('onFailure', this.xhr);
+                this.fireEvent('failure', this.xhr);
         }
 

trunk/Demos/Fx.Slide/demo.js

@@ -37 +37 @@
         
         // When Vertical Slide ends its transition, we check for its status
-        // note that onComplete will not affect 'hide' and 'show' methods
-        myVerticalSlide.addEvent('onComplete', function() {
+        // note that complete will not affect 'hide' and 'show' methods
+        myVerticalSlide.addEvent('complete', function() {
                 $('vertical_status').set('html', status[myVerticalSlide.open]);
         });
@@ -74 +74 @@
         
         // When Horizontal Slide ends its transition, we check for its status
-        // note that onComplete will not affect 'hide' and 'show' methods
-        myHorizontalSlide.addEvent('onComplete', function() {
+        // note that complete will not affect 'hide' and 'show' methods
+        myHorizontalSlide.addEvent('complete', function() {
                 $('horizontal_status').set('html', status[myHorizontalSlide.open]);
         });

trunk/Demos/Sortables/index.html

@@ -25 +25 @@
                 The advanced example shows, that it is even possible to drag&drop list-elements
                 into another list.
-        <p/>
+        </p>
         <div id="anotherSortablesDemo">
         

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:

trunk/Docs/Fx/Fx.md

@@ -40 +40 @@
 ### Events:
 
-* onStart               - (*function*) The function to execute when the effect begins.
-* onCancel              - (*function*) The function to execute when you manually stop the effect.
-* onComplete            - (*function*) The function to execute after the effect has processed.
-* onChainComplete       - (*function*) The function to execute when using link 'chain' ([see options](#Fx:constructor)). It gets called after all effects in the chain have completed.
+* start                 - (*function*) The function to execute when the effect begins.
+* cancel                - (*function*) The function to execute when you manually stop the effect.
+* complete              - (*function*) The function to execute after the effect has processed.
+* chainComplete - (*function*) The function to execute when using link 'chain' ([see options](#Fx:constructor)). It gets called after all effects in the chain have completed.
 
 ### Notes:
@@ -59 +59 @@
 ----------------------------
 
-The start method is used to begin a transition.  Fires the onStart event.
+The start method is used to begin a transition.  Fires the 'start' event.
 
 ### Syntax:
@@ -111 +111 @@
 ------------------------------
 
-The cancel method is used to cancel a running transition.  Fires the onCancel event.
+The cancel method is used to cancel a running transition.  Fires the 'cancel' event.
 
 ### Syntax:

trunk/Docs/Plugins/Accordion.md

@@ -41 +41 @@
 ## Events:
 
-### onActive
+### active
 
 * (*function*) Function to execute when an element starts to show.
@@ -54 +54 @@
 2. element - (*element*) The Element being displayed.
 
-### onBackground
+### background
 
 * (*function*) Function to execute when an element starts to hide.

trunk/Docs/Plugins/Drag.Move.md

@@ -35 +35 @@
 ### Events:
 
-* onDrop - Executed when the element drops. Passes as argument the element and the element dropped on. If dropped on nothing, the second argument is null.
-* onLeave - Executed when the element leaves one of the droppables.
-* onEnter - Executed when the element enters one of the droppables.
+* drop - Executed when the element drops. Passes as argument the element and the element dropped on. If dropped on nothing, the second argument is null.
+* leave - Executed when the element leaves one of the droppables.
+* enter - Executed when the element enters one of the droppables.
 
 ### Example:

trunk/Docs/Plugins/Drag.md

@@ -34 +34 @@
 ### Events:
 
-* onBeforeStart - Executed before the Drag instance attaches the events. Receives the dragged element as an argument.
-* onStart       - Executed when the user starts to drag (on mousedown). Receives the dragged element as an argument.
-* onSnap        - Executed when the user has dragged past the snap option. Receives the dragged element as an argument.
-* onDrag        - Executed on every step of the drag. Receives the dragged element as an argument.
-* onComplete    - Executed when the user completes the drag. Receives the dragged element as an argument.
+* beforeStart - Executed before the Drag instance attaches the events. Receives the dragged element as an argument.
+* start       - Executed when the user starts to drag (on mousedown). Receives the dragged element as an argument.
+* snap        - Executed when the user has dragged past the snap option. Receives the dragged element as an argument.
+* drag        - Executed on every step of the drag. Receives the dragged element as an argument.
+* complete    - Executed when the user completes the drag. Receives the dragged element as an argument.
 
 ### Examples:
@@ -126 +126 @@
 ------------------------------
 
-Stops (removes) all attached events from the Drag instance and executes the onComplete Event.
+Stops (removes) all attached events from the Drag instance and executes the 'complete' Event.
 
 ### Syntax:

trunk/Docs/Plugins/Group.md

@@ -23 +23 @@
 
         var group = new Group(xhr1, xhr2, xhr3);
-        group.addEvent('onComplete', function(){
+        group.addEvent('complete', function(){
                 alert('All Scripts loaded');
         });
@@ -44 +44 @@
 ###     Arguments:
 
-1. type - (*string*) The event name (e.g. 'onComplete') to add.
+1. type - (*string*) The event name (e.g. 'complete') to add.
 2. fn   - (*function*) The callback function to execute when all instances fired this event.
 

trunk/Docs/Plugins/Scroller.md

@@ -30 +30 @@
 ### Events:
 
-* onChange - (*function*) When the mouse reaches some boundaries, you can choose to alter some other values, instead of the scrolling offsets.
+* change - (*function*) When the mouse reaches some boundaries, you can choose to alter some other values, instead of the scrolling offsets.
 
 #### Signature:

trunk/Docs/Plugins/Slider.md

@@ -33 +33 @@
 
 
-Slider Event: onChange {#Slider:onChange}
+Slider Event: change {#Slider:change}
 -----------------------------------------
 
@@ -48 +48 @@
 
 
-Slider Event: onComplete {#Slider:onComplete}
+Slider Event: onComplete {#Slider:complete}
 ---------------------------------------------
 
@@ -63 +63 @@
 
 
-Slider Event: onTick {#Slider:onTick}
+Slider Event: tick {#Slider:tick}
 -------------------------------------
 
-* (*function*) Fires when the user drags the knob. This Event can be overriden to alter the onTick behavior.
+* (*function*) Fires when the user drags the knob. This Event can be overriden to alter the tick behavior.
 
 ### Signature:
@@ -78 +78 @@
 ### Notes:
 
-- Slider originally uses the onTick event to set the style of the knob to a new position.
+- Slider originally uses the 'tick' event to set the style of the knob to a new position.
 
 ### Returns:

trunk/Docs/Plugins/Sortables.md

@@ -22 +22 @@
 ### Events:
 
-* onStart    - function executed when the item starts dragging
-* onSort     - function executed when the item is inserted into a new place in one of the lists
-* onComplete - function executed when the item ends dragging
+* start    - function executed when the item starts dragging
+* sort     - function executed when the item is inserted into a new place in one of the lists
+* complete - function executed when the item ends dragging
 
 ### Examples:

trunk/Docs/Plugins/Tips.md

@@ -26 +26 @@
 ### Options:
 
-* showDelay     - (*number*: defaults to 100) The delay the onShow method is called.
-* hideDelay     - (*number*: defaults to 100) The delay the onHide method is called.
+* showDelay     - (*number*: defaults to 100) The delay the show event is fired.
+* hideDelay     - (*number*: defaults to 100) The delay the hide hide is fired.
 * className     - (*string*: defaults to null) the className your tooltip container will get. Useful for extreme styling.
  * The tooltip element inside the tooltip container above will have 'tip' as classname.
@@ -38 +38 @@
 ### Events:
  
- * onHide: fires when the tip is shown
- * onShow: fires when the tip is being hidden
+ * hide: fires when the tip is shown
+ * show: fires when the tip is being hidden
 
 ### Example:
@@ -52 +52 @@
         
 
-Tips Event: onShow {#Tips:onShow}
+Tips Event: show {#Tips:show}
 ---------------------------------
 
@@ -67 +67 @@
 ### Example:
 
-        myTips.addEvent('onShow', function(tip){
+        myTips.addEvent('show', function(tip){
                 tip.fade('in');
         });
 
-Tips Event: onHide {#Tips:onHide}
+Tips Event: hide {#Tips:hide}
 ---------------------------------
 
@@ -86 +86 @@
 ### Example:
 
-        myTips.addEvent('onHide', function(tip){
+        myTips.addEvent('hide', function(tip){
                 tip.fade('out');
         });

trunk/Docs/Request/Request.HTML.md

@@ -26 +26 @@
 ### Events:
 
-#### onComplete
+#### complete
 
 * (*function*) Function to execute when the HTML request completes.

trunk/Docs/Request/Request.md

@@ -30 +30 @@
 ----------------------------------------
 
-### onRequest
+### request
 
 (*function*) Function to execute when the Request is sent.
@@ -42 +42 @@
 1. instance - (Request) The transport instance.
 
-### onSuccess
+### success
 
 (*function*) Function to execute when the Request completes.
@@ -55 +55 @@
 2. responseXML  - (*mixed*) The response XML from the request.
 
-### onFailure
+### failure
 
 (*function*) Function to execute when the request fails (error status code).
@@ -67 +67 @@
 instance - (Request) The transport instance.
 
-### onException
+### exception
 
 (*function*) Function to execute when setting a request header fails.
@@ -80 +80 @@
 2. value      - (*string*) The value of the failing header.
 
-###     onCancel
+###     cancel
 
 (*function*) Function to execute when a request has been cancelled.
@@ -91 +91 @@
 
 * running  - (*boolean*) True if the request is running.
-* response - (*object*) Object with text and XML as keys. You can access this property in the onSuccess event.
+* response - (*object*) Object with text and XML as keys. You can access this property in the 'success' event.
 
 ### Returns:

trunk/Docs/Utilities/Swiff.md

@@ -51 +51 @@
                 },
                 events: {
-                        onLoad: myOnloadFunc
+                        load: myOnloadFunc
                 }
         });

trunk/Source/Class/Class.Extras.js

@@ -28 +28 @@
 
         addEvent: function(type, fn, internal){
+                type = Events.removeOn(type);
                 if (fn != $empty){
                         this.$events = this.$events || {};
@@ -43 +44 @@
 
         fireEvent: function(type, args, delay){
+                type = Events.removeOn(type);
                 if (!this.$events || !this.$events[type]) return this;
                 this.$events[type].each(function(fn){
@@ -51 +53 @@
 
         removeEvent: function(type, fn){
+                type = Events.removeOn(type);
                 if (!this.$events || !this.$events[type]) return this;
                 if (!fn.internal) this.$events[type].erase(fn);
@@ -67 +70 @@
 });
 
+Events.removeOn = function(string){
+        return string.replace(/^on([A-Z])/, function(full, first) {
+                return first.toLowerCase();
+        });
+};
+
 var Options = new Class({
 

trunk/Source/Core/Core.js

@@ -94 +94 @@
 
 (function(objects){
-        for (var name in objects) Native.typize(objects[name], name.toLowerCase());
-})({'Boolean': Boolean, 'Native': Native, 'Object': Object});
+        for (var name in objects) Native.typize(objects[name], name);
+})({'boolean': Boolean, 'native': Native, 'object': Object});
 
 (function(objects){
@@ -102 +102 @@
 
 (function(object, methods){
-        for (var i = 0, l = methods.length; i < l; i++) Native.genericize(object, methods[i], true);
+        for (var i = methods.length; i--; i) Native.genericize(object, methods[i], true);
         return arguments.callee;
 })
@@ -142 +142 @@
 
 function $unlink(object){
-        var unlinked = null;
+        var unlinked;
         
         switch ($type(object)){

trunk/Source/Fx/Fx.js

@@ -83 +83 @@
 
         onStart: function(){
-                this.fireEvent('onStart', this.subject);
+                this.fireEvent('start', this.subject);
         },
 
         onComplete: function(){
-                this.fireEvent('onComplete', this.subject);
-                if (!this.callChain()) this.fireEvent('onChainComplete', this.subject);
+                this.fireEvent('complete', this.subject);
+                if (!this.callChain()) this.fireEvent('chainComplete', this.subject);
         },
 
         onCancel: function(){
-                this.fireEvent('onCancel', this.subject).clearChain();
+                this.fireEvent('cancel', this.subject).clearChain();