/ext-4.1.0_b3/docs/source/Action3.html

https://bitbucket.org/srogerf/javascript · HTML · 317 lines · 293 code · 24 blank · 0 comment · 0 complexity · d578135775ba7282720215a53aaaeb82 MD5 · raw file 

    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4.   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    5. 

  5.   <title>The source code</title>
    6. 

  6.   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
    7. 

  7.   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
    8. 

  8.   <style type="text/css">
    9. 

  9.     .highlight { display: block; background-color: #ddd; }
    10. 

  10.   </style>
    11. 

  11.   <script type="text/javascript">
    12. 

  12.     function highlight() {
    13. 

  13.       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
    14. 

  14.     }
    15. 

  15.   </script>
    16. 

  16. </head>
    17. 

  17. <body onload="prettyPrint(); highlight();">
    18. 

  18.   <pre class="prettyprint lang-js"><span id='Ext-grid-column-Action'>/**
    19. 

  19. </span> * A Grid header type which renders an icon, or a series of icons in a grid cell, and offers a scoped click
    20. 

  20.  * handler for each icon.
    21. 

  21.  *
    22. 

  22.  *     @example
    23. 

  23.  *     Ext.create('Ext.data.Store', {
    24. 

  24.  *         storeId:'employeeStore',
    25. 

  25.  *         fields:['firstname', 'lastname', 'senority', 'dep', 'hired'],
    26. 

  26.  *         data:[
    27. 

  27.  *             {firstname:&quot;Michael&quot;, lastname:&quot;Scott&quot;},
    28. 

  28.  *             {firstname:&quot;Dwight&quot;, lastname:&quot;Schrute&quot;},
    29. 

  29.  *             {firstname:&quot;Jim&quot;, lastname:&quot;Halpert&quot;},
    30. 

  30.  *             {firstname:&quot;Kevin&quot;, lastname:&quot;Malone&quot;},
    31. 

  31.  *             {firstname:&quot;Angela&quot;, lastname:&quot;Martin&quot;}
    32. 

  32.  *         ]
    33. 

  33.  *     });
    34. 

  34.  *
    35. 

  35.  *     Ext.create('Ext.grid.Panel', {
    36. 

  36.  *         title: 'Action Column Demo',
    37. 

  37.  *         store: Ext.data.StoreManager.lookup('employeeStore'),
    38. 

  38.  *         columns: [
    39. 

  39.  *             {text: 'First Name',  dataIndex:'firstname'},
    40. 

  40.  *             {text: 'Last Name',  dataIndex:'lastname'},
    41. 

  41.  *             {
    42. 

  42.  *                 xtype:'actioncolumn',
    43. 

  43.  *                 width:50,
    44. 

  44.  *                 items: [{
    45. 

  45.  *                     icon: 'extjs/examples/shared/icons/fam/cog_edit.png',  // Use a URL in the icon config
    46. 

  46.  *                     tooltip: 'Edit',
    47. 

  47.  *                     handler: function(grid, rowIndex, colIndex) {
    48. 

  48.  *                         var rec = grid.getStore().getAt(rowIndex);
    49. 

  49.  *                         alert(&quot;Edit &quot; + rec.get('firstname'));
    50. 

  50.  *                     }
    51. 

  51.  *                 },{
    52. 

  52.  *                     icon: 'extjs/examples/restful/images/delete.png',
    53. 

  53.  *                     tooltip: 'Delete',
    54. 

  54.  *                     handler: function(grid, rowIndex, colIndex) {
    55. 

  55.  *                         var rec = grid.getStore().getAt(rowIndex);
    56. 

  56.  *                         alert(&quot;Terminate &quot; + rec.get('firstname'));
    57. 

  57.  *                     }
    58. 

  58.  *                 }]
    59. 

  59.  *             }
    60. 

  60.  *         ],
    61. 

  61.  *         width: 250,
    62. 

  62.  *         renderTo: Ext.getBody()
    63. 

  63.  *     });
    64. 

  64.  *
    65. 

  65.  * The action column can be at any index in the columns array, and a grid can have any number of
    66. 

  66.  * action columns.
    67. 

  67.  */
    68. 

  68. Ext.define('Ext.grid.column.Action', {
    69. 

  69.     extend: 'Ext.grid.column.Column',
    70. 

  70.     alias: ['widget.actioncolumn'],
    71. 

  71.     alternateClassName: 'Ext.grid.ActionColumn',
    72. 

  72. 

  73. <span id='Ext-grid-column-Action-cfg-icon'>    /**
    74. 

  74. </span>     * @cfg {String} icon
    75. 

  75.      * The URL of an image to display as the clickable element in the column.
    76. 

  76.      *
    77. 

  77.      * Defaults to `{@link Ext#BLANK_IMAGE_URL}`.
    78. 

  78.      */
    79. 

  79. <span id='Ext-grid-column-Action-cfg-iconCls'>    /**
    80. 

  80. </span>     * @cfg {String} iconCls
    81. 

  81.      * A CSS class to apply to the icon image. To determine the class dynamically, configure the Column with
    82. 

  82.      * a `{@link #getClass}` function.
    83. 

  83.      */
    84. 

  84. <span id='Ext-grid-column-Action-cfg-handler'>    /**
    85. 

  85. </span>     * @cfg {Function} handler
    86. 

  86.      * A function called when the icon is clicked.
    87. 

  87.      * @cfg {Ext.view.Table} handler.view The owning TableView.
    88. 

  88.      * @cfg {Number} handler.rowIndex The row index clicked on.
    89. 

  89.      * @cfg {Number} handler.colIndex The column index clicked on.
    90. 

  90.      * @cfg {Object} handler.item The clicked item (or this Column if multiple {@link #cfg-items} were not configured).
    91. 

  91.      * @cfg {Event} handler.e The click event.
    92. 

  92.      */
    93. 

  93. <span id='Ext-grid-column-Action-cfg-scope'>    /**
    94. 

  94. </span>     * @cfg {Object} scope
    95. 

  95.      * The scope (**this** reference) in which the `{@link #handler}` and `{@link #getClass}` fuctions are executed.
    96. 

  96.      * Defaults to this Column.
    97. 

  97.      */
    98. 

  98. <span id='Ext-grid-column-Action-cfg-tooltip'>    /**
    99. 

  99. </span>     * @cfg {String} tooltip
    100. 

  100.      * A tooltip message to be displayed on hover. {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must
    101. 

  101.      * have been initialized.
    102. 

  102.      */
    103. 

  103. <span id='Ext-grid-column-Action-cfg-disabled'>    /**
    104. 

  104. </span>     * @cfg {Boolean} disabled
    105. 

  105.      * If true, the action will not respond to click events, and will be displayed semi-opaque.
    106. 

  106.      */
    107. 

  107. <span id='Ext-grid-column-Action-cfg-stopSelection'>    /**
    108. 

  108. </span>     * @cfg {Boolean} [stopSelection=true]
    109. 

  109.      * Prevent grid _row_ selection upon mousedown.
    110. 

  110.      */
    111. 

  111. <span id='Ext-grid-column-Action-cfg-getClass'>    /**
    112. 

  112. </span>     * @cfg {Function} getClass
    113. 

  113.      * A function which returns the CSS class to apply to the icon image.
    114. 

  114.      *
    115. 

  115.      * @cfg {Object} getClass.v The value of the column's configured field (if any).
    116. 

  116.      *
    117. 

  117.      * @cfg {Object} getClass.metadata An object in which you may set the following attributes:
    118. 

  118.      * @cfg {String} getClass.metadata.css A CSS class name to add to the cell's TD element.
    119. 

  119.      * @cfg {String} getClass.metadata.attr An HTML attribute definition string to apply to the data container
    120. 

  120.      * element *within* the table cell (e.g. 'style=&quot;color:red;&quot;').
    121. 

  121.      *
    122. 

  122.      * @cfg {Ext.data.Model} getClass.r The Record providing the data.
    123. 

  123.      *
    124. 

  124.      * @cfg {Number} getClass.rowIndex The row index..
    125. 

  125.      *
    126. 

  126.      * @cfg {Number} getClass.colIndex The column index.
    127. 

  127.      *
    128. 

  128.      * @cfg {Ext.data.Store} getClass.store The Store which is providing the data Model.
    129. 

  129.      */
    130. 

  130. <span id='Ext-grid-column-Action-cfg-items'>    /**
    131. 

  131. </span>     * @cfg {Object[]} items
    132. 

  132.      * An Array which may contain multiple icon definitions, each element of which may contain:
    133. 

  133.      *
    134. 

  134.      * @cfg {String} items.icon The url of an image to display as the clickable element in the column.
    135. 

  135.      *
    136. 

  136.      * @cfg {String} items.iconCls A CSS class to apply to the icon image. To determine the class dynamically,
    137. 

  137.      * configure the item with a `getClass` function.
    138. 

  138.      *
    139. 

  139.      * @cfg {Function} items.getClass A function which returns the CSS class to apply to the icon image.
    140. 

  140.      * @cfg {Object} items.getClass.v The value of the column's configured field (if any).
    141. 

  141.      * @cfg {Object} items.getClass.metadata An object in which you may set the following attributes:
    142. 

  142.      * @cfg {String} items.getClass.metadata.css A CSS class name to add to the cell's TD element.
    143. 

  143.      * @cfg {String} items.getClass.metadata.attr An HTML attribute definition string to apply to the data
    144. 

  144.      * container element _within_ the table cell (e.g. 'style=&quot;color:red;&quot;').
    145. 

  145.      * @cfg {Ext.data.Model} items.getClass.r The Record providing the data.
    146. 

  146.      * @cfg {Number} items.getClass.rowIndex The row index..
    147. 

  147.      * @cfg {Number} items.getClass.colIndex The column index.
    148. 

  148.      * @cfg {Ext.data.Store} items.getClass.store The Store which is providing the data Model.
    149. 

  149.      *
    150. 

  150.      * @cfg {Function} items.handler A function called when the icon is clicked.
    151. 

  151.      *
    152. 

  152.      * @cfg {Object} items.scope The scope (`this` reference) in which the `handler` and `getClass` functions
    153. 

  153.      * are executed. Fallback defaults are this Column's configured scope, then this Column.
    154. 

  154.      *
    155. 

  155.      * @cfg {String} items.tooltip A tooltip message to be displayed on hover.
    156. 

  156.      * @cfg {Boolean} items.disabled If true, the action will not respond to click events, and will be displayed semi-opaque.
    157. 

  157.      * {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must have been initialized.
    158. 

  158.      */
    159. 

  159. <span id='Ext-grid-column-Action-property-items'>    /**
    160. 

  160. </span>     * @property {Array} items
    161. 

  161.      * An array of action items copied from the configured {@link #cfg-items items} configuration. Each will have
    162. 

  162.      * an `enable` and `disable` method added which will enable and disable the associated action, and
    163. 

  163.      * update the displayed icon accordingly.
    164. 

  164.      */
    165. 

  165. 

  166.     actionIdRe: new RegExp(Ext.baseCSSPrefix + 'action-col-(\\d+)'),
    167. 

  167. 

  168. <span id='Ext-grid-column-Action-cfg-altText'>    /**
    169. 

  169. </span>     * @cfg {String} altText
    170. 

  170.      * The alt text to use for the image element.
    171. 

  171.      */
    172. 

  172.     altText: '',
    173. 

  173. 

  174.     sortable: false,
    175. 

  175. 

  176.     constructor: function(config) {
    177. 

  177.         var me = this,
    178. 

  178.             cfg = Ext.apply({}, config),
    179. 

  179.             items = cfg.items || [me];
    180. 

  180. 

  181. 

  182.         me.origRenderer = cfg.renderer || me.renderer;
    183. 

  183.         me.origScope = cfg.scope || me.scope;
    184. 

  184.         
    185. 

  185.         delete me.renderer;
    186. 

  186.         delete me.scope;
    187. 

  187.         delete cfg.renderer;
    188. 

  188.         delete cfg.scope;
    189. 

  189.         
    190. 

  190.         // This is a Container. Delete the items config to be reinstated after construction.
    191. 

  191.         delete cfg.items;
    192. 

  192.         me.callParent([cfg]);
    193. 

  193. 

  194.         // Items is an array property of ActionColumns
    195. 

  195.         me.items = items;
    196. 

  196.         
    197. 

  197.         if (me.origRenderer) {
    198. 

  198.             me.hasCustomRenderer = true;
    199. 

  199.         }
    200. 

  200.     },
    201. 

  201.     
    202. 

  202.     // Renderer closure iterates through items creating an &lt;img&gt; element for each and tagging with an identifying
    203. 

  203.     // class name x-action-col-{n}
    204. 

  204.     defaultRenderer: function(v, meta){
    205. 

  205.         var me = this,
    206. 

  206.             prefix = Ext.baseCSSPrefix,
    207. 

  207.             scope = me.origScope || me,
    208. 

  208.             items = me.items,
    209. 

  209.             len = items.length,
    210. 

  210.             i = 0,
    211. 

  211.             item;
    212. 

  212.             
    213. 

  213.         // Allow a configured renderer to create initial value (And set the other values in the &quot;metadata&quot; argument!)
    214. 

  214.         v = Ext.isFunction(me.origRenderer) ? me.origRenderer.apply(scope, arguments) || '' : '';
    215. 

  215. 

  216.         meta.tdCls += ' ' + Ext.baseCSSPrefix + 'action-col-cell';
    217. 

  217.         for (; i &lt; len; i++) {
    218. 

  218.             item = items[i];
    219. 

  219.             if (!item.hasActionConfiguration) {
    220. 

  220.                 item.disable = Ext.Function.bind(me.disableAction, me, [i], 0);
    221. 

  221.                 item.enable = Ext.Function.bind(me.enableAction, me, [i], 0);
    222. 

  222.                 item.hasActionConfiguration = true;
    223. 

  223.             }
    224. 

  224.             
    225. 

  225.             v += '&lt;img alt=&quot;' + (item.altText || me.altText) + '&quot; src=&quot;' + (item.icon || Ext.BLANK_IMAGE_URL) +
    226. 

  226.                 '&quot; class=&quot;' + prefix + 'action-col-icon ' + prefix + 'action-col-' + String(i) + ' ' + (item.disabled ? prefix + 'item-disabled' : ' ') +
    227. 

  227.                 ' ' + (Ext.isFunction(item.getClass) ? item.getClass.apply(item.scope || scope, arguments) : (item.iconCls || me.iconCls || '')) + '&quot;' +
    228. 

  228.                 ((item.tooltip) ? ' data-qtip=&quot;' + item.tooltip + '&quot;' : '') + ' /&gt;';
    229. 

  229.         }
    230. 

  230.         return v;    
    231. 

  231.     },
    232. 

  232. 

  233. <span id='Ext-grid-column-Action-method-enableAction'>    /**
    234. 

  234. </span>     * Enables this ActionColumn's action at the specified index.
    235. 

  235.      * @param {Number/Ext.grid.column.Action} index
    236. 

  236.      * @param {Boolean} [silent=false]
    237. 

  237.      */
    238. 

  238.     enableAction: function(index, silent) {
    239. 

  239.         var me = this;
    240. 

  240. 

  241.         if (!index) {
    242. 

  242.             index = 0;
    243. 

  243.         } else if (!Ext.isNumber(index)) {
    244. 

  244.             index = Ext.Array.indexOf(me.items, index);
    245. 

  245.         }
    246. 

  246.         me.items[index].disabled = false;
    247. 

  247.         me.up('tablepanel').el.select('.' + Ext.baseCSSPrefix + 'action-col-' + index).removeCls(me.disabledCls);
    248. 

  248.         if (!silent) {
    249. 

  249.             me.fireEvent('enable', me);
    250. 

  250.         }
    251. 

  251.     },
    252. 

  252. 

  253. <span id='Ext-grid-column-Action-method-disableAction'>    /**
    254. 

  254. </span>     * Disables this ActionColumn's action at the specified index.
    255. 

  255.      * @param {Number/Ext.grid.column.Action} index
    256. 

  256.      * @param {Boolean} [silent=false]
    257. 

  257.      */
    258. 

  258.     disableAction: function(index, silent) {
    259. 

  259.         var me = this;
    260. 

  260. 

  261.         if (!index) {
    262. 

  262.             index = 0;
    263. 

  263.         } else if (!Ext.isNumber(index)) {
    264. 

  264.             index = Ext.Array.indexOf(me.items, index);
    265. 

  265.         }
    266. 

  266.         me.items[index].disabled = true;
    267. 

  267.         me.up('tablepanel').el.select('.' + Ext.baseCSSPrefix + 'action-col-' + index).addCls(me.disabledCls);
    268. 

  268.         if (!silent) {
    269. 

  269.             me.fireEvent('disable', me);
    270. 

  270.         }
    271. 

  271.     },
    272. 

  272. 

  273.     destroy: function() {
    274. 

  274.         delete this.items;
    275. 

  275.         delete this.renderer;
    276. 

  276.         return this.callParent(arguments);
    277. 

  277.     },
    278. 

  278. 

  279. <span id='Ext-grid-column-Action-method-processEvent'>    /**
    280. 

  280. </span>     * @private
    281. 

  281.      * Process and refire events routed from the GridView's processEvent method.
    282. 

  282.      * Also fires any configured click handlers. By default, cancels the mousedown event to prevent selection.
    283. 

  283.      * Returns the event handler's status to allow canceling of GridView's bubbling process.
    284. 

  284.      */
    285. 

  285.     processEvent : function(type, view, cell, recordIndex, cellIndex, e, record, row){
    286. 

  286.         var me = this,
    287. 

  287.             match = e.getTarget().className.match(me.actionIdRe),
    288. 

  288.             item, fn;
    289. 

  289.             
    290. 

  290.         if (match) {
    291. 

  291.             item = me.items[parseInt(match[1], 10)];
    292. 

  292.             if (item) {
    293. 

  293.                 if (type == 'click') {
    294. 

  294.                     fn = item.handler || me.handler;
    295. 

  295.                     if (fn &amp;&amp; !item.disabled) {
    296. 

  296.                         fn.call(item.scope || me.scope || me, view, recordIndex, cellIndex, item, e, record, row);
    297. 

  297.                     }
    298. 

  298.                 } else if (type == 'mousedown' &amp;&amp; item.stopSelection !== false) {
    299. 

  299.                     return false;
    300. 

  300.                 }
    301. 

  301.             }
    302. 

  302.         }
    303. 

  303.         return me.callParent(arguments);
    304. 

  304.     },
    305. 

  305. 

  306.     cascade: function(fn, scope) {
    307. 

  307.         fn.call(scope||this, this);
    308. 

  308.     },
    309. 

  309. 

  310.     // Private override because this cannot function as a Container, and it has an items property which is an Array, NOT a MixedCollection.
    311. 

  311.     getRefItems: function() {
    312. 

  312.         return [];
    313. 

  313.     }
    314. 

  314. });
    315. 

  315. </pre>
    316. 

  316. </body>
    317. 

  317. </html>
    318.