2 "name" : "Roo.grid.ColumnModel",
7 "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.",
11 "memberOf" : "ColumnModel",
20 "desc" : "An Array of column config objects. See this class's\nconfig objects for details.",
31 "desc" : "Header at Bootsrap Medium width",
36 "type" : "Roo.grid.GridEditor",
37 "desc" : "(Optional) For grid editors - returns the grid editor",
43 "desc" : "(Optional)",
49 "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>",
50 "memberOf" : "Roo.util.Observable"
55 "desc" : "Header at Bootsrap Small width",
61 "desc" : "(Optional)",
67 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
73 "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
79 "desc" : "Header at Bootsrap Large width",
85 "desc" : "Header at Bootsrap extra Large width",
91 "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
97 "desc" : "(Optional) True to hide the column. Defaults to false.",
103 "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
109 "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
115 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
121 "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",
127 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
133 "desc" : "Header at Bootsrap Extra Small width (default for all)",
139 "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}.",
145 "desc" : "The header text to display in the Grid view.",
151 "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
155 "name" : "resizable",
157 "desc" : "(Optional) False to disable column resizing. Defaults to true.",
163 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
167 "name" : "dataIndex",
169 "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.",
175 "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
181 "name" : "setRenderer",
183 "desc" : "Sets the rendering (formatting) function for a column.",
188 "isConstructor" : false,
200 "desc" : "The column index",
206 "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>",
215 "desc" : "Returns true if the column is hidden.",
216 "sig" : "(colIndex)",
220 "isConstructor" : false,
232 "desc" : "The column index",
245 "name" : "setColumnHeader",
247 "desc" : "Sets the header for a column.",
248 "sig" : "(col, header)",
252 "isConstructor" : false,
264 "desc" : "The column index",
270 "desc" : "The new header",
277 "name" : "getColumnCount",
279 "desc" : "Returns the number of columns.",
280 "sig" : "()\n{\n\n}",
284 "isConstructor" : false,
302 "name" : "addColumn",
304 "desc" : "Add a column (experimental...) - defaults to adding to the end..",
309 "isConstructor" : false,
328 "name" : "getColumnHeader",
330 "desc" : "Returns the header for the specified column.",
335 "isConstructor" : false,
347 "desc" : "The column index",
360 "name" : "getRenderer",
362 "desc" : "Returns the rendering (formatting) function defined for the column.",
367 "isConstructor" : false,
379 "desc" : "The column index.",
387 "desc" : "The function used to render the cell. See {@link #setRenderer}."
392 "name" : "getColumnTooltip",
394 "desc" : "Returns the tooltip for the specified column.",
399 "isConstructor" : false,
411 "desc" : "The column index",
424 "name" : "setColumnWidth",
426 "desc" : "Sets the width for a column.",
427 "sig" : "(col, width)",
431 "isConstructor" : false,
443 "desc" : "The column index",
449 "desc" : "The new width",
456 "name" : "setDataIndex",
458 "desc" : "Sets the dataIndex for a column.",
459 "sig" : "(col, dataIndex)",
463 "isConstructor" : false,
475 "desc" : "The column index",
479 "name" : "dataIndex",
481 "desc" : "The new dataIndex",
488 "name" : "isCellEditable",
490 "desc" : "Returns true if the cell is editable.",
491 "sig" : "(colIndex, rowIndex)",
495 "isConstructor" : false,
507 "desc" : "The column index",
513 "desc" : "The row index - this is nto actually used..?",
526 "name" : "getColumnsBy",
528 "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
529 "sig" : "(fn, scope)",
533 "isConstructor" : false,
551 "desc" : "(optional)",
564 "name" : "getColumnWidth",
566 "desc" : "Returns the width for the specified column.",
567 "sig" : "(col, (optional))",
571 "isConstructor" : false,
583 "desc" : "The column index",
587 "name" : "(optional)",
589 "desc" : "{String} gridSize bootstrap width size.",
604 "desc" : "Returns true if the column width cannot be changed",
605 "sig" : "()\n{\n\n}",
609 "isConstructor" : false,
621 "name" : "getCellEditor",
623 "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
624 "sig" : "(colIndex, rowIndex)",
628 "isConstructor" : false,
640 "desc" : "The column index",
646 "desc" : "The row index",
659 "name" : "getColumnId",
661 "desc" : "Returns the id of the column at the specified index.",
666 "isConstructor" : false,
678 "desc" : "The column index",
691 "name" : "getDataIndex",
693 "desc" : "Returns the dataIndex for the specified column.",
698 "isConstructor" : false,
710 "desc" : "The column index",
723 "name" : "isResizable",
725 "desc" : "Returns true if the column can be resized",
726 "sig" : "()\n{\n\n}",
730 "isConstructor" : false,
748 "name" : "setColumnTooltip",
750 "desc" : "Sets the tooltip for a column.",
751 "sig" : "(col, tooltip)",
755 "isConstructor" : false,
767 "desc" : "The column index",
773 "desc" : "The new tooltip",
780 "name" : "setHidden",
782 "desc" : "Sets if a column is hidden.",
783 "sig" : "(colIndex, hidden)",
787 "isConstructor" : false,
799 "desc" : "The column index",
805 "desc" : "True if the column is hidden",
812 "name" : "setEditable",
814 "desc" : "Sets if a column is editable.",
815 "sig" : "(col, editable)",
819 "isConstructor" : false,
831 "desc" : "The column index",
837 "desc" : "True if the column is editable",
844 "name" : "getColumnById",
846 "desc" : "Returns the column for a specified id.",
851 "isConstructor" : false,
863 "desc" : "The column id",
871 "desc" : "the column"
876 "name" : "getColumnByDataIndex",
878 "desc" : "Returns the column Object for a specified dataIndex.",
879 "sig" : "(dataIndex)",
883 "isConstructor" : false,
893 "name" : "dataIndex",
895 "desc" : "The column dataIndex",
902 "type" : "Object|Boolean",
903 "desc" : "the column or false if not found"
908 "name" : "setEditor",
910 "desc" : "Sets the editor for a column.",
911 "sig" : "(col, editor)",
915 "isConstructor" : false,
927 "desc" : "The column index",
933 "desc" : "The editor object",
940 "name" : "findColumnIndex",
942 "desc" : "Returns the index for a specified column dataIndex.",
943 "sig" : "(dataIndex)",
947 "isConstructor" : false,
957 "name" : "dataIndex",
959 "desc" : "The column dataIndex",
967 "desc" : "the index, or -1 if not found"
972 "name" : "isSortable",
974 "desc" : "Returns true if the specified column is sortable.",
979 "isConstructor" : false,
991 "desc" : "The column index",
1004 "name" : "getIndexById",
1005 "type" : "function",
1006 "desc" : "Returns the index for a specified column id.",
1011 "isConstructor" : false,
1012 "isPrivate" : false,
1023 "desc" : "The column id",
1024 "isOptional" : false
1031 "desc" : "the index, or -1 if not found"
1036 "name" : "getTotalWidth",
1037 "type" : "function",
1038 "desc" : "Returns the total width of all columns.",
1039 "sig" : "(includeHidden)",
1043 "isConstructor" : false,
1044 "isPrivate" : false,
1053 "name" : "includeHidden",
1055 "desc" : "True to include hidden column widths",
1056 "isOptional" : false
1068 "name" : "purgeListeners",
1069 "type" : "function",
1070 "desc" : "Removes all listeners for this object",
1071 "sig" : "()\n{\n\n}",
1073 "memberOf" : "Roo.util.Observable",
1075 "isConstructor" : false,
1076 "isPrivate" : false,
1088 "type" : "function",
1089 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1090 "sig" : "(eventName, handler, scope, options)",
1092 "memberOf" : "Roo.util.Observable",
1094 "isConstructor" : false,
1095 "isPrivate" : false,
1104 "name" : "eventName",
1106 "desc" : "The type of event to listen for",
1107 "isOptional" : false
1111 "type" : "Function",
1112 "desc" : "The method the event invokes",
1113 "isOptional" : false
1118 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1119 "isOptional" : false
1124 "desc" : "(optional)",
1125 "isOptional" : false
1132 "type" : "function",
1133 "desc" : "Removes a listener (shorthand for removeListener)",
1134 "sig" : "(eventName, handler, scope)",
1136 "memberOf" : "Roo.util.Observable",
1138 "isConstructor" : false,
1139 "isPrivate" : false,
1148 "name" : "eventName",
1150 "desc" : "The type of event to listen for",
1151 "isOptional" : false
1155 "type" : "Function",
1156 "desc" : "The handler to remove",
1157 "isOptional" : false
1162 "desc" : "(optional) The scope (this object) for the handler",
1163 "isOptional" : false
1169 "name" : "addEvents",
1170 "type" : "function",
1171 "desc" : "Used to define events on this Observable",
1174 "memberOf" : "Roo.util.Observable",
1176 "isConstructor" : false,
1177 "isPrivate" : false,
1188 "desc" : "The object with the events defined",
1189 "isOptional" : false
1195 "name" : "releaseCapture",
1196 "type" : "function",
1197 "desc" : "Removes <b>all</b> added captures from the Observable.",
1200 "memberOf" : "Roo.util.Observable",
1202 "isConstructor" : false,
1203 "isPrivate" : false,
1213 "type" : "Observable",
1214 "desc" : "The Observable to release",
1215 "isOptional" : false
1221 "name" : "removeListener",
1222 "type" : "function",
1223 "desc" : "Removes a listener",
1224 "sig" : "(eventName, handler, scope)",
1226 "memberOf" : "Roo.util.Observable",
1228 "isConstructor" : false,
1229 "isPrivate" : false,
1238 "name" : "eventName",
1240 "desc" : "The type of event to listen for",
1241 "isOptional" : false
1245 "type" : "Function",
1246 "desc" : "The handler to remove",
1247 "isOptional" : false
1252 "desc" : "(optional) The scope (this object) for the handler",
1253 "isOptional" : false
1259 "name" : "fireEvent",
1260 "type" : "function",
1261 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1262 "sig" : "(eventName, args)",
1264 "memberOf" : "Roo.util.Observable",
1266 "isConstructor" : false,
1267 "isPrivate" : false,
1276 "name" : "eventName",
1279 "isOptional" : false
1283 "type" : "Object...",
1284 "desc" : "Variable number of parameters are passed to handlers",
1285 "isOptional" : false
1292 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1297 "name" : "hasListener",
1298 "type" : "function",
1299 "desc" : "Checks to see if this object has any listeners for a specified event",
1300 "sig" : "(eventName)",
1302 "memberOf" : "Roo.util.Observable",
1304 "isConstructor" : false,
1305 "isPrivate" : false,
1314 "name" : "eventName",
1316 "desc" : "The name of the event to check for",
1317 "isOptional" : false
1324 "desc" : "True if the event is being listened for, else false"
1330 "type" : "function",
1331 "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.",
1332 "sig" : "(o, fn, scope)",
1334 "memberOf" : "Roo.util.Observable",
1336 "isConstructor" : false,
1337 "isPrivate" : false,
1347 "type" : "Observable",
1348 "desc" : "The Observable to capture",
1349 "isOptional" : false
1353 "type" : "Function",
1354 "desc" : "The function to call",
1355 "isOptional" : false
1360 "desc" : "(optional) The scope (this object) for the fn",
1361 "isOptional" : false
1367 "name" : "addListener",
1368 "type" : "function",
1369 "desc" : "Appends an event handler to this component",
1370 "sig" : "(eventName, handler, scope, options)",
1372 "memberOf" : "Roo.util.Observable",
1374 "isConstructor" : false,
1375 "isPrivate" : false,
1384 "name" : "eventName",
1386 "desc" : "The type of event to listen for",
1387 "isOptional" : false
1391 "type" : "Function",
1392 "desc" : "The method the event invokes",
1393 "isOptional" : false
1398 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1399 "isOptional" : false
1404 "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>",
1405 "isOptional" : false
1413 "name" : "hiddenchange",
1414 "type" : "function",
1415 "desc" : "Fires when a column is hidden or \"unhidden\".",
1416 "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
1425 "type" : "ColumnModel",
1427 "isOptional" : false
1430 "name" : "columnIndex",
1432 "desc" : "The column index",
1433 "isOptional" : false
1438 "desc" : "true if hidden, false otherwise",
1439 "isOptional" : false
1445 "name" : "headerchange",
1446 "type" : "function",
1447 "desc" : "Fires when the text of a header changes.",
1448 "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
1457 "type" : "ColumnModel",
1459 "isOptional" : false
1462 "name" : "columnIndex",
1464 "desc" : "The column index",
1465 "isOptional" : false
1470 "desc" : "The new header text",
1471 "isOptional" : false
1477 "name" : "columlockchange",
1478 "type" : "function",
1479 "desc" : "Fires when a column's locked state is changed",
1480 "sig" : "function (_self, colIndex, locked)\n{\n\n}",
1489 "type" : "ColumnModel",
1491 "isOptional" : false
1494 "name" : "colIndex",
1497 "isOptional" : false
1502 "desc" : "true if locked",
1503 "isOptional" : false
1509 "name" : "columnmoved",
1510 "type" : "function",
1511 "desc" : "Fires when a column is moved.",
1512 "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
1521 "type" : "ColumnModel",
1523 "isOptional" : false
1526 "name" : "oldIndex",
1529 "isOptional" : false
1532 "name" : "newIndex",
1535 "isOptional" : false
1541 "name" : "widthchange",
1542 "type" : "function",
1543 "desc" : "Fires when the width of a column changes.",
1544 "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
1553 "type" : "ColumnModel",
1555 "isOptional" : false
1558 "name" : "columnIndex",
1560 "desc" : "The column index",
1561 "isOptional" : false
1564 "name" : "newWidth",
1566 "desc" : "The new width",
1567 "isOptional" : false