sproutcore 1.9.2 → 1.10.0.rc.1

data/lib/frameworks/sproutcore/frameworks/core_foundation/core.js

@@ -8,16 +8,16 @@
 /**
   Indicates that the collection view expects to accept a drop ON the specified
   item.
-  
-  @property {Number}
+
+  @type Number
 */
 SC.DROP_ON = 0x01 ;
 
 /**
-  Indicates that the collection view expects to accept a drop BEFORE the 
+  Indicates that the collection view expects to accept a drop BEFORE the
   specified item.
-  
-  @property {Number}
+
+  @type Number
 */
 SC.DROP_BEFORE = 0x02 ;
 
@@ -25,16 +25,16 @@ SC.DROP_BEFORE = 0x02 ;
   Indicates that the collection view expects to accept a drop AFTER the
   specified item.  This is treated just like SC.DROP_BEFORE is most views
   except for tree lists.
-  
-  @property {Number}
+
+  @type Number
 */
 SC.DROP_AFTER = 0x04 ;
 
 /**
-  Indicates that the collection view want's to know which operations would 
+  Indicates that the collection view want's to know which operations would
   be allowed for either drop operation.
-  
-  @property {Number}
+
+  @type Number
 */
 SC.DROP_ANY = 0x07 ;
 
@@ -90,34 +90,34 @@ SC.ALIGN_BOTTOM_RIGHT = 'bottom-right';
 
 
 SC.mixin(/** @lends SC */ {
-  
+
   /**
     Reads or writes data from a global cache.  You can use this facility to
     store information about an object without actually adding properties to
     the object itself.  This is needed especially when working with DOM,
     which can leak easily in IE.
-    
+
     To read data, simply pass in the reference element (used as a key) and
     the name of the value to read.  To write, also include the data.
-    
+
     You can also just pass an object to retrieve the entire cache.
-    
+
     @param elem {Object} An object or Element to use as scope
     @param name {String} Optional name of the value to read/write
     @param data {Object} Optional data.  If passed, write.
     @returns {Object} the value of the named data
   */
   data: $.data,
-  
+
   /**
     Removes data from the global cache.  This is used throughout the
     framework to hold data without creating memory leaks.
-    
-    You can remove either a single item on the cache or all of the cached 
+
+    You can remove either a single item on the cache or all of the cached
     data for an object.
-    
+
     @param elem {Object} An object or Element to use as scope
-    @param name {String} optional name to remove. 
+    @param name {String} optional name to remove.
     @returns {Object} the value or cache that was removed
   */
   removeData: $.removeData,

data/lib/frameworks/sproutcore/frameworks/core_foundation/ext/run_loop.js

@@ -16,7 +16,7 @@ SC.RunLoop = SC.RunLoop.extend(
     All timers scheduled during this run loop will begin executing as if
     they were scheduled at this time.
 
-    @property {Number}
+    @type Number
   */
   startTime: function() {
     if (!this._start) { this._start = Date.now(); }
@@ -122,39 +122,24 @@ SC.RunLoop = SC.RunLoop.extend(
     @returns {Boolean} YES if a timeout was scheduled
   */
   scheduleNextTimeout: function() {
-    var timer = this._timerQueue ;
+    var ret = NO,
+      timer = this._timerQueue;
 
-    var ret = NO ;
-    // if no timer, and there is an existing timeout, cancel it
+    // if no timer, and there is an existing timeout, attempt to cancel it.
+    // NOTE: if this happens to be an invokeNext based timer, it will not be
+    // cancelled.
     if (!timer) {
-      if (this._timeout) { clearTimeout(this._timeout); }
+      if (this._timerTimeout) { this.unscheduleRunLoop(); }
+      this._timerTimeout = null;
 
     // otherwise, determine if the timeout needs to be rescheduled.
     } else {
       var nextTimeoutAt = timer._timerQueueRunTime ;
-      if (this._timeoutAt !== nextTimeoutAt) { // need to reschedule
-        if (this._timeout) { clearTimeout(this._timeout); } // clear existing...
-        // reschedule
-        var delay = Math.max(0, nextTimeoutAt - Date.now());
-        this._timeout = setTimeout(this._timeoutDidFire, delay);
-        this._timeoutAt = nextTimeoutAt ;
-      }
-      ret = YES ;
+      this._timerTimeout = this.scheduleRunLoop(nextTimeoutAt);
+      ret = YES;
     }
 
     return ret ;
-  },
-
-  /** @private
-    Invoked when a timeout actually fires.  Simply cleanup, then begin and end
-    a runloop. This will fire any expired timers and reschedule.  Note that
-    this function will be called with 'this' set to the global context,
-    hence the need to lookup the current run loop.
-  */
-  _timeoutDidFire: function() {
-    var rl = SC.RunLoop.currentRunLoop;
-    rl._timeout = rl._timeoutAt = null ; // cleanup
-    SC.run();  // begin/end runloop to trigger timers.
   }
 
 });

data/lib/frameworks/sproutcore/frameworks/core_foundation/mixins/selection_support.js

@@ -35,28 +35,28 @@ SC.SelectionSupport = {
   /**
     Walk like a duck.
 
-    @property {Boolean}
+    @type Boolean
   */
   hasSelectionSupport: YES,
 
   /**
     If YES, selection is allowed. Default is YES.
 
-    @property {Boolean}
+    @type Boolean
   */
   allowsSelection: YES,
 
   /**
     If YES, multiple selection is allowed. Default is YES.
 
-    @property {Boolean}
+    @type Boolean
   */
   allowsMultipleSelection: YES,
 
   /**
     If YES, allow empty selection Default is YES.
 
-    @property {Boolean}
+    @type Boolean
   */
   allowsEmptySelection: YES,
 
@@ -138,7 +138,7 @@ SC.SelectionSupport = {
   /**
     YES if the receiver currently has a non-zero selection.
 
-    @property {Boolean}
+    @type Boolean
   */
   hasSelection: function() {
     var sel = this.get('selection');
@@ -234,7 +234,13 @@ SC.SelectionSupport = {
     // Remove any selection set objects that are no longer in the content
     indexSet = selectionSet.indexSetForSource(arrangedObjects);
     if ((indexSet && (indexSet.get('length') !== selectionSet.get('length'))) || (!indexSet && (selectionSet.get('length') > 0))) { // then the selection content has changed
-      selectionSet = selectionSet.copy().constrain(arrangedObjects).freeze();
+      if (arrangedObjects) {
+        // Constrain the current selection set to matches in arrangedObjects.
+        selectionSet = selectionSet.copy().constrain(arrangedObjects).freeze();
+      } else {
+        // No arrangedObjects, so clear the selection.
+        selectionSet = SC.SelectionSet.EMPTY;
+      }
       this.set('selection', selectionSet);
     }
 

data/lib/frameworks/sproutcore/frameworks/core_foundation/panes/body_overflow.js

@@ -1,15 +1,15 @@
 /**
   SC.bodyOverflowArbitrator is a central object responsible for controlling the overflow on the body element.
-  
+
   Use it from views that would otherwise set the body overflow style directly; call requestHidden to ask for
   the body to have overflow:hidden, and call requestVisible to ask for the body to be visible.
-  
+
   Call withdrawRequest to register that you no longer have any interest in the body overflow setting. Don't
   forget to do this, or your object could be affecting the body overflow long after it's no longer relevant.
-  
+
   When calling requestHidden, requestVisible, and withdrawRequest, pass your object as the first argument so
   that its request can be associated with its GUID.
-  
+
   When calling requestHidden or requestVisible, you may optionally pass true as a second argument to signify
   that your desire for hidden or visible overflow is important. An important visible-request will override
   any other, but an important hidden-request will override a normal visible-request. A normal visible-request
@@ -17,47 +17,66 @@
 */
 SC.bodyOverflowArbitrator = SC.Object.create(/**@scope SC.bodyOverflowArbitrator.prototype */{
   /** Request that the body be given overflow:hidden;. Pass your object, then (optionally) true to confer importance. */
-  requestHidden: function(from,important) { this._makeRequest(from,-1-9*!!important); },
+  requestHidden: function (from, important) { this._makeRequest(from, -1 - 9 * !!important); },
 
   /** Request that the body be given overflow:visible;. Pass your object, then (optionally) true to confer importance. */
-  requestVisible: function(from,important) { this._makeRequest(from,1+9*!!important); },
-  
+  requestVisible: function (from, important) { this._makeRequest(from, 1 + 9 * !!important); },
+
   /** State that your object no longer cares about the body overflow. */
-  withdrawRequest: function(from) {
-    if(!from) return;
-    var guid = SC.guidFor(from);
-    if(this._requests[guid]) delete this._requests[guid];
-    this.setOverflow();
+  withdrawRequest: function (from) {
+    // Fast path!
+    if (!from) return;
+
+    var guid = SC.guidFor(from),
+      currentRequest = this._requests[guid];
+
+    if (currentRequest) {
+      delete this._requests[guid];
+      this.setOverflow();
+    }
   },
-  
+
   /** Perform the action of setting the overflow depending on what requests are currently registered. Does nothing if there are no requests. */
-  setOverflow: function() {
+  setOverflow: function () {
     var overflow = this._decideOverflow();
-    if(overflow!==undefined) document.body.style.overflow = overflow ? "auto" : "hidden";
+
+    if (overflow !== undefined) document.body.style.overflow = overflow ? "auto" : "hidden";
     // console.log("Body Overflow Arbitrator now decides "+(overflow===undefined?"that overflow is unimportant.":"to use overflow:"+(overflow===true?'visible':"hidden")+";")+" Requests are:",this._requests);
   },
-  
-  _makeRequest: function(from,value) {
-    if(!from) return;
-    var guid = SC.guidFor(from);
-    this._requests[guid] = value;
-    this.setOverflow();
+
+  /** @private */
+  _makeRequest: function (from, value) {
+    // Fast path!
+    if (!from) return;
+
+    var guid = SC.guidFor(from),
+      currentRequest = this._requests[guid];
+
+    if (currentRequest != value) {
+      this._requests[guid] = value;
+      this.setOverflow();
+    }
   },
-  
+
+  /** @private */
   _requests: {},
-  _decideOverflow: function() {
+
+  /** @private */
+  _decideOverflow: function () {
     var haveHidden, haveVisible, haveImportantHidden, haveImportantVisible,
         reqs = this._requests, req;
-    for(var i in reqs) {
-      if((req=reqs[i])<0) haveHidden=YES;
-      if(req<-1) haveImportantHidden=YES;
-      if(req>0) haveVisible=YES;
-      if(req>1) haveImportantVisible=YES;
+
+    for (var i in reqs) {
+      if ((req = reqs[i]) < 0) haveHidden = YES;
+      if (req < -1) haveImportantHidden = YES;
+      if (req > 0) haveVisible = YES;
+      if (req > 1) haveImportantVisible = YES;
     }
-    if(haveImportantVisible) return YES;              //important-visible takes all.
-    if(haveVisible && haveImportantHidden) return NO; //important-hidden beats regular-visible.
-    if(haveVisible) return YES;                       //regular-visible beats regular-hidden
-    if(haveHidden) return NO;                         //if there is a hidden, it can win now.
-    return undefined;                                 //if nobody cared, return undefined to prevent work.
+    if (haveImportantVisible) return YES;              //important-visible takes all.
+    if (haveVisible && haveImportantHidden) return NO; //important-hidden beats regular-visible.
+    if (haveVisible) return YES;                       //regular-visible beats regular-hidden
+    if (haveHidden) return NO;                         //if there is a hidden, it can win now.
+
+    return undefined;                                  //if nobody cared, return undefined to prevent work.
   }
-});
+});

data/lib/frameworks/sproutcore/frameworks/core_foundation/panes/layout.js

@@ -11,7 +11,7 @@ SC.Pane.reopen(
   /**
     Last known window size.
 
-    @property {Rect}
+    @type Rect
   */
   currentWindowSize: null,
 
@@ -20,8 +20,8 @@ SC.Pane.reopen(
 
     @returns {Rect} current window size
   */
-  computeParentDimensions: function(frame) {
-    if(this.get('designer') && SC.suppressMain) { return sc_super(); }
+  computeParentDimensions: function (frame) {
+    if (this.get('designer') && SC.suppressMain) { return sc_super(); }
 
     var wDim = {x: 0, y: 0, width: 1000, height: 1000},
         layout = this.get('layout');
@@ -37,7 +37,7 @@ SC.Pane.reopen(
 
       // IE7 is the only browser which reports clientHeight _including_ scrollbar.
       if (SC.browser.name === SC.BROWSER.ie &&
-          SC.browser.compareVersion(SC.browser.version, "7") === 0) {
+          SC.browser.compare(SC.browser.version, "7") === 0) {
 
         var scrollbarSize = SC.platform.get('scrollbarSize');
         if (document.body.scrollWidth > wDim.width) {
@@ -64,9 +64,9 @@ SC.Pane.reopen(
   },
 
   /** @private Disable caching due to an known bug in SC. */
-  frame: function() {
-    if(this.get('designer') && SC.suppressMain) { return sc_super(); }
-    return this.computeFrameWithParentFrame(null) ;
+  frame: function () {
+    if (this.get('designer') && SC.suppressMain) { return sc_super(); }
+    return this.computeFrameWithParentFrame(null);
   }.property(),
 
   /**
@@ -78,11 +78,11 @@ SC.Pane.reopen(
     @param {Rect} newSize the new window size
     @returns {SC.Pane} receiver
   */
-  windowSizeDidChange: function(oldSize, newSize) {
-    this.set('currentWindowSize', newSize) ;
+  windowSizeDidChange: function (oldSize, newSize) {
+    this.set('currentWindowSize', newSize);
     this.setBodyOverflowIfNeeded();
     this.parentViewDidResize(); // start notifications.
-    return this ;
+    return this;
   },
 
   /**
@@ -98,18 +98,21 @@ SC.Pane.reopen(
     multiple different panes, the panes could fight over whether it gets
     an overflow if care isn't taken!
 
-    @param {Boolean} [force] force a style to be set even if there are
-                             no minimums.
+    @param {Boolean} [force=false] force a style to be set even if there are no minimums.
+    @returns {void}
   */
-  setBodyOverflowIfNeeded: function(force) {
+  setBodyOverflowIfNeeded: function (force) {
     //Code to get rid of Lion rubberbanding.
     var layout = this.get('layout'),
         size = this.get('currentWindowSize');
-    if(!layout || !size || !size.width || !size.height) return;
+
+    if (!layout || !size || !size.width || !size.height) return;
+
     var minW = layout.minWidth,
-        minH = layout.minHeight;
-    if(force===true || minW || minH) {
-      if( (minH && size.height<minH) || (minW && size.width<minW) ) {
+      minH = layout.minHeight;
+
+    if (force === true || minW || minH) {
+      if ((minH && size.height < minH) || (minW && size.width < minW)) {
         SC.bodyOverflowArbitrator.requestVisible(this);
       } else {
         SC.bodyOverflowArbitrator.requestHidden(this);
@@ -117,14 +120,17 @@ SC.Pane.reopen(
     }
   },
 
-  /** @private */
-  paneLayoutDidChange: function() {
-    this.invokeOnce(this.updateLayout);
-    this.setBodyOverflowIfNeeded();
-  }.observes('layout'),
+  /**
+    Stops controlling the body overflow according to the needs of this pane.
+
+    @returns {void}
+  */
+  unsetBodyOverflowIfNeeded: function () {
+    SC.bodyOverflowArbitrator.withdrawRequest(this);
+  },
 
-  recomputeDependentProperties: function(original) {
-    this.set('currentWindowSize', this.rootResponder.computeWindowSize()) ;
+  recomputeDependentProperties: function (original) {
+    this.set('currentWindowSize', this.rootResponder.computeWindowSize());
     original();
   }.enhance()
 });

data/lib/frameworks/sproutcore/frameworks/core_foundation/panes/main.js

@@ -13,18 +13,18 @@ sc_require('panes/visibility');
 
 /** @class
 
-  Most SproutCore applications have a main pane, which dominates the 
-  application page.  You can extend from this view to implement your own main 
-  pane.  This class will automatically make itself main whenever you append it 
-  to a document, removing any other main pane that might be currently in 
-  place.  If you do have another already focused as the keyPane, this view 
-  will also make itself key automatically.  The default way to use the main 
+  Most SproutCore applications have a main pane, which dominates the
+  application page.  You can extend from this view to implement your own main
+  pane.  This class will automatically make itself main whenever you append it
+  to a document, removing any other main pane that might be currently in
+  place.  If you do have another already focused as the keyPane, this view
+  will also make itself key automatically.  The default way to use the main
   pane is to simply add it to your page like this:
-  
+
       SC.MainPane.create().append();
-  
-  This will cause your root view to display.  The default layout for a 
-  MainPane is to cover the entire document window and to resize with the 
+
+  This will cause your root view to display.  The default layout for a
+  MainPane is to cover the entire document window and to resize with the
   window.
 
   @extends SC.Pane
@@ -32,38 +32,42 @@ sc_require('panes/visibility');
 */
 SC.MainPane = SC.Pane.extend({
   /** @private */
-  layout: { top: 0, left: 0, bottom: 0, right: 0, minHeight:200, minWidth:200 },
-  
-  init:function(){
-    var wDim = {x: 0, y: 0, width: 1000, height: 1000},
-        layout = this.get('layout'), isOverflowing = false;
-    
-    //Initial computation to get ride of Lion rubberbanding.
-    if (document && document.body) {
-      wDim.width = document.body.clientWidth;
-      wDim.height = document.body.clientHeight;
-      
-      if( layout.minHeight || layout.minWidth ) {
-        if( (layout.minHeight && wDim.height<layout.minHeight) || (layout.minWidth && wDim.width<layout.minWidth) ) {
-          SC.bodyOverflowArbitrator.requestVisible(this);
-        } else {
-          // to avoid Lion rubberbanding
-          SC.bodyOverflowArbitrator.requestHidden(this);
-        }
-      }
-    }
-    sc_super();
-  },
-  
-  /** @private - extends SC.Pane's method */
-  paneDidAttach: function() {
-    var ret = sc_super(),
-        responder = this.rootResponder;
+  layout: { minHeight: 200, minWidth: 200 },
+
+  /**
+    Called when the pane is attached.  Takes on main pane status.
+   */
+  didAppendToDocument: function () {
+    var responder = this.rootResponder;
+
     responder.makeMainPane(this);
-    if (!responder.get('keyRootView')) responder.makeKeyPane(this);
-    return ret ;
+    this.becomeKeyPane();
+
+    // Update the body overflow on attach.
+    this.setBodyOverflowIfNeeded();
+  },
+
+  /**
+    Called when the pane is detached.  Resigns main pane status.
+  */
+  willRemoveFromDocument: function () {
+    var responder = this.rootResponder;
+
+    // Stop controlling the body overflow on detach.
+    this.unsetBodyOverflowIfNeeded();
+
+    responder.makeMainPane(null);
+    this.resignKeyPane();
+  },
+
+  /** @private The 'updatedLayout' event. */
+  _updatedLayout: function () {
+    sc_super();
+
+    // If by chance the minHeight or minWidth changed we would need to alter the body overflow request.
+    this.setBodyOverflowIfNeeded();
   },
-  
+
   /** @private */
   acceptsKeyPane: YES,