sproutcore 0.9.23 → 1.0.1003

data/frameworks/sproutcore/controllers/array.js

@@ -1,409 +0,0 @@
-// ========================================================================
-// SproutCore
-// copyright 2006-2008 Sprout Systems, Inc.
-// ========================================================================
-
-require('controllers/controller') ;
-require('mixins/array') ;
-require('mixins/selection_support') ;
-require('foundation/binding') ;
-
-/** @class
-
-An Array Controller provides a way to project the contents of an array
-out to a view.  You can use this object any place you might use an
-array.  Changes to the array will not propogate to the content array
-until you call commitChanges().
-
-@extends SC.Controller
-@extends SC.Array
-@extends SC.SelectionSupport
-@since SproutCore 1.0
-
-*/
-SC.ArrayController = SC.Controller.extend(SC.Array, SC.SelectionSupport,
-/** @scope SC.ArrayController.prototype */
-{
-  
-  /**
-    If YES the will return controllers for content objects.
-    
-    If you want to use an array controller to edit an array contents directly
-    but you do not want to wrap the values of the array in controller objects
-    then you should set this property to NO.
-    
-    @field
-    @type {Boolean}
-  */
-  useControllersForContent: NO,
-  
-  /**
-    Provides compatibility with CollectionControllers.
-    @field
-    @type {SC.ArrayController}
-  */
-  arrangedObjects: function() { return this; }.property('content'),
-
-  /**
-    The content array managed by this controller.  
-  
-    In general you can treat an instance of ArrayController as if it were 
-    the array held in this property.  Any changes you make to the controller
-    that are not specifically implemented in the controller will pass through
-    to the Array.
-  
-    Also if you set commitsChangesImmediately to false, the controller will
-    buffer changes against this.
-
-    @property
-    @type {Array}
-  */
-  content: null,
-  contentBindingDefault: SC.Binding.Multiple,
-
-  /**
-    Set to true if the controller has any content, even an empty array.
-  */
-  hasContent: function() {
-    return this.get('content') != null ;
-  }.property('content'),
-  
-  /**
-    Set to true if you want objects removed from the array to also be
-    deleted.  This is a convenient way to manage lists of items owned
-    by a parent record object.
-    
-    Note that even if this is set to NO, calling destroyObject() instead of
-    removeObject() will still destroy the object in question as well as 
-    removing it from the parent array.
-    
-    @field
-    @type {Boolean}
-  */
-  destroyOnRemoval: NO,
-
-  /**
-    Defines the default class to use when creating new content. 
-    
-    This property should either contains a class or a string that resolves
-    to a class that responds to the newRecord() method.
-  
-    @property
-    @type {Class}
-  */
-  exampleContentObject: null,
-  
-  /**
-    Creates a new record instance and adds it to the end of the current array.
-
-    This method works just like insertNewObjectAt() but always appends.
-
-    @param attributes {Hash} optional hash of attributes to pass to the new obejct.
-    @param objectType {Class} optional class of object to create.
-    @returns {Object} the newly created object (also added to the array)
-  */ 
-  newObject: function(attributes, objectType) {
-    return this.insertNewObjectAt(null, attributes, objectType) ;
-  },
-  
-  /**
-    Creates a new content object and inserts it at the passed index or appends
-    it at the end of the array if you pass null.
-
-    This method takes an optional hash of attributes which will be set on
-    the new record.  You can also pass an optional objectType.  If you do 
-    not pass the objectType, you must instead set the exampleContentObject to 
-    the class of the object you want to use.  The object can be of any type 
-    but it must respond to the newRecord() method.
-    
-    Objects created using this method will be destroyed automatically if you
-    have set commitsChangesImmediately to false and call discardChanges().
-
-    @param index {Number} the index to insert at or null to append.
-    @param attributes {Hash} optional hash of attributes to pass to the new obejct.
-    @param objectType {Class} optional class of object to create.
-    @returns {Object} the newly created object (also added to the array)
-  */
-  insertNewObjectAt: function(index, attributes, objectType) {
-    
-    // compute the objectType
-    if (!objectType) objectType = this.get('exampleContentObject') ;
-    if ($type(objectType) === T_STRING) {
-      objectType = SC.Object.objectForPropertyPath(objectType) ;
-    }
-    if (objectType == null) {
-      throw "Invalid object type was provided" ;
-    }
-    
-    if ($type(objectType.newObject) !== T_FUNCTION) {
-      throw "content object type does not support newRecord()" ;
-    }
-    
-    // Create a new object...
-    var obj = objectType.newObject(attributes) ;
-    if (!this._createdObjects) this._createdObjects = [] ;
-    this._createdObjects.push(obj) ; // save for discard...
-    
-    // Add to array.
-    if (index) {
-      this.insertAt(index, obj) ;
-    } else this.pushObject(obj) ;
-    
-    return obj ;
-  },
-  
-  /**
-    Watches changes to the content property updates the contentClone.
-    @private
-    @observes content
-  */
-  _contentObserver: function() {
-    var content = this.get('content') ;
-    if (SC.isEqual(content, this._content)) return ; // nothing to do
-
-    if (!this._boundContentPropertyObserver) {
-      this._boundContentPropertyObserver = this._contentPropertyObserver.bind(this) ;
-    }
-    var func = this._boundContentPropertyObserver ;
-
-    // remove old observer, add new observer, and trigger content property change
-    if (this._content && this._content.removeObserver) this._content.removeObserver('[]', func) ;
-    if (content && content.addObserver) content.addObserver('[]', func) ;
-    this._content = content; //cache
-    this._contentPropertyRevision = null ;
-    
-    var rev = (content) ? content.propertyRevision : -1 ;
-    this._contentPropertyObserver(this, '[]', content, rev) ; 
-  }.observes('content'),
-
-  _contentPropertyObserver: function(target, key, value, rev) {  
-      
-    if (!this._updatingContent && (!rev || (rev != this._contentPropertyRevision))) {
-      this._contentPropertyRevision = rev ;
-
-      this._updatingContent = true ;
-
-      this.beginPropertyChanges();
-      this.contentCloneReset();
-      this.enumerableContentDidChange() ;
-      this.notifyPropertyChange('length') ;
-      this.updateSelectionAfterContentChange();
-      this.endPropertyChanges() ;
-
-      this._updatingContent = false ;
-
-    }
-  },
-  
-  /**
-    The array content that (when committed) will be merged back into the 
-    content property. All array methods will take place on this object.
-
-    @field
-    @type {SC.Array}
-  */
-  contentClone: null,
-
-  /**
-    Clones the content property into the contentClone property.
-    @private
-  */
-  contentCloneReset: function() {
-    this._changelog = [];
-    this.set('contentClone', null);
-  },
-
-  /**
-   SC.Array interface implimentation.
-   
-   @param idx {Number} Starting index in the array to replace.  If idx >= 
-     length, then append to the end of the array.
-   
-   @param amt {Number} Number of elements that should be removed from the 
-     array, starting at *idx*.
-   
-   @param objects {Array} An array of zero or more objects that should be 
-     inserted into the array at *idx* 
-  */
-  replace: function(idx, amt, objects) {
-
-    var content = this.get('content') ;
-
-    // in case the passed objects are controllers, convert to source objects.
-    var copyIdx = objects.length ;
-    var sourceObjects = objects ;
-    if (copyIdx > 0) {
-      sourceObjects = [] ;
-      while(--copyIdx >= 0) {
-        sourceObjects[copyIdx] = this._sourceObjectFor(objects[copyIdx]) ;
-      }
-    }
-    
-    // create clone of content array if needed
-    var contentClone = this.get('contentClone') ;
-    if (!contentClone) {
-      this.set('contentClone', contentClone = content.clone()) ;
-    }
-
-    // now, record the removed objects.  This may be used later.
-    if (this.get('destroyOnRemoval')) {
-      if (!this._deletions) this._deletions = [] ;
-      for (var i=0; i < amt; i++) {
-        this._deletions.push(content.objectAt(idx + i));
-      }
-    }
-
-    // and record additions
-    if (!this._changelog) this._changelog = []; 
-    this._changelog.push({ idx: idx, amt: amt, objects: sourceObjects });
-    
-    // then actually perform the edit on the contentClone
-    contentClone.replace(idx, amt, sourceObjects);
-    
-    this.editorDidChange() ;
-    this.enumerableContentDidChange();
-    this.updateSelectionAfterContentChange();
-    
-    return this;
-  },
-  
-  /**
-    SC.Array interface implimentation.
-    @param idx {Number} The index of the item to return.  If idx exceeds the 
-      current length, return null.
-  */
-  objectAt: function(idx) {
-    var obj = this._getSourceContent() ;
-    obj = (obj && obj.objectAt) ? obj.objectAt(idx) : null;
-    return this._objectControllerFor(obj) ;
-  },
-  /**
-    SC.Array interface implimentation.
-    @property
-    @type {integer}
-  */
-  length: function( key, value ) {
-    var ret = this._getSourceContent() ;
-    return (ret && ret.get) ? (ret.get('length') || 0) : 0 ;
-  }.property(),
-
-  /**
-    Returns the index in the array of the specified object.
-    
-    This can handle both controller wrapper objects and source content objects.
-  */
-  indexOf: function( obj ) {
-    return this._getSourceContent().indexOf(this._sourceObjectFor(obj)) ;
-  },
-  
-  _getSourceContent: function() {
-    return this.get('contentClone') || this.get('content') || [];
-  },
-  
-  /** 
-  * @private
-  */
-  performCommitChanges: function()
-  {
-    var content = this.get('content');
-    var ret     = true;
-    
-    // cannot commit changes to null content.  Return an error.
-    if (!content) {
-      return $error("No Content");
-    }
-    
-    if (content.beginPropertyChanges) content.beginPropertyChanges();
-
-
-    // apply all the changes made to the clone
-    if (this._changelog) {
-      var changelog = this._changelog ;
-      var max = changelog.length;
-      for(var idx=0;idx<max;idx++) {
-        var change = changelog[idx];
-        content.replace(change.idx, change.amt, change.objects) ;
-      }
-      this._changelog.length = 0 ; // reset changelog
-    }
-
-    // finally, destroy any removed objects if necessary.  Make 
-    // sure the objects have not been re-added before doing this.
-    if (this.get('destroyOnRemoval') && this._deletions && this._deletions.length>0) {
-      var idx = this._deletions.length;
-      while(--idx >= 0) {
-        var obj = this._deletions[idx] ;
-        if (obj && obj.destroy && (content.indexOf(obj) < 0)) {
-          obj.destroy() ; 
-        }
-      }
-      this._deletions.length = 0; // clear array
-    }
-    
-    // changes commited, clear any created objects from the internal array
-    if (this._createdObjects) this._createdObjects.length = 0 ;
-    
-     // finish commiting changes.
-    if (content.endPropertyChanges) content.endPropertyChanges();
-    if (content.commitChanges) ret = content.commitChanges();
-    
-    if ($ok(ret)) {
-      this.contentCloneReset();
-      this.editorDidClearChanges();
-    }
-    
-    return ret;
-  },
-  /** 
-  * @private
-  */
-  performDiscardChanges: function()
-  {
-    this.contentCloneReset();
-    this.editorDidClearChanges();
-    
-    // if any objects were created before the commit, destroy the objects 
-    // and reset the array.
-    if (this._createdObjects && this._createdObjects.length > 0) {
-      var idx = this._createdObjects.length ;
-      while(--idx >= 0) {
-        var obj = this._createdObjects[idx] ;
-        if ($type(obj.destroy) === T_FUNCTION) obj.destroy() ;
-      }
-      this._createdObjects.length = 0 ;
-    }
-    
-    return true;
-  },
-  
-  /** @private
-    Returns the object controller for a source value.
-  */
-  _objectControllerFor: function(obj) {
-    if (!this.useControllersForContent) return obj;
-    
-    var controllers = this._objControllers = this._objControllers || {} ;
-    var guid = SC.getGUID(obj) ;
-    var ret = controllers[guid] ;
-    if (!ret) {
-      ret = controllers[guid] = this.controllerForValue(obj) ;
-      if (ret) ret.__isArrayController = true ;
-    }
-    return ret ;
-  },
-  
-  /** @private
-    Returns the source object for the passed value.  If the passed value is a 
-    controller, this will map back to the sourceo object.  Otherwise the object itself
-    will be returned.
-  */
-  _sourceObjectFor: function(obj) {
-    return (obj && obj.kindOf && obj.kindOf(SC.Controller)) ? obj.get('content') : obj ;
-  },
-  
-  init: function() {
-    sc_super() ;
-    if (this.get('content')) this._contentObserver() ;
-  }
-
-});

data/frameworks/sproutcore/controllers/collection.js

@@ -1,203 +0,0 @@
-// ========================================================================
-// SproutCore
-// copyright 2006-2008 Sprout Systems, Inc.
-// ========================================================================
-
-require('mixins/selection_support') ;
-require('controllers/object') ;
-
-/** @class
-
-  A CollectionController works just like an ObjectController except that
-  it includes support for a few extra items including the arrangedObjects
-  property (which may have a filter applied), and a selection.
-
-  This expects the content object to be a Collection object.
-
-  @extends SC.ObjectController
-*/
-SC.CollectionController = SC.ObjectController.extend(SC.SelectionSupport,
-/** @scope SC.CollectionController.prototype */ {
-
-  // ...................................
-  // PROPERTIES
-  //
-
-  /**
-    This is the current set of objects for the UI.
-    
-    @type Array
-  */
-  arrangedObjects: [],
-  
-
-  /**
-    If true, new, add, remove will work.
-  
-    @type bool
-  */
-  canEditCollection: false,
-
-  /**
-    Set to the total number of items to show on a single page.  If set to
-    zero, then no pagination will be performed.
-  
-    @type number
-  */
-  pageSize: 0,
-  
-  /**
-    [RO] read only property with the current total number of pages.
-  */
-  pageCount: function() {
-    var pageSize = this.get('pageSize') ;
-    if (pageSize <= 0) return 1 ;
-    
-    var content = this.get('content') ;
-    var count = (content && content.get) ? content.get('count') : 0 ;
-    if (count === null) count = 0 ;
-    return Math.ceil(count / pageSize) ;
-  }.property(),
-  
-  /**
-    Set to the current page.  This will change the offset and limit shown in
-    the collection.  If you try to set the page to a number greater than the
-    maximum, then it will be set to the last page.
-  */
-  currentPage: function(key, value) {
-    if (value !== undefined) {
-      // constrain pages.
-      if (this._currentPage != value) {
-        var pc = Math.max(this.get('pageCount')-1,0);
-        if (value > pc) value = pc ;
-        if (value < 0) value = 0 ;
-        this._currentPage = value ;
-      }
-    }
-    return this._currentPage || 0 ;  
-  }.property(),
-  
-  // ...................................
-  // METHODS
-  //
-
-  // adds a new object to the current collection, if allowed, and sets it
-  // as the current selection.
-  newObject: function(settings) {
-    var content = this.get('content') ;
-    if (!content || !this.get('canEditCollection')) return ; // only if allowed 
-    try {
-      if (content.newRecord) { 
-        var rec = content.newRecord(settings) ;
-        var t = function() {
-          this.set('selection',(rec) ? [rec] : []) ;
-          this._editingNewRecord = rec ;
-        }.invokeLater(this, 1) ;
-        return rec;
-      }
-    }   
-    catch (e) {
-      // DO SOMETHING
-    }
-  },
-
-  addObjects: function(objects) {
-    var content = this.get('content') ;
-    if (!content || !this.get('canEditCollection')) return ; // only if allowed 
-    try {
-      objects = SC.$A(arguments).flatten() ;
-      if (content.addRecords) { 
-        content.addRecords(objects) ;
-        this.set('selection',(objects) ? objects : []) ;
-      }
-    }   
-    catch (e) {
-      // DO SOMETHING
-    }
-  },
-  
-  addSelection: function() { 
-    return this.addObjects(this.get('selection'));
-  },
-  
-  // adds a new object to the current collection, if allowed, and sets it
-  // as the current selection.
-  removeObjects: function(objects) {
-    var content = this.get('content') ;
-    if (!content || !this.get('canEditCollection')) return ; // only if allowed 
-    try {
-      objects = SC.$A(arguments).flatten() ;
-      if (content.removeRecords) { 
-        var rec = content.removeRecords(objects) ;
-        var sel = (this.get('selection') || []).without(objects) ;
-        this.set('selection',(sel) ? sel : []) ;
-      }
-    }   
-    catch (e) {
-      // DO SOMETHING
-    }
-  },
-
-  removeSelection: function() {
-    return this.removeObjects(this.get('selection')) ;
-  },
-
-  // this method is called if a new object was created through the controller
-  // and then the selection was changed from the new record without the 
-  // record being saved first.  By default, this will remove the object, but
-  // you could override it to just do a commit.
-  newObjectDidLoseFocus: function(rec) { rec.destroy() ; },
-  
-  // ...................................
-  // PRIVATE
-  //
-  
-  _newRecordDidLoseFocus: function(rec) {
-    if (rec.get('newRecord')) this.newObjectDidLoseFocus(rec) ;
-  },
-  
-  // Update the current page.
-  _pageObserver: function() {
-    // get content -- nothing to do if no content.
-    var content = this.get('content') ; 
-    if (content instanceof Array) content = content[0] ;
-    if (!content) return ; 
-    
-    var curOffset = content.get('offset') || 0 ;
-    var curLimit = content.get('limit') || 0 ;
-    var count = content.get('count') || 0 ;
-
-    // calculate the offset and limit.
-    var currentPage = this.get('currentPage') ;
-    var pageSize = this.get('pageSize') ;
-    var newOffset, newLimit ;
-    if (pageSize == 0) {
-      newOffset = 0; newLimit = 0 ;
-    } else {
-      newOffset = currentPage * pageSize ;
-      newLimit = pageSize ;      
-    }
-    
-    // set new page info.
-    if ((newOffset != curOffset) || (newLimit != curLimit)) {
-      content.beginPropertyChanges() ;
-      content.set('offset',newOffset) ;
-      content.set('limit',newLimit) ;
-      content.endPropertyChanges() ;
-    }    
-  }.observes('currentPage','pageCount','pageSize'),
-  
-  // invoked whenever the list changes.  Updated the arrangedObjects and
-  // potentially the selection.
-  _recordsObserver: function(target,key,value) {
-    var old = this.get('arrangedObjects') ;
-    value = Array.from(target.get(key)) ;
-    
-    this.set('arrangedObjects',value.slice()) ;
-    
-    // update selection.
-    this.updateSelectionAfterContentChange() ;
-
-  }.observes('records') 
-  
-}) ;