sproutcore 1.10.0.rc.2 → 1.10.0.rc.3

data/lib/frameworks/sproutcore/frameworks/table/views/table.js

@@ -9,27 +9,31 @@ sc_require('mixins/table_delegate');
 sc_require('views/table_head');
 
 /** @class
-  
-  A table view renders a two-dimensional grid of data.
-  
-  TODO: More documentation.
-  
+  Deprecated.
+
+  The default SC.TableView has several issues and therefore until a suitable
+  replacement is developed, this class should be considered deprecated and
+  should not be used.
+
+  Please try [](https://github.com/jslewis/sctable) for a decent alternative.
+
   @extends SC.ListView
   @extends SC.TableDelegate
+  @deprecated Version 1.10
   @since SproutCore 1.1
 */
 
 SC.TableView = SC.ListView.extend(SC.TableDelegate, {
-  /** @scope SC.TableView.prototype */  
-  
+  /** @scope SC.TableView.prototype */
+
   // ..........................................................
   // PROPERTIES
-  // 
-  
+  //
+
   classNames: ['sc-table-view'],
-  
+
   childViews: "tableHeadView scrollView".w(),
-  
+
   scrollView: SC.ScrollView.extend({
     isVisible: YES,
     layout: {
@@ -42,7 +46,7 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
     borderStyle: SC.BORDER_NONE,
     contentView: SC.View.extend({
     }),
-    
+
     // FIXME: Hack.
     _sv_offsetDidChange: function() {
       this.get('parentView')._sctv_scrollOffsetDidChange();
@@ -51,9 +55,9 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
 
   hasHorizontalScroller: NO,
   hasVerticalScroller: NO,
-  
+
   selectOnMouseDown: NO,
-  
+
   // FIXME: Charles originally had this as an outlet, but that doesn't work.
   // Figure out why.
   containerView: function() {
@@ -61,32 +65,32 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
     return (scrollView && scrollView.get) ? scrollView.get('contentView') : null;
     //return this.get('scrollView').get('contentView');
   }.property('scrollView'),
-  
+
   layout: { left: 0, right: 0, top: 0, bottom: 0 },
-  
+
   init: function() {
     sc_super();
 
     window.table = this; // DEBUG
     //this._sctv_columnsDidChange();
   },
-  
-  
+
+
   canReorderContent: NO,
-  
+
   isInDragMode: NO,
-  
+
   // ..........................................................
   // EVENT RESPONDERS
-  // 
-  
+  //
+
   mouseDownInTableHeaderView: function(evt, header) {
     var column = header.get('column');
-    
+
     if (!column.get('isReorderable') && !column.get('isSortable')) {
       return NO;
     }
-    
+
     // Save the mouseDown event so we can use it for mouseUp/mouseDragged.
     this._mouseDownEvent = evt;
     // Set the timer for switching from a sort action to a reorder action.
@@ -95,10 +99,10 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
       action: '_scthv_enterDragMode',
       interval: 300
     });
-    
+
     return YES;
   },
-  
+
   mouseUpInTableHeaderView: function(evt, header) {
     var isInDragMode = this.get('isInDragMode');
     // Only sort if we're not in drag mode (i.e., short clicks).
@@ -113,21 +117,21 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
 
       column.set('sortState', newSortState);
     }
-    
+
     // Exit drag mode (and cancel any scheduled drag modes).
     // this._scthv_exitDragMode();
     this._dragging = false;
     if (this._mouseDownTimer) {
       this._mouseDownTimer.invalidate();
     }
-    
+
   },
-  
+
   mouseDraggedInTableHeaderView: function(evt, header) {
     SC.RunLoop.begin();
     var isInDragMode = this.get('isInDragMode');
     if (!isInDragMode) return NO;
-    
+
     if (!this._dragging) {
       SC.Drag.start({
         event:  this._mouseDownEvent,
@@ -138,39 +142,39 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
       });
       this._dragging = true;
     }
-    
+
     return sc_super();
     SC.RunLoop.end();
   },
-  
-  
+
+
   // ..........................................................
   // COLUMN PROPERTIES
   //
-  
+
   /**
     A collection of `SC.TableColumn` objects. Modify the array to adjust the
     columns.
-    
+
     @property
     @type Array
   */
   columns: [],
-  
+
   /**
     Which column will alter its size so that the columns fill the available
     width of the table. If `null`, the last column will stretch.
-    
+
     @property
     @type SC.TableColumn
   */
   flexibleColumn: null,
-  
+
   /**
     Which column is currently the "active" column for sorting purposes.
     Doesn't say anything about sorting direction; for that, read the
     `sortState` property of the sorted column.
-    
+
     @property
     @type SC.TableColumn
   */
@@ -178,35 +182,35 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
 
   // ..........................................................
   // HEAD PROPERTIES
-  // 
+  //
 
   /**
     if YES, the table view will generate a head row at the top of the table
     view.
-    
+
     @property
     @type Boolean
   */
   hasTableHead: YES,
-    
+
   /**
     The view that serves as the head view for the table (if any).
-    
+
     @property
     @type SC.View
   */
   tableHeadView: SC.TableHeadView.extend({
     layout: { top: 0, left: 0, right: 0 }
   }),
-  
+
   /**
     The height of the table head in pixels.
-    
+
     @property
     @type Number
   */
   tableHeadHeight: 18,
-  
+
 
   // ..........................................................
   // ROW PROPERTIES
@@ -215,54 +219,54 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
   /**
     Whether all rows in the table will have the same pixel height. If so, we
     can compute offsets very cheaply.
-    
+
     @property
     @type Boolean
   */
   hasUniformRowHeights: YES,
-  
+
   /**
     How high each row should be, in pixels.
-    
+
     @property
     @type Number
   */
   rowHeight: 18,
-  
+
   /**
     Which view to use for a table row.
-    
+
     @property
     @type SC.View
   */
   exampleView: SC.TableRowView,
-  
+
   // ..........................................................
   // DRAG-REORDER MODE
-  // 
-  
+  //
+
   isInColumnDragMode: NO,
-  
-    
-  
+
+
+
   // ..........................................................
   // OTHER PROPERTIES
-  // 
-  
+  //
+
   filterKey: null,
-  
-  
+
+
   /**
     Returns the top offset for the specified content index.  This will take
     into account any custom row heights and group views.
-    
+
     @param {Number} idx the content index
     @returns {Number} the row offset in pixels
   */
-  
+
   rowOffsetForContentIndex: function(contentIndex) {
     var top = 0, idx;
-    
+
     if (this.get('hasUniformRowHeights')) {
       return top + (this.get('rowHeight') * contentIndex);
     } else {
@@ -270,13 +274,13 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
         top += this.rowHeightForContentIndex(idx);
       }
       return top;
-    }    
+    }
   },
-  
+
   /**
     Returns the row height for the specified content index.  This will take
     into account custom row heights and group rows.
-    
+
     @param {Number} idx content index
     @returns {Number} the row height in pixels
   */
@@ -287,12 +291,12 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
       // TODO
     }
   },
-  
-  
-  /**  
+
+
+  /**
     Computes the layout for a specific content index by combining the current
     row heights.
-    
+
     @param {Number} index content index
   */
   layoutForContentIndex: function(index) {
@@ -303,19 +307,19 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
       right:  0
     };
   },
-  
+
   createItemView: function(exampleClass, idx, attrs) {
     // Add a `tableView` attribute to each created row so it has a way to
     // refer back to this view.
     attrs.tableView = this;
     return exampleClass.create(attrs);
   },
-  
+
   clippingFrame: function() {
     var cv = this.get('containerView'),
         sv = this.get('scrollView'),
         f  = this.get('frame');
-        
+
     if (!sv.get) {
       return f;
     }
@@ -326,9 +330,9 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
       x:      sv.get('horizontalScrollOffset'),
       y:      sv.get('verticalScrollOffset')
     };
-    
+
   }.property('frame', 'content').cacheable(),
-   
+
   _sctv_scrollOffsetDidChange: function() {
     this.notifyPropertyChange('clippingFrame');
   },
@@ -337,16 +341,16 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
   // ..........................................................
   // SUBCLASS IMPLEMENTATIONS
   //
-  
-  
+
+
   computeLayout: function() {
     var layout = sc_super(),
         containerView = this.get('containerView'),
         frame = this.get('frame');
-        
+
     var minHeight = layout.minHeight;
     delete layout.minHeight;
-        
+
 
     // FIXME: In the middle of initialization, the TableView needs to be
     // reloaded in order to become aware of the proper display state of the
@@ -357,30 +361,30 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
     // if (currentHeight !== height) {
     //   this.reload();
     // }
-    
+
     containerView.adjust('minHeight', minHeight);
     containerView.layoutDidChange();
 
     //containerView.adjust('height', height);
     //containerView.layoutDidChange();
-    
-    this.notifyPropertyChange('clippingFrame');    
+
+    this.notifyPropertyChange('clippingFrame');
     return layout;
   },
-  
-  
+
+
   // ..........................................................
   // INTERNAL SUPPORT
-  // 
-  
+  //
+
   // When the columns change, go through all the columns and set their tableContent to be this table's content
   // TODO: should these guys not just have a binding of this instead?
   _sctv_columnsDidChange: function() {
 
-    var columns = this.get('columns'), 
+    var columns = this.get('columns'),
         content = this.get('content'),
         idx;
-    
+
     for (idx = 0; idx < columns.get('length'); idx++) {
       columns.objectAt(idx).set('tableContent', content);
     }
@@ -388,32 +392,32 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
     this.reload();
 
   }.observes('columns'),
-  
+
   // Do stuff when our frame size changes.
   _sctv_adjustColumnWidthsOnResize: function() {
 
     var width   = this.get('frame').width;
     var content = this.get('content'),
         del = this.delegateFor('isTableDelegate', this.delegate, content);
-    
+
     if (this.get('columns').length == 0) return;
     width = del.tableShouldResizeWidthTo(this, width);
-    
+
     var columns = this.get('columns'), totalColumnWidth = 0, idx;
-    
+
     for (var idx = 0; idx < columns.length; idx++) {
       totalColumnWidth += columns.objectAt(idx).get('width');
     }
-    
+
     if (width === 0) width = totalColumnWidth;
     var flexibleColumn = this.get('flexibleColumn') ||
       this.get('columns').objectAt(this.get('columns').length - 1);
     var flexibleWidth = flexibleColumn.get('width') +
      (width - totalColumnWidth);
-     
-    flexibleColumn.set('width', flexibleWidth);    
+
+    flexibleColumn.set('width', flexibleWidth);
   }.observes('frame'),
-    
+
   // =============================================================
   // = This is all terrible, but will have to do in the interim. =
   // =============================================================
@@ -422,19 +426,19 @@ SC.TableView = SC.ListView.extend(SC.TableDelegate, {
     var sortKey = sortedColumn.get('key');
     this.set('orderBy', sortKey);
   },
-  
+
   _sctv_sortedColumnDidChange: function() {
     var columns = this.get('columns'),
         sortedColumn = this.get('sortedColumn'),
         column, idx;
-    
+
     for (idx = 0; idx < columns.get('length'); idx++) {
       column = columns.objectAt(idx);
       if (column !== sortedColumn) {
         column.set('sortState', null);
       }
     }
-    
+
     this.invokeOnce('_sctv_sortContent');
-  }.observes('sortedColumn')    
+  }.observes('sortedColumn')
 });

data/lib/frameworks/sproutcore/frameworks/table/views/table_head.js

@@ -8,14 +8,7 @@
 sc_require('views/table');
 sc_require('views/table_header');
 
-/** @class
 
-  The head of a `SC.TableView`. It's a special row of the table that holds
-  the column header cells.
-
-  @extends SC.View
-  @since SproutCore 1.1
-*/
 SC.TableHeadView = SC.View.extend({
 /** @scope SC.TableHeadView.prototype */