2 "name" : "Roo.grid.ColumnModel",
9 "desc" : "This is the default implementation of a ColumnModel used by the Grid. It defines\nthe columns in the grid.\n<br>Usage:<br>\n <pre><code>\n var colModel = new Roo.grid.ColumnModel([\n\t{header: \"Ticker\", width: 60, sortable: true, locked: true},\n\t{header: \"Company Name\", width: 150, sortable: true},\n\t{header: \"Market Cap.\", width: 100, sortable: true},\n\t{header: \"$ Sales\", width: 100, sortable: true, renderer: money},\n\t{header: \"Employees\", width: 100, sortable: true, resizable: false}\n ]);\n </code></pre>\n<p>\nThe config options listed for this class are options which may appear in each\nindividual column definition.\n<br/>RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts.",
10 "isSingleton" : false,
14 "isBuilderTop" : false,
15 "memberOf" : "ColumnModel",
24 "desc" : "An Array of column config objects. See this class's\nconfig objects for details.",
35 "desc" : "Header at Bootsrap Medium width",
40 "type" : "Roo.grid.GridEditor",
41 "desc" : "(Optional) For grid editors - returns the grid editor",
47 "desc" : "(Optional)",
53 "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
54 "memberOf" : "Roo.util.Observable"
59 "desc" : "Header at Bootsrap Small width",
65 "desc" : "(Optional)",
71 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
77 "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
83 "desc" : "Header at Bootsrap Large width",
89 "desc" : "Header at Bootsrap extra Large width",
95 "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
101 "desc" : "(Optional) True to hide the column. Defaults to false.",
107 "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
113 "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
119 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
125 "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
131 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
137 "desc" : "Header at Bootsrap Extra Small width (default for all)",
143 "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
149 "desc" : "The header text to display in the Grid view.",
155 "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
159 "name" : "resizable",
161 "desc" : "(Optional) False to disable column resizing. Defaults to true.",
167 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
171 "name" : "dataIndex",
173 "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
179 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
185 "name" : "setRenderer",
187 "desc" : "Sets the rendering (formatting) function for a column.",
192 "isConstructor" : false,
204 "desc" : "The column index",
210 "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
219 "desc" : "Returns true if the column is hidden.",
220 "sig" : "(colIndex)",
224 "isConstructor" : false,
236 "desc" : "The column index",
249 "name" : "setColumnHeader",
251 "desc" : "Sets the header for a column.",
252 "sig" : "(col, header)",
256 "isConstructor" : false,
268 "desc" : "The column index",
274 "desc" : "The new header",
281 "name" : "getColumnCount",
283 "desc" : "Returns the number of columns.",
284 "sig" : "()\n{\n\n}",
288 "isConstructor" : false,
306 "name" : "addColumn",
308 "desc" : "Add a column (experimental...) - defaults to adding to the end..",
313 "isConstructor" : false,
332 "name" : "getColumnHeader",
334 "desc" : "Returns the header for the specified column.",
339 "isConstructor" : false,
351 "desc" : "The column index",
364 "name" : "getRenderer",
366 "desc" : "Returns the rendering (formatting) function defined for the column.",
371 "isConstructor" : false,
383 "desc" : "The column index.",
391 "desc" : "The function used to render the cell. See {@link #setRenderer}."
396 "name" : "getColumnTooltip",
398 "desc" : "Returns the tooltip for the specified column.",
403 "isConstructor" : false,
415 "desc" : "The column index",
428 "name" : "setColumnWidth",
430 "desc" : "Sets the width for a column.",
431 "sig" : "(col, width)",
435 "isConstructor" : false,
447 "desc" : "The column index",
453 "desc" : "The new width",
460 "name" : "setDataIndex",
462 "desc" : "Sets the dataIndex for a column.",
463 "sig" : "(col, dataIndex)",
467 "isConstructor" : false,
479 "desc" : "The column index",
483 "name" : "dataIndex",
485 "desc" : "The new dataIndex",
492 "name" : "isCellEditable",
494 "desc" : "Returns true if the cell is editable.",
495 "sig" : "(colIndex, rowIndex)",
499 "isConstructor" : false,
511 "desc" : "The column index",
517 "desc" : "The row index - this is nto actually used..?",
530 "name" : "getColumnsBy",
532 "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
533 "sig" : "(fn, scope)",
537 "isConstructor" : false,
555 "desc" : "(optional)",
568 "name" : "getColumnWidth",
570 "desc" : "Returns the width for the specified column.",
571 "sig" : "(col, (optional))",
575 "isConstructor" : false,
587 "desc" : "The column index",
591 "name" : "(optional)",
593 "desc" : "{String} gridSize bootstrap width size.",
608 "desc" : "Returns true if the column width cannot be changed",
609 "sig" : "()\n{\n\n}",
613 "isConstructor" : false,
625 "name" : "getCellEditor",
627 "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
628 "sig" : "(colIndex, rowIndex)",
632 "isConstructor" : false,
644 "desc" : "The column index",
650 "desc" : "The row index",
663 "name" : "getColumnId",
665 "desc" : "Returns the id of the column at the specified index.",
670 "isConstructor" : false,
682 "desc" : "The column index",
695 "name" : "getDataIndex",
697 "desc" : "Returns the dataIndex for the specified column.",
702 "isConstructor" : false,
714 "desc" : "The column index",
727 "name" : "isResizable",
729 "desc" : "Returns true if the column can be resized",
730 "sig" : "()\n{\n\n}",
734 "isConstructor" : false,
752 "name" : "setColumnTooltip",
754 "desc" : "Sets the tooltip for a column.",
755 "sig" : "(col, tooltip)",
759 "isConstructor" : false,
771 "desc" : "The column index",
777 "desc" : "The new tooltip",
784 "name" : "setHidden",
786 "desc" : "Sets if a column is hidden.",
787 "sig" : "(colIndex, hidden)",
791 "isConstructor" : false,
803 "desc" : "The column index",
809 "desc" : "True if the column is hidden",
816 "name" : "setEditable",
818 "desc" : "Sets if a column is editable.",
819 "sig" : "(col, editable)",
823 "isConstructor" : false,
835 "desc" : "The column index",
841 "desc" : "True if the column is editable",
848 "name" : "getColumnById",
850 "desc" : "Returns the column for a specified id.",
855 "isConstructor" : false,
867 "desc" : "The column id",
875 "desc" : "the column"
880 "name" : "getColumnByDataIndex",
882 "desc" : "Returns the column Object for a specified dataIndex.",
883 "sig" : "(dataIndex)",
887 "isConstructor" : false,
897 "name" : "dataIndex",
899 "desc" : "The column dataIndex",
906 "type" : "Object|Boolean",
907 "desc" : "the column or false if not found"
912 "name" : "setEditor",
914 "desc" : "Sets the editor for a column.",
915 "sig" : "(col, editor)",
919 "isConstructor" : false,
931 "desc" : "The column index",
937 "desc" : "The editor object",
944 "name" : "findColumnIndex",
946 "desc" : "Returns the index for a specified column dataIndex.",
947 "sig" : "(dataIndex)",
951 "isConstructor" : false,
961 "name" : "dataIndex",
963 "desc" : "The column dataIndex",
971 "desc" : "the index, or -1 if not found"
976 "name" : "isSortable",
978 "desc" : "Returns true if the specified column is sortable.",
983 "isConstructor" : false,
995 "desc" : "The column index",
1008 "name" : "getIndexById",
1009 "type" : "function",
1010 "desc" : "Returns the index for a specified column id.",
1015 "isConstructor" : false,
1016 "isPrivate" : false,
1027 "desc" : "The column id",
1028 "isOptional" : false
1035 "desc" : "the index, or -1 if not found"
1040 "name" : "getTotalWidth",
1041 "type" : "function",
1042 "desc" : "Returns the total width of all columns.",
1043 "sig" : "(includeHidden)",
1047 "isConstructor" : false,
1048 "isPrivate" : false,
1057 "name" : "includeHidden",
1059 "desc" : "True to include hidden column widths",
1060 "isOptional" : false
1072 "name" : "purgeListeners",
1073 "type" : "function",
1074 "desc" : "Removes all listeners for this object",
1075 "sig" : "()\n{\n\n}",
1077 "memberOf" : "Roo.util.Observable",
1079 "isConstructor" : false,
1080 "isPrivate" : false,
1092 "type" : "function",
1093 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1094 "sig" : "(eventName, handler, scope, options)",
1096 "memberOf" : "Roo.util.Observable",
1098 "isConstructor" : false,
1099 "isPrivate" : false,
1108 "name" : "eventName",
1110 "desc" : "The type of event to listen for",
1111 "isOptional" : false
1115 "type" : "Function",
1116 "desc" : "The method the event invokes",
1117 "isOptional" : false
1122 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1123 "isOptional" : false
1128 "desc" : "(optional)",
1129 "isOptional" : false
1136 "type" : "function",
1137 "desc" : "Removes a listener (shorthand for removeListener)",
1138 "sig" : "(eventName, handler, scope)",
1140 "memberOf" : "Roo.util.Observable",
1142 "isConstructor" : false,
1143 "isPrivate" : false,
1152 "name" : "eventName",
1154 "desc" : "The type of event to listen for",
1155 "isOptional" : false
1159 "type" : "Function",
1160 "desc" : "The handler to remove",
1161 "isOptional" : false
1166 "desc" : "(optional) The scope (this object) for the handler",
1167 "isOptional" : false
1173 "name" : "addEvents",
1174 "type" : "function",
1175 "desc" : "Used to define events on this Observable",
1178 "memberOf" : "Roo.util.Observable",
1180 "isConstructor" : false,
1181 "isPrivate" : false,
1192 "desc" : "The object with the events defined",
1193 "isOptional" : false
1199 "name" : "releaseCapture",
1200 "type" : "function",
1201 "desc" : "Removes <b>all</b> added captures from the Observable.",
1204 "memberOf" : "Roo.util.Observable",
1206 "isConstructor" : false,
1207 "isPrivate" : false,
1217 "type" : "Observable",
1218 "desc" : "The Observable to release",
1219 "isOptional" : false
1225 "name" : "removeListener",
1226 "type" : "function",
1227 "desc" : "Removes a listener",
1228 "sig" : "(eventName, handler, scope)",
1230 "memberOf" : "Roo.util.Observable",
1232 "isConstructor" : false,
1233 "isPrivate" : false,
1242 "name" : "eventName",
1244 "desc" : "The type of event to listen for",
1245 "isOptional" : false
1249 "type" : "Function",
1250 "desc" : "The handler to remove",
1251 "isOptional" : false
1256 "desc" : "(optional) The scope (this object) for the handler",
1257 "isOptional" : false
1263 "name" : "fireEvent",
1264 "type" : "function",
1265 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1266 "sig" : "(eventName, args)",
1268 "memberOf" : "Roo.util.Observable",
1270 "isConstructor" : false,
1271 "isPrivate" : false,
1280 "name" : "eventName",
1283 "isOptional" : false
1287 "type" : "Object...",
1288 "desc" : "Variable number of parameters are passed to handlers",
1289 "isOptional" : false
1296 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1301 "name" : "hasListener",
1302 "type" : "function",
1303 "desc" : "Checks to see if this object has any listeners for a specified event",
1304 "sig" : "(eventName)",
1306 "memberOf" : "Roo.util.Observable",
1308 "isConstructor" : false,
1309 "isPrivate" : false,
1318 "name" : "eventName",
1320 "desc" : "The name of the event to check for",
1321 "isOptional" : false
1328 "desc" : "True if the event is being listened for, else false"
1334 "type" : "function",
1335 "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
1336 "sig" : "(o, fn, scope)",
1338 "memberOf" : "Roo.util.Observable",
1340 "isConstructor" : false,
1341 "isPrivate" : false,
1351 "type" : "Observable",
1352 "desc" : "The Observable to capture",
1353 "isOptional" : false
1357 "type" : "Function",
1358 "desc" : "The function to call",
1359 "isOptional" : false
1364 "desc" : "(optional) The scope (this object) for the fn",
1365 "isOptional" : false
1371 "name" : "addListener",
1372 "type" : "function",
1373 "desc" : "Appends an event handler to this component",
1374 "sig" : "(eventName, handler, scope, options)",
1376 "memberOf" : "Roo.util.Observable",
1378 "isConstructor" : false,
1379 "isPrivate" : false,
1388 "name" : "eventName",
1390 "desc" : "The type of event to listen for",
1391 "isOptional" : false
1395 "type" : "Function",
1396 "desc" : "The method the event invokes",
1397 "isOptional" : false
1402 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1403 "isOptional" : false
1408 "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
1409 "isOptional" : false
1417 "name" : "hiddenchange",
1418 "type" : "function",
1419 "desc" : "Fires when a column is hidden or \"unhidden\".",
1420 "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
1429 "type" : "ColumnModel",
1431 "isOptional" : false
1434 "name" : "columnIndex",
1436 "desc" : "The column index",
1437 "isOptional" : false
1442 "desc" : "true if hidden, false otherwise",
1443 "isOptional" : false
1449 "name" : "headerchange",
1450 "type" : "function",
1451 "desc" : "Fires when the text of a header changes.",
1452 "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
1461 "type" : "ColumnModel",
1463 "isOptional" : false
1466 "name" : "columnIndex",
1468 "desc" : "The column index",
1469 "isOptional" : false
1474 "desc" : "The new header text",
1475 "isOptional" : false
1481 "name" : "columlockchange",
1482 "type" : "function",
1483 "desc" : "Fires when a column's locked state is changed",
1484 "sig" : "function (_self, colIndex, locked)\n{\n\n}",
1493 "type" : "ColumnModel",
1495 "isOptional" : false
1498 "name" : "colIndex",
1501 "isOptional" : false
1506 "desc" : "true if locked",
1507 "isOptional" : false
1513 "name" : "columnmoved",
1514 "type" : "function",
1515 "desc" : "Fires when a column is moved.",
1516 "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
1525 "type" : "ColumnModel",
1527 "isOptional" : false
1530 "name" : "oldIndex",
1533 "isOptional" : false
1536 "name" : "newIndex",
1539 "isOptional" : false
1545 "name" : "widthchange",
1546 "type" : "function",
1547 "desc" : "Fires when the width of a column changes.",
1548 "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
1557 "type" : "ColumnModel",
1559 "isOptional" : false
1562 "name" : "columnIndex",
1564 "desc" : "The column index",
1565 "isOptional" : false
1568 "name" : "newWidth",
1570 "desc" : "The new width",
1571 "isOptional" : false