This class encapsulates the user interface of an {@link Ext.grid.GridPanel}.
@@ -36,7 +42,7 @@ viewConfig: {
}
return 'x-grid3-row-collapsed';
}
-},
+},
* @param {Record} record The {@link Ext.data.Record} corresponding to the current row.
* @param {Number} index The row index.
@@ -57,10 +63,12 @@ viewConfig: {
* @method getRowClass
* @return {String} a CSS class name to add to the row.
*/
+
/**
* @cfg {Boolean} enableRowBody True to add a second TR element per row that can be used to provide a row body
* that spans beneath the data row. Use the {@link #getRowClass} method's rowParams config to customize the row body.
*/
+
/**
* @cfg {String} emptyText Default text (html tags are accepted) to display in the grid body when no rows
* are available (defaults to ''). This value will be used to update the {@link #mainBody}:
@@ -68,8 +76,9 @@ viewConfig: {
this.mainBody.update('<div class="x-grid-empty">' + this.emptyText + '</div>');
*/
+
/**
- * @cfg {Boolean} headersDisabled True to disable the grid column headers (defaults to false).
+ * @cfg {Boolean} headersDisabled True to disable the grid column headers (defaults to false).
* Use the {@link Ext.grid.ColumnModel ColumnModel} {@link Ext.grid.ColumnModel#menuDisabled menuDisabled}
* config to disable the menu for individual columns. While this config is true the
* following will be disabled:
@@ -77,6 +86,7 @@ viewConfig: {
*
the trigger to reveal the menu.
*
*/
+
/**
*
A customized implementation of a {@link Ext.dd.DragZone DragZone} which provides default implementations
* of the template methods of DragZone to enable dragging of the selected rows of a GridPanel.
@@ -88,27 +98,31 @@ viewConfig: {
* @property dragZone
* @type {Ext.grid.GridDragZone}
*/
+
/**
* @cfg {Boolean} deferEmptyText True to defer {@link #emptyText} being applied until the store's
* first load (defaults to true).
*/
deferEmptyText : true,
+
/**
* @cfg {Number} scrollOffset The amount of space to reserve for the vertical scrollbar
* (defaults to undefined). If an explicit value isn't specified, this will be automatically
* calculated.
*/
scrollOffset : undefined,
+
/**
* @cfg {Boolean} autoFill
* Defaults to false. Specify true to have the column widths re-proportioned
- * when the grid is initially rendered. The
+ * when the grid is initially rendered. The
* {@link Ext.grid.Column#width initially configured width} of each column will be adjusted
* to fit the grid width and prevent horizontal scrolling. If columns are later resized (manually
* or programmatically), the other columns in the grid will not be resized to fit the grid width.
* See {@link #forceFit} also.
*/
autoFill : false,
+
/**
* @cfg {Boolean} forceFit
* Defaults to false. Specify true to have the column widths re-proportioned
@@ -118,18 +132,22 @@ viewConfig: {
* to fit the grid width. See {@link #autoFill} also.
*/
forceFit : false,
+
/**
* @cfg {Array} sortClasses The CSS classes applied to a header when it is sorted. (defaults to ['sort-asc', 'sort-desc'])
*/
sortClasses : ['sort-asc', 'sort-desc'],
+
/**
* @cfg {String} sortAscText The text displayed in the 'Sort Ascending' menu item (defaults to 'Sort Ascending')
*/
sortAscText : 'Sort Ascending',
+
/**
* @cfg {String} sortDescText The text displayed in the 'Sort Descending' menu item (defaults to 'Sort Descending')
*/
sortDescText : 'Sort Descending',
+
/**
* @cfg {String} columnsText The text displayed in the 'Columns' menu item (defaults to 'Columns')
*/
@@ -166,7 +184,7 @@ viewConfig: {
* @cfg {Number} rowSelectorDepth The number of levels to search for rows in event delegation (defaults to 10)
*/
rowSelectorDepth : 10,
-
+
/**
* @cfg {Number} rowBodySelectorDepth The number of levels to search for row bodies in event delegation (defaults to 10)
*/
@@ -180,75 +198,75 @@ viewConfig: {
* @cfg {String} rowSelector The selector used to find rows internally (defaults to 'div.x-grid3-row')
*/
rowSelector : 'div.x-grid3-row',
-
+
/**
* @cfg {String} rowBodySelector The selector used to find row bodies internally (defaults to 'div.x-grid3-row')
*/
rowBodySelector : 'div.x-grid3-row-body',
-
+
// private
firstRowCls: 'x-grid3-row-first',
lastRowCls: 'x-grid3-row-last',
rowClsRe: /(?:^|\s+)x-grid3-row-(first|last|alt)(?:\s+|$)/g,
-
+
constructor : function(config){
Ext.apply(this, config);
- // These events are only used internally by the grid components
- this.addEvents(
- /**
- * @event beforerowremoved
- * Internal UI Event. Fired before a row is removed.
- * @param {Ext.grid.GridView} view
- * @param {Number} rowIndex The index of the row to be removed.
- * @param {Ext.data.Record} record The Record to be removed
- */
- 'beforerowremoved',
- /**
- * @event beforerowsinserted
- * Internal UI Event. Fired before rows are inserted.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the first row to be inserted.
- * @param {Number} lastRow The index of the last row to be inserted.
- */
- 'beforerowsinserted',
- /**
- * @event beforerefresh
- * Internal UI Event. Fired before the view is refreshed.
- * @param {Ext.grid.GridView} view
- */
- 'beforerefresh',
- /**
- * @event rowremoved
- * Internal UI Event. Fired after a row is removed.
- * @param {Ext.grid.GridView} view
- * @param {Number} rowIndex The index of the row that was removed.
- * @param {Ext.data.Record} record The Record that was removed
- */
- 'rowremoved',
- /**
- * @event rowsinserted
- * Internal UI Event. Fired after rows are inserted.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the first inserted.
- * @param {Number} lastRow The index of the last row inserted.
- */
- 'rowsinserted',
- /**
- * @event rowupdated
- * Internal UI Event. Fired after a row has been updated.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the row updated.
- * @param {Ext.data.record} record The Record backing the row updated.
- */
- 'rowupdated',
- /**
- * @event refresh
- * Internal UI Event. Fired after the GridView's body has been refreshed.
- * @param {Ext.grid.GridView} view
- */
- 'refresh'
- );
- Ext.grid.GridView.superclass.constructor.call(this);
+ // These events are only used internally by the grid components
+ this.addEvents(
+ /**
+ * @event beforerowremoved
+ * Internal UI Event. Fired before a row is removed.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} rowIndex The index of the row to be removed.
+ * @param {Ext.data.Record} record The Record to be removed
+ */
+ 'beforerowremoved',
+ /**
+ * @event beforerowsinserted
+ * Internal UI Event. Fired before rows are inserted.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} firstRow The index of the first row to be inserted.
+ * @param {Number} lastRow The index of the last row to be inserted.
+ */
+ 'beforerowsinserted',
+ /**
+ * @event beforerefresh
+ * Internal UI Event. Fired before the view is refreshed.
+ * @param {Ext.grid.GridView} view
+ */
+ 'beforerefresh',
+ /**
+ * @event rowremoved
+ * Internal UI Event. Fired after a row is removed.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} rowIndex The index of the row that was removed.
+ * @param {Ext.data.Record} record The Record that was removed
+ */
+ 'rowremoved',
+ /**
+ * @event rowsinserted
+ * Internal UI Event. Fired after rows are inserted.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} firstRow The index of the first inserted.
+ * @param {Number} lastRow The index of the last row inserted.
+ */
+ 'rowsinserted',
+ /**
+ * @event rowupdated
+ * Internal UI Event. Fired after a row has been updated.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} firstRow The index of the row updated.
+ * @param {Ext.data.record} record The Record backing the row updated.
+ */
+ 'rowupdated',
+ /**
+ * @event refresh
+ * Internal UI Event. Fired after the GridView's body has been refreshed.
+ * @param {Ext.grid.GridView} view
+ */
+ 'refresh'
+ );
+ Ext.grid.GridView.superclass.constructor.call(this);
},
/* -------------------------------- UI Specific ----------------------------- */
@@ -258,31 +276,31 @@ viewConfig: {
var ts = this.templates || {};
if(!ts.master){
ts.master = new Ext.Template(
- '