/**
* @class Ext.grid.feature.Feature
* @extends Ext.util.Observable
*
@@ -31,39 +48,39 @@ Ext.define('Ext.grid.feature.Feature', {
isFeature: true,
disabled: false,
- /**
+ /**
* @property {Boolean}
* Most features will expose additional events, some may not and will
* need to change this to false.
*/
hasFeatureEvent: true,
- /**
+ /**
* @property {String}
* Prefix to use when firing events on the view.
* For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick".
*/
eventPrefix: null,
- /**
+ /**
* @property {String}
* Selector used to determine when to fire the event with the eventPrefix.
*/
eventSelector: null,
- /**
+ /**
* @property {Ext.view.Table}
* Reference to the TableView.
*/
view: null,
- /**
+ /**
* @property {Ext.grid.Panel}
* Reference to the grid panel
*/
grid: null,
- /**
+ /**
* Most features will not modify the data returned to the view.
* This is limited to one feature that manipulates the data per grid view.
*/
@@ -73,21 +90,23 @@ Ext.define('Ext.grid.feature.Feature', {
return '';
},
- /**
+ /**
* Abstract method to be overriden when a feature should add additional
* arguments to its event signature. By default the event will fire:
* - view - The underlying Ext.view.Table
- * - featureTarget - The matched element by the defined {@link eventSelector}
+ * - featureTarget - The matched element by the defined {@link #eventSelector}
*
* The method must also return the eventName as the first index of the array
* to be passed to fireEvent.
+ * @template
*/
- getFireEventArgs: function(eventName, view, featureTarget) {
- return [eventName, view, featureTarget];
+ getFireEventArgs: function(eventName, view, featureTarget, e) {
+ return [eventName, view, featureTarget, e];
},
- /**
+ /**
* Approriate place to attach events to the view, selectionmodel, headerCt, etc
+ * @template
*/
attachEvents: function() {
@@ -97,19 +116,21 @@ Ext.define('Ext.grid.feature.Feature', {
return;
},
- /**
+ /**
* Allows a feature to mutate the metaRowTpl.
* The array received as a single argument can be manipulated to add things
* on the end/begining of a particular row.
+ * @template
*/
mutateMetaRowTpl: function(metaRowTplArray) {
},
- /**
+ /**
* Allows a feature to inject member methods into the metaRowTpl. This is
* important for embedding functionality which will become part of the proper
* row tpl.
+ * @template
*/
getMetaRowTplFragments: function() {
return {};
@@ -119,29 +140,32 @@ Ext.define('Ext.grid.feature.Feature', {
return {};
},
- /**
+ /**
* Provide additional data to the prepareData call within the grid view.
* @param {Object} data The data for this particular record.
* @param {Number} idx The row index for this record.
* @param {Ext.data.Model} record The record instance
* @param {Object} orig The original result from the prepareData call to massage.
+ * @template
*/
getAdditionalData: function(data, idx, record, orig) {
return {};
},
- /**
+ /**
* Enable a feature
*/
enable: function() {
this.disabled = false;
},
- /**
+ /**
* Disable a feature
*/
disable: function() {
this.disabled = true;
}
-});