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",
42 "type" : "Roo.grid.GridEditor",
43 "desc" : "For grid editors - returns the grid editor",
96 "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>",
97 "memberOf" : "Roo.util.Observable",
104 "desc" : "Header at Bootsrap Small width",
106 "isOptional" : false,
112 "desc" : "mouse over tooltip text",
114 "isOptional" : false,
120 "desc" : "can be '0' for hidden at this size (number less than 12)",
122 "isOptional" : false,
128 "desc" : "t) Set the CSS text-align property of the column. Defaults to undefined (left",
130 "isOptional" : false,
139 "desc" : "Header at Bootsrap Large width",
141 "isOptional" : false,
147 "desc" : "Header at Bootsrap extra Large width",
149 "isOptional" : false,
155 "desc" : "True if the column width cannot be changed. Defaults to false.",
157 "isOptional" : false,
163 "desc" : "True to hide the column. Defaults to false.",
165 "isOptional" : false,
171 "desc" : "e) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined (middl",
173 "isOptional" : false,
183 "desc" : "True to lock the column in place while scrolling the Grid. Defaults to false.",
185 "isOptional" : false,
191 "desc" : "can be '0' for hidden at this size (number less than 12)",
193 "isOptional" : false,
199 "desc" : "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",
201 "isOptional" : false,
207 "desc" : "can be '0' for hidden at this size (number less than 12)",
209 "isOptional" : false,
215 "desc" : "Header at Bootsrap Extra Small width (default for all)",
217 "isOptional" : false,
223 "desc" : "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}.",
225 "isOptional" : false,
231 "desc" : "The header text to display in the Grid view.",
233 "isOptional" : false,
239 "desc" : "The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
241 "isOptional" : false,
245 "name" : "resizable",
247 "desc" : "False to disable column resizing. Defaults to true.",
249 "isOptional" : false,
255 "desc" : "can be '0' for hidden at this size (number less than 12)",
257 "isOptional" : false,
261 "name" : "dataIndex",
263 "desc" : "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.",
265 "isOptional" : false,
271 "desc" : "can be '0' for hidden at this size (number less than 12)",
273 "isOptional" : false,
279 "name" : "setRenderer",
281 "desc" : "Sets the rendering (formatting) function for a column.",
286 "isConstructor" : false,
298 "desc" : "The column index",
304 "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>",
313 "desc" : "Returns true if the column is hidden.",
314 "sig" : "(colIndex)",
318 "isConstructor" : false,
330 "desc" : "The column index",
343 "name" : "setColumnHeader",
345 "desc" : "Sets the header for a column.",
346 "sig" : "(col, header)",
350 "isConstructor" : false,
362 "desc" : "The column index",
368 "desc" : "The new header",
375 "name" : "getColumnCount",
377 "desc" : "Returns the number of columns.",
378 "sig" : "()\n{\n\n}",
382 "isConstructor" : false,
400 "name" : "addColumn",
402 "desc" : "Add a column (experimental...) - defaults to adding to the end..",
407 "isConstructor" : false,
426 "name" : "getColumnHeader",
428 "desc" : "Returns the header for the specified column.",
433 "isConstructor" : false,
445 "desc" : "The column index",
458 "name" : "getRenderer",
460 "desc" : "Returns the rendering (formatting) function defined for the column.",
465 "isConstructor" : false,
477 "desc" : "The column index.",
485 "desc" : "The function used to render the cell. See {@link #setRenderer}."
490 "name" : "getColumnTooltip",
492 "desc" : "Returns the tooltip for the specified column.",
497 "isConstructor" : false,
509 "desc" : "The column index",
522 "name" : "setColumnWidth",
524 "desc" : "Sets the width for a column.",
525 "sig" : "(col, width)",
529 "isConstructor" : false,
541 "desc" : "The column index",
547 "desc" : "The new width",
554 "name" : "setDataIndex",
556 "desc" : "Sets the dataIndex for a column.",
557 "sig" : "(col, dataIndex)",
561 "isConstructor" : false,
573 "desc" : "The column index",
577 "name" : "dataIndex",
579 "desc" : "The new dataIndex",
586 "name" : "isCellEditable",
588 "desc" : "Returns true if the cell is editable.",
589 "sig" : "(colIndex, rowIndex)",
593 "isConstructor" : false,
605 "desc" : "The column index",
611 "desc" : "The row index - this is nto actually used..?",
624 "name" : "getColumnsBy",
626 "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
627 "sig" : "(fn, scope)",
631 "isConstructor" : false,
649 "desc" : "(optional)",
662 "name" : "getColumnWidth",
664 "desc" : "Returns the width for the specified column.",
665 "sig" : "(col, (optional))",
669 "isConstructor" : false,
681 "desc" : "The column index",
685 "name" : "(optional)",
687 "desc" : "{String} gridSize bootstrap width size.",
702 "desc" : "Returns true if the column width cannot be changed",
703 "sig" : "()\n{\n\n}",
707 "isConstructor" : false,
719 "name" : "getCellEditor",
721 "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
722 "sig" : "(colIndex, rowIndex)",
726 "isConstructor" : false,
738 "desc" : "The column index",
744 "desc" : "The row index",
757 "name" : "getColumnId",
759 "desc" : "Returns the id of the column at the specified index.",
764 "isConstructor" : false,
776 "desc" : "The column index",
789 "name" : "getDataIndex",
791 "desc" : "Returns the dataIndex for the specified column.",
796 "isConstructor" : false,
808 "desc" : "The column index",
821 "name" : "isResizable",
823 "desc" : "Returns true if the column can be resized",
824 "sig" : "()\n{\n\n}",
828 "isConstructor" : false,
846 "name" : "setColumnTooltip",
848 "desc" : "Sets the tooltip for a column.",
849 "sig" : "(col, tooltip)",
853 "isConstructor" : false,
865 "desc" : "The column index",
871 "desc" : "The new tooltip",
878 "name" : "setHidden",
880 "desc" : "Sets if a column is hidden.",
881 "sig" : "(colIndex, hidden)",
885 "isConstructor" : false,
897 "desc" : "The column index",
903 "desc" : "True if the column is hidden",
910 "name" : "setEditable",
912 "desc" : "Sets if a column is editable.",
913 "sig" : "(col, editable)",
917 "isConstructor" : false,
929 "desc" : "The column index",
935 "desc" : "True if the column is editable",
942 "name" : "getColumnById",
944 "desc" : "Returns the column for a specified id.",
949 "isConstructor" : false,
961 "desc" : "The column id",
969 "desc" : "the column"
974 "name" : "getColumnByDataIndex",
976 "desc" : "Returns the column Object for a specified dataIndex.",
977 "sig" : "(dataIndex)",
981 "isConstructor" : false,
991 "name" : "dataIndex",
993 "desc" : "The column dataIndex",
1000 "type" : "Object|Boolean",
1001 "desc" : "the column or false if not found"
1006 "name" : "setEditor",
1007 "type" : "function",
1008 "desc" : "Sets the editor for a column.",
1009 "sig" : "(col, editor)",
1013 "isConstructor" : false,
1014 "isPrivate" : false,
1025 "desc" : "The column index",
1026 "isOptional" : false
1031 "desc" : "The editor object",
1032 "isOptional" : false
1038 "name" : "findColumnIndex",
1039 "type" : "function",
1040 "desc" : "Returns the index for a specified column dataIndex.",
1041 "sig" : "(dataIndex)",
1045 "isConstructor" : false,
1046 "isPrivate" : false,
1055 "name" : "dataIndex",
1057 "desc" : "The column dataIndex",
1058 "isOptional" : false
1065 "desc" : "the index, or -1 if not found"
1070 "name" : "isSortable",
1071 "type" : "function",
1072 "desc" : "Returns true if the specified column is sortable.",
1077 "isConstructor" : false,
1078 "isPrivate" : false,
1089 "desc" : "The column index",
1090 "isOptional" : false
1102 "name" : "getIndexById",
1103 "type" : "function",
1104 "desc" : "Returns the index for a specified column id.",
1109 "isConstructor" : false,
1110 "isPrivate" : false,
1121 "desc" : "The column id",
1122 "isOptional" : false
1129 "desc" : "the index, or -1 if not found"
1134 "name" : "getTotalWidth",
1135 "type" : "function",
1136 "desc" : "Returns the total width of all columns.",
1137 "sig" : "(includeHidden)",
1141 "isConstructor" : false,
1142 "isPrivate" : false,
1151 "name" : "includeHidden",
1153 "desc" : "True to include hidden column widths",
1154 "isOptional" : false
1166 "name" : "purgeListeners",
1167 "type" : "function",
1168 "desc" : "Removes all listeners for this object",
1169 "sig" : "()\n{\n\n}",
1171 "memberOf" : "Roo.util.Observable",
1173 "isConstructor" : false,
1174 "isPrivate" : false,
1186 "type" : "function",
1187 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1188 "sig" : "(eventName, handler, scope, options)",
1190 "memberOf" : "Roo.util.Observable",
1192 "isConstructor" : false,
1193 "isPrivate" : false,
1202 "name" : "eventName",
1204 "desc" : "The type of event to listen for",
1205 "isOptional" : false
1209 "type" : "Function",
1210 "desc" : "The method the event invokes",
1211 "isOptional" : false
1216 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1217 "isOptional" : false
1222 "desc" : "(optional)",
1223 "isOptional" : false
1230 "type" : "function",
1231 "desc" : "Removes a listener (shorthand for removeListener)",
1232 "sig" : "(eventName, handler, scope)",
1234 "memberOf" : "Roo.util.Observable",
1236 "isConstructor" : false,
1237 "isPrivate" : false,
1246 "name" : "eventName",
1248 "desc" : "The type of event to listen for",
1249 "isOptional" : false
1253 "type" : "Function",
1254 "desc" : "The handler to remove",
1255 "isOptional" : false
1260 "desc" : "(optional) The scope (this object) for the handler",
1261 "isOptional" : false
1267 "name" : "addEvents",
1268 "type" : "function",
1269 "desc" : "Used to define events on this Observable",
1272 "memberOf" : "Roo.util.Observable",
1274 "isConstructor" : false,
1275 "isPrivate" : false,
1286 "desc" : "The object with the events defined",
1287 "isOptional" : false
1293 "name" : "releaseCapture",
1294 "type" : "function",
1295 "desc" : "Removes <b>all</b> added captures from the Observable.",
1298 "memberOf" : "Roo.util.Observable",
1300 "isConstructor" : false,
1301 "isPrivate" : false,
1311 "type" : "Observable",
1312 "desc" : "The Observable to release",
1313 "isOptional" : false
1319 "name" : "removeListener",
1320 "type" : "function",
1321 "desc" : "Removes a listener",
1322 "sig" : "(eventName, handler, scope)",
1324 "memberOf" : "Roo.util.Observable",
1326 "isConstructor" : false,
1327 "isPrivate" : false,
1336 "name" : "eventName",
1338 "desc" : "The type of event to listen for",
1339 "isOptional" : false
1343 "type" : "Function",
1344 "desc" : "The handler to remove",
1345 "isOptional" : false
1350 "desc" : "(optional) The scope (this object) for the handler",
1351 "isOptional" : false
1357 "name" : "fireEvent",
1358 "type" : "function",
1359 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1360 "sig" : "(eventName, args)",
1362 "memberOf" : "Roo.util.Observable",
1364 "isConstructor" : false,
1365 "isPrivate" : false,
1374 "name" : "eventName",
1377 "isOptional" : false
1381 "type" : "Object...",
1382 "desc" : "Variable number of parameters are passed to handlers",
1383 "isOptional" : false
1390 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1395 "name" : "hasListener",
1396 "type" : "function",
1397 "desc" : "Checks to see if this object has any listeners for a specified event",
1398 "sig" : "(eventName)",
1400 "memberOf" : "Roo.util.Observable",
1402 "isConstructor" : false,
1403 "isPrivate" : false,
1412 "name" : "eventName",
1414 "desc" : "The name of the event to check for",
1415 "isOptional" : false
1422 "desc" : "True if the event is being listened for, else false"
1428 "type" : "function",
1429 "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.",
1430 "sig" : "(o, fn, scope)",
1432 "memberOf" : "Roo.util.Observable",
1434 "isConstructor" : false,
1435 "isPrivate" : false,
1445 "type" : "Observable",
1446 "desc" : "The Observable to capture",
1447 "isOptional" : false
1451 "type" : "Function",
1452 "desc" : "The function to call",
1453 "isOptional" : false
1458 "desc" : "(optional) The scope (this object) for the fn",
1459 "isOptional" : false
1465 "name" : "addListener",
1466 "type" : "function",
1467 "desc" : "Appends an event handler to this component",
1468 "sig" : "(eventName, handler, scope, options)",
1470 "memberOf" : "Roo.util.Observable",
1472 "isConstructor" : false,
1473 "isPrivate" : false,
1482 "name" : "eventName",
1484 "desc" : "The type of event to listen for",
1485 "isOptional" : false
1489 "type" : "Function",
1490 "desc" : "The method the event invokes",
1491 "isOptional" : false
1496 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1497 "isOptional" : false
1502 "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>",
1503 "isOptional" : false
1511 "name" : "hiddenchange",
1512 "type" : "function",
1513 "desc" : "Fires when a column is hidden or \"unhidden\".",
1514 "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
1523 "type" : "ColumnModel",
1525 "isOptional" : false
1528 "name" : "columnIndex",
1530 "desc" : "The column index",
1531 "isOptional" : false
1536 "desc" : "true if hidden, false otherwise",
1537 "isOptional" : false
1543 "name" : "headerchange",
1544 "type" : "function",
1545 "desc" : "Fires when the text of a header changes.",
1546 "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
1555 "type" : "ColumnModel",
1557 "isOptional" : false
1560 "name" : "columnIndex",
1562 "desc" : "The column index",
1563 "isOptional" : false
1568 "desc" : "The new header text",
1569 "isOptional" : false
1575 "name" : "columlockchange",
1576 "type" : "function",
1577 "desc" : "Fires when a column's locked state is changed",
1578 "sig" : "function (_self, colIndex, locked)\n{\n\n}",
1587 "type" : "ColumnModel",
1589 "isOptional" : false
1592 "name" : "colIndex",
1595 "isOptional" : false
1600 "desc" : "true if locked",
1601 "isOptional" : false
1607 "name" : "columnmoved",
1608 "type" : "function",
1609 "desc" : "Fires when a column is moved.",
1610 "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
1619 "type" : "ColumnModel",
1621 "isOptional" : false
1624 "name" : "oldIndex",
1627 "isOptional" : false
1630 "name" : "newIndex",
1633 "isOptional" : false
1639 "name" : "widthchange",
1640 "type" : "function",
1641 "desc" : "Fires when the width of a column changes.",
1642 "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
1651 "type" : "ColumnModel",
1653 "isOptional" : false
1656 "name" : "columnIndex",
1658 "desc" : "The column index",
1659 "isOptional" : false
1662 "name" : "newWidth",
1664 "desc" : "The new width",
1665 "isOptional" : false