sproutcore 0.9.23 → 1.0.1003

data/frameworks/sproutcore/mixins/scrollable.js

@@ -1,246 +0,0 @@
-// ========================================================================
-// SproutCore
-// copyright 2006-2008 Sprout Systems, Inc.
-// ========================================================================
-
-/**
-  @namespace
-
-  Any views you implement that are scrollable should include this mixin to
-  provide basic support for scrolling actions.  You can also override any 
-  of these methods as needed for your own specific behaviors.
-  
-  Often times instead of adding SC.Scrollable to your view, you should
-  place your view inside of an SC.ScrollView.  See that class for more 
-  info.
-  
-  Note that isScrollable must always be true.
-
-*/
-SC.Scrollable = {
-  
-  /** Informs the view system that the receiver is scrollable.
-  
-    Must always be true.
-  */
-  isScrollable: true,
-  
-  /** 
-    Amount to scroll one vertical line.
-  
-    Used by the default implementation of scrollDownLine() and scrollUpLine().  Defaults
-    to 20px.
-  */
-  verticalLineScroll: 20,
-  
-  /**
-    Amount to scroll one horizontal line.
-  
-    Used by the default implementation of scrollLeftLine() and scrollRightLine(). Defaults
-    to 20px.
-  */
-  horizontalLineScroll: 20,
-  
-  /**
-    Amount to scroll one vertical page.
-    
-    Used by the default implementation of scrollUpPage() and scrollDownPage(). Defaults to
-    current innerFrame height.
-  */
-  verticalPageScroll: function() {
-    return this.get('innerFrame').height ;
-  }.property('innerFrame'),
-  
-  /**
-    Amount to scroll one horizontal page.
-    
-    Used by the default implementation of scrollLeftPage() and scrollRightPage().  Defaults
-    to current innerFrame width.
-  */
-  horizontalPageScroll: function() {
-    return this.get('innerFrame').width ;  
-  }.property('innerFrame'),
-  
-  /**
-    Returns true if the receiver has enough vertical content to require 
-    scrolling.
-    
-    If you do not want to allow vertical scrolling, override this to be false 
-    and set the appropriate CSS.
-    
-  */
-  hasVerticalScroller: function() {
-    return this.get('scrollFrame').height > this.get('innerFrame').height ;
-  }.property('scrollFrame'),
-  
-  /**
-    Returns true if the receiver has enough horizontal content to require 
-    scrolling.
-    
-    If you do not want to allow horizontal scrolling, override this to be 
-    false and set the appropriate CSS.
-    
-  */
-  hasHorizontalScroller: function() {
-    return this.get('scrollFrame').width > this.get('innerFrame').width ;
-  }.property('scrollFrame'),
-
-  /**
-    Scrolls the receiver in the horizontal and vertical directions by the 
-    amount specified, if allowed.
-    
-    @param {Point} amount the amount to scroll.  Must include x, y or both
-    @returns {Point} the actual amount scrolled.
-  */
-  scrollBy: function(amount) {
-    var sf = this.get('scrollFrame') ;
-    var f = this.get('innerFrame') ;
-
-    if (!this.get('hasVerticalScroller')) amount.y = 0 ;
-    if (sf.height <= f.height) amount.y = 0 ;
-    
-    if (!this.get('hasHorizontalScroller')) amount.x = 0 ; 
-    if (sf.width <= f.width) amount.x = 0 ;
-
-    // compute new sf
-    var newSf = { x: sf.x - (amount.x || 0), y: sf.y - (amount.y || 0) } ;
-    this.set('scrollFrame', newSf) ;
-    newSf = this.get('scrollFrame') ;
-    
-    return { x: newSf.x - sf.x, y: newSf.y - sf.y }; 
-  },
-
-  /**
-    Scrolls the receiver to the specified x,y coordinate
-  */
-  scrollTo: function(x,y) {
-    this.set('scrollFrame', { x: 0-x, y: 0-y }) ;  
-  },
-  
-  /**
-    Scroll the view to make the passed frame visible.
-    
-    Frame must be relative to the receiver's offsetParent.
-    
-    @param {SC.View} view the view you want to make visible
-  */
-  scrollToVisible: function(view) {
-
-    // get frames and convert them to proper offsets
-    var f = this.get('innerFrame') ;
-    var sf = this.get('scrollFrame') ;
-    
-    // frame of the view, relative to the top of the scroll frame
-    var vf = this.convertFrameFromView(view.get('frame'), view) ;
-    vf.x -= (f.x + sf.x); vf.y -= (f.y + sf.y);
-    
-    // first visible origin
-    var vo = { 
-      x: 0-sf.x, 
-      y: 0-sf.y, 
-      width: f.width, 
-      height: f.height 
-    };
-
-    // if top edge is not visible, shift origin
-    vo.y -= Math.max(0, SC.minY(vo) - SC.minY(vf)) ;
-    vo.x -= Math.max(0, SC.minX(vo) - SC.minX(vf)) ;
-
-    // if bottom edge is not visible, shift origin
-    vo.y += Math.max(0, SC.maxY(vf) - SC.maxY(vo)) ;
-    vo.x += Math.max(0, SC.maxX(vf) - SC.maxX(vo)) ;
-
-    // scroll to that origin.
-    this.scrollTo(vo.x, vo.y) ;
-  },
-  
-  /**
-    Scrolls the receiver down one line if allowed.
-    
-    @param {Number} lines number of lines to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollDownLine: function(lines) {
-    if (lines === undefined) lines = 1 ;
-    return this.scrollBy({ y: this.get('verticalLineScroll')*lines }).y ;
-  },
-
-  /**
-    Scrolls the receiver down up line if allowed.
-    
-    @param {Number} lines number of lines to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollUpLine: function(lines) {
-    if (lines === undefined) lines = 1 ;
-    return 0-this.scrollBy({ y: 0-this.get('verticalLineScroll')*lines }).y ;
-  },
-
-  /**
-    Scrolls the receiver right one line if allowed.
-    
-    @param {Number} lines number of lines to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollRightLine: function(lines) {
-    if (lines === undefined) lines = 1 ;
-    return this.scrollTo({ y: this.get('horizontalLineScroll')*lines }).x ;
-  },
-
-  /**
-    Scrolls the receiver left one line if allowed.
-    
-    @param {Number} lines number of lines to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollLeftLine: function(lines) {
-    if (lines === undefined) lines = 1 ;
-    return 0-this.scrollTo({ y: 0-this.get('horizontalLineScroll')*lines }).x ;
-  },
-
-  /**
-    Scrolls the receiver down one page if allowed.
-    
-    @param {Number} pages number of pages to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollDownPage: function(pages) {
-    if (pages === undefined) pages = 1 ;
-    return this.scrollBy({ y: this.get('verticalPageScroll')*pages }).y ;
-  },
-
-  /**
-    Scrolls the receiver down up page if allowed.
-    
-    @param {Number} pages number of pages to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollUpPage: function(pages) {
-    if (pages === undefined) pages = 1 ;
-    return 0-this.scrollBy({ y: 0-this.get('verticalPageScroll')*pages }).y ;
-  },
-
-  /**
-    Scrolls the receiver right one page if allowed.
-    
-    @param {Number} pages number of pages to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollRightPage: function(pages) {
-    if (pages === undefined) pages = 1 ;
-    return this.scrollTo({ y: this.get('horizontalPageScroll')*pages }).x ;
-  },
-
-  /**
-    Scrolls the receiver left one page if allowed.
-    
-    @param {Number} pages number of pages to scroll
-    @returns {Number} the amount actually scrolled.
-  */
-  scrollLeftPage: function(pages) {
-    if (pages === undefined) pages = 1 ;
-    return 0-this.scrollTo({ y: 0-this.get('horizontalPageScroll')*pages }).x ;
-  }
-  
-} ;
-

data/frameworks/sproutcore/mixins/selection_support.js

@@ -1,160 +0,0 @@
-// ========================================================================
-// SproutCore
-// copyright 2006-2008 Sprout Systems, Inc.
-// ========================================================================
-
-/**
-  @namespace 
-  
-  Implements common selection management properties for controllers.
-
-  Selection can be managed by any controller in your applications.  This
-  mixin provides some common management features you might want such as
-  disabling selection, or restricting empty or multiple selections.
-
-  To use this mixin, simply add it to any controller you want to manage 
-  selection and call updateSelectionAfterContentChange()
-  whenever your source content changes.  You can also override the properties
-  defined below to configure how the selection management will treat your 
-  content.
-  
-  This mixin assumes the arrangedObjects property will return the array of 
-  content you want the selection to reflect.
-  
-  Add this mixin to any controller you want to manage selection.  It is 
-  already applied to the CollectionController and ArrayController.
-
-*/
-SC.SelectionSupport = {
-  
-  /** 
-    Call this method whenever  your source content changes to ensure the 
-    selection always remains up-to-date and valid.
-  */
-  updateSelectionAfterContentChange: function() {
-    var objects = Array.from(this.get('arrangedObjects')) ;
-    var currentSelection = Array.from(this.get('selection')) ;
-    var sel = [] ;
-
-    // the new selection is the current selection that exists in 
-    // arrangedObjects or an empty selection if selection is not allowed.
-    var max = currentSelection.get('length') ;
-    if (this.get('allowsSelection')) {
-      for(var idx=0;idx<max;idx++) {
-        var obj = currentSelection.objectAt(idx) ;
-        if (objects.indexOf(obj) >= 0) sel.push(obj) ;
-      }
-    }
-
-    // if the new selection is a multiple selection, then get the first
-    // object.
-    var selectionLength = sel.get('length') ;
-    if ((selectionLength > 1) && !this.get('allowsMultipleSelection')) {
-      sel = [sel.objectAt(0)] ;
-    }
-
-    // if the selection is empty, select the first item.
-    if ((selectionLength == 0) && !this.get('allowsEmptySelection')) {
-      if (objects.get('length') > 0) sel = [objects.objectAt(0)];
-    }
-
-    // update the selection.
-    this.set('selection',sel) ;
-  },
-  
-  /**
-    @field {Array} arrangedObjects
-    
-    Returns the set of content objects the selection should be a part of.
-    Selections in general may contain objects outside of this content, but
-    this set will be used when enforcing items such as no empty selection.
-    
-    The default version of this property returns the receiver.
-  */
-  arrangedObjects: function() {
-    return this;
-  }.property(),
-  
-  /**  
-    @field {Array} selection 
-
-    This is the current selection.  You can make this selection and another
-    controller's selection work in concert by binding them together. You
-    generally have a master selection that relays changes TO all the others.
-  */
-  selection: function(key,value)
-  {
-    if (value !== undefined) {
-      
-      // always force to an array
-      value = Array.from(value) ;
-    
-      var allowsSelection         = this.get('allowsSelection');
-      var allowsEmptySelection    = this.get('allowsEmptySelection');
-      var allowsMultipleSelection = this.get('allowsMultipleSelection');
-    
-      // are we even allowing selection at all?
-      // if not, then bail out.
-      if ( !allowsSelection ) return this._selection;
-    
-      // ok, new decide if the *type* of seleciton is allowed...
-      switch ( value.get('length') )
-      {
-        case 0:
-          // check to see if we're attemting to set an empty array
-          // if that's not allowed, set to the first available item in 
-          // arrangedObjects
-          if (!allowsEmptySelection) {
-            var objects = this.get('arrangedObjects') ;
-            if (objects.get('length') > 0) value = [objects.objectAt(0)];
-          }
-          this._selection = value ;
-          break;
-        case 1:
-          this._selection = value;
-          break;
-        default:
-          // fall through for >= 2 items...
-          // only allow if configured for multi-select
-          this._selection = allowsMultipleSelection ? value : this._selection;
-          break;
-      }
-    }
-  
-    return this._selection;
-  }.property(),
-
-  /**
-    If true, selection is allowed.
-
-    @type bool
-  */
-  allowsSelection: true,
-
-  /**
-    If true, multiple selection is allowed.
-
-    @type bool
-  */
-  allowsMultipleSelection: true,
-
-  /**
-    If true, allow empty selection
-
-    @type bool
-  */
-  allowsEmptySelection: true,
-  
-  /**
-    YES if the receiver currently has a non-zero selection.
-    
-    @property
-    @type {Boolean}
-  */
-  hasSelection: function() {
-    var sel = this.get('selection') ;
-    return !!sel && (sel.get('length') > 0) ;
-  }.property('selection')
-    
-};
-

data/frameworks/sproutcore/mixins/validatable.js

@@ -1,152 +0,0 @@
-// ========================================================================
-// SproutCore
-// copyright 2006-2008 Sprout Systems, Inc.
-// ========================================================================
-
-/**
-  @namespace
-
-  Views that include the Validatable mixin can be used with validators to 
-  ensure their values are valid.  
-  
-*/
-SC.Validatable = {
-  
-  initMixin: function() {
-    this._validatorObserver() ;
-  },
-  
-  /**
-    The validator for this field.  
-  
-    Set to a validator class or instance.  If this points to a class, it will 
-    be instantiated when the validator is first used.
-  */
-  validator: null,
-
-  /**
-    This property must return the human readable name you want used when 
-    describing an error condition.  For example, if set this property to
-    "Your Email", then the returned error string might be something like
-    "Your Email is not valid".
-    
-    You can return a loc string here if you like.  It will be localized when
-    it is placed into the error string.
-  */
-  errorLabel: null,
-
-  /**
-    YES if the receiver is currently valid.
-    
-    This property watches the value property by default.  You can override
-    this property if you want to use some other method to calculate the
-    current valid state.
-    
-    @field
-  */
-  isValid: function() { 
-    return $type(this.get('value')) != T_ERROR; 
-  }.property('value'),
-  
-  /**
-    The form that the view belongs to.  May be null if the view does not 
-    belong to a form.  This property is usually set automatically by an 
-    owner form view.
-  */
-  ownerForm: null,
-  
-  /**
-    Attempts to validate the receiver. 
-    
-    Runs the validator and returns SC.Validator.OK, SC.Validator.NO_CHANGE,
-    or an error object.  If no validator is installed, this method will
-    always return SC.Validator.OK.
-
-    @param {Boolean} partialChange YES if this is a partial edit.
-    @returns SC.Validator.OK, error, or SC.Validator.NO_CHANGE
-  */
-  performValidate: function(partialChange) {
-    var ret = SC.Validator.OK ;
-
-    if (this._validator) {
-      var form = this.get('ownerForm') ;
-      if (partialChange) {
-        ret = this._validator.validatePartial(form,this) ;
-
-        // if the partial returned NO_CHANGE, then check to see if the 
-        // field is valid anyway.  If it is not valid, then don't update the
-        // value.  This way the user can have partially constructed values 
-        // without the validator trying to convert it to an object.
-        if ((ret == SC.Validator.NO_CHANGE) && (this._validator.validateChange(form, this) == SC.Validator.OK)) {
-          ret = SC.Validator.OK; 
-        }
-      } else ret = this._validator.validateChange(form, this) ;
-    }
-    return ret ;
-  },
-
-  /**
-    Runs validateSubmit.  You should use this in your implementation of 
-    validateSubmit.  If no validator is installed, this always returns
-    SC.Validator.OK
-  */
-  performValidateSubmit: function() {
-    return (this._validator) ? this._validator.validateSubmit(this.get('ownerForm'), this) : SC.Validator.OK;
-  },
-  
-  /**
-    Invoked by the owner form just before submission.  Override with your 
-    own method to commit any final changes after you perform validation. 
-    
-    The default implementation simply calls performValidateSubmit() and 
-    returns that value.
-  */
-  validateSubmit: function() { return this.performValidateSubmit(); },
-  
-  /**
-    Convert the field value string into an object.
-    
-    This method will call the validators objectForFieldValue if it exists.
-    
-    @param fieldValue the raw value from the field.
-    @returns converted object
-  */
-  objectForFieldValue: function(fieldValue) {
-    return (this._validator) ? this._validator.objectForFieldValue(fieldValue, this.get('ownerForm'), this) : fieldValue ;
-  },
-  
-  /**
-    Convert the object into a field value.
-    
-    This method will call the validator's fieldValueForObject if it exists.
-    
-    @param object the objec to convert
-    @returns converted field value
-  */
-  fieldValueForObject: function(object) {
-    return (this._validator) ? this._validator.fieldValueForObject(object, this.get('ownerForm'), this) : object ;
-  },
-  
-  /**
-    Default observer for isValid property.
-    
-    The default implementation will add/remove a valid class name to the
-    root element of your view.
-  */
-  isValidObserver: function() {
-    var invalid = !this.get('isValid') ;
-    this.setClassName('invalid', invalid) ;
-  }.observes('isValid'),
-  
-  // invoked whenever the attached validator changes.
-  _validatorObserver: function() {
-    var form = this.get('ownerForm') ;
-    var val = SC.Validator.findFor(form, this, this.get('validator')) ;
-    if (val != this._validator) {
-      if (this._validator) this._validator.detachFrom(form, this) ;
-      this._validator = val;
-      if (this._validator) this._validator.attachTo(form, this) ;
-    }  
-  }.observes('validator', 'ownerForm')
-      
-};