2 "name" : "Roo.grid.ColumnModel",
6 "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 "memberOf" : "ColumnModel",
19 "desc" : "An Array of column config objects. See this class's\nconfig objects for details.",
28 "type" : "Roo.grid.GridEditor",
29 "desc" : "(Optional) For grid editors - returns the grid editor",
30 "memberOf" : "Roo.grid.ColumnModel",
37 "desc" : "(Optional)",
38 "memberOf" : "Roo.grid.ColumnModel",
45 "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>",
46 "memberOf" : "Roo.util.Observable",
53 "desc" : "(Optional)",
54 "memberOf" : "Roo.grid.ColumnModel",
61 "desc" : "(Optional)",
62 "memberOf" : "Roo.grid.ColumnModel",
69 "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
70 "memberOf" : "Roo.grid.ColumnModel",
77 "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
78 "memberOf" : "Roo.grid.ColumnModel",
85 "desc" : "(Optional) True to hide the column. Defaults to false.",
86 "memberOf" : "Roo.grid.ColumnModel",
93 "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
94 "memberOf" : "Roo.grid.ColumnModel",
101 "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
102 "memberOf" : "Roo.grid.ColumnModel",
109 "desc" : "(Optional)",
110 "memberOf" : "Roo.grid.ColumnModel",
117 "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",
118 "memberOf" : "Roo.grid.ColumnModel",
125 "desc" : "(Optional)",
126 "memberOf" : "Roo.grid.ColumnModel",
133 "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}.",
134 "memberOf" : "Roo.grid.ColumnModel",
141 "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
142 "memberOf" : "Roo.grid.ColumnModel",
149 "desc" : "The header text to display in the Grid view.",
150 "memberOf" : "Roo.grid.ColumnModel",
155 "name" : "resizable",
157 "desc" : "(Optional) False to disable column resizing. Defaults to true.",
158 "memberOf" : "Roo.grid.ColumnModel",
163 "name" : "dataIndex",
165 "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.",
166 "memberOf" : "Roo.grid.ColumnModel",
173 "desc" : "(Optional)",
174 "memberOf" : "Roo.grid.ColumnModel",
181 "name" : "setRenderer",
182 "desc" : "Sets the rendering (formatting) function for a column.",
184 "isConstructor" : false,
186 "memberOf" : "Roo.grid.ColumnModel",
195 "desc" : "The column index",
201 "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>",
210 "desc" : "Returns true if the column is hidden.",
212 "isConstructor" : false,
214 "memberOf" : "Roo.grid.ColumnModel",
223 "desc" : "The column index",
236 "name" : "setColumnHeader",
237 "desc" : "Sets the header for a column.",
239 "isConstructor" : false,
241 "memberOf" : "Roo.grid.ColumnModel",
250 "desc" : "The column index",
256 "desc" : "The new header",
264 "name" : "getColumnCount",
265 "desc" : "Returns the number of columns.",
267 "isConstructor" : false,
269 "memberOf" : "Roo.grid.ColumnModel",
285 "name" : "getColumnHeader",
286 "desc" : "Returns the header for the specified column.",
288 "isConstructor" : false,
290 "memberOf" : "Roo.grid.ColumnModel",
299 "desc" : "The column index",
312 "name" : "getRenderer",
313 "desc" : "Returns the rendering (formatting) function defined for the column.",
315 "isConstructor" : false,
317 "memberOf" : "Roo.grid.ColumnModel",
326 "desc" : "The column index.",
334 "desc" : "The function used to render the cell. See {@link #setRenderer}."
339 "name" : "getColumnTooltip",
340 "desc" : "Returns the tooltip for the specified column.",
342 "isConstructor" : false,
344 "memberOf" : "Roo.grid.ColumnModel",
353 "desc" : "The column index",
366 "name" : "setColumnWidth",
367 "desc" : "Sets the width for a column.",
369 "isConstructor" : false,
371 "memberOf" : "Roo.grid.ColumnModel",
380 "desc" : "The column index",
386 "desc" : "The new width",
394 "name" : "setDataIndex",
395 "desc" : "Sets the dataIndex for a column.",
397 "isConstructor" : false,
399 "memberOf" : "Roo.grid.ColumnModel",
408 "desc" : "The column index",
412 "name" : "dataIndex",
414 "desc" : "The new dataIndex",
422 "name" : "isCellEditable",
423 "desc" : "Returns true if the cell is editable.",
425 "isConstructor" : false,
427 "memberOf" : "Roo.grid.ColumnModel",
436 "desc" : "The column index",
442 "desc" : "The row index - this is nto actually used..?",
455 "name" : "getColumnsBy",
456 "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
458 "isConstructor" : false,
460 "memberOf" : "Roo.grid.ColumnModel",
475 "desc" : "(optional)",
488 "name" : "getColumnWidth",
489 "desc" : "Returns the width for the specified column.",
491 "isConstructor" : false,
493 "memberOf" : "Roo.grid.ColumnModel",
502 "desc" : "The column index",
516 "desc" : "Returns true if the column width cannot be changed",
518 "isConstructor" : false,
520 "memberOf" : "Roo.grid.ColumnModel",
531 "name" : "getCellEditor",
532 "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
534 "isConstructor" : false,
536 "memberOf" : "Roo.grid.ColumnModel",
545 "desc" : "The column index",
551 "desc" : "The row index",
564 "name" : "getColumnId",
565 "desc" : "Returns the id of the column at the specified index.",
567 "isConstructor" : false,
569 "memberOf" : "Roo.grid.ColumnModel",
578 "desc" : "The column index",
591 "name" : "getDataIndex",
592 "desc" : "Returns the dataIndex for the specified column.",
594 "isConstructor" : false,
596 "memberOf" : "Roo.grid.ColumnModel",
605 "desc" : "The column index",
618 "name" : "isResizable",
619 "desc" : "Returns true if the column can be resized",
621 "isConstructor" : false,
623 "memberOf" : "Roo.grid.ColumnModel",
639 "name" : "setColumnTooltip",
640 "desc" : "Sets the tooltip for a column.",
642 "isConstructor" : false,
644 "memberOf" : "Roo.grid.ColumnModel",
653 "desc" : "The column index",
659 "desc" : "The new tooltip",
667 "name" : "setHidden",
668 "desc" : "Sets if a column is hidden.",
670 "isConstructor" : false,
672 "memberOf" : "Roo.grid.ColumnModel",
681 "desc" : "The column index",
687 "desc" : "True if the column is hidden",
695 "name" : "setEditable",
696 "desc" : "Sets if a column is editable.",
698 "isConstructor" : false,
700 "memberOf" : "Roo.grid.ColumnModel",
709 "desc" : "The column index",
715 "desc" : "True if the column is editable",
723 "name" : "getColumnById",
724 "desc" : "Returns the column for a specified id.",
726 "isConstructor" : false,
728 "memberOf" : "Roo.grid.ColumnModel",
737 "desc" : "The column id",
745 "desc" : "the column"
750 "name" : "getColumnByDataIndex",
751 "desc" : "Returns the column for a specified dataIndex.",
753 "isConstructor" : false,
755 "memberOf" : "Roo.grid.ColumnModel",
762 "name" : "dataIndex",
764 "desc" : "The column dataIndex",
771 "type" : "Object|Boolean",
772 "desc" : "the column or false if not found"
777 "name" : "setEditor",
778 "desc" : "Sets the editor for a column.",
780 "isConstructor" : false,
782 "memberOf" : "Roo.grid.ColumnModel",
791 "desc" : "The column index",
797 "desc" : "The editor object",
805 "name" : "findColumnIndex",
806 "desc" : "Returns the index for a specified column dataIndex.",
808 "isConstructor" : false,
810 "memberOf" : "Roo.grid.ColumnModel",
817 "name" : "dataIndex",
819 "desc" : "The column dataIndex",
827 "desc" : "the index, or -1 if not found"
832 "name" : "isSortable",
833 "desc" : "Returns true if the specified column is sortable.",
835 "isConstructor" : false,
837 "memberOf" : "Roo.grid.ColumnModel",
846 "desc" : "The column index",
859 "name" : "getIndexById",
860 "desc" : "Returns the index for a specified column id.",
862 "isConstructor" : false,
864 "memberOf" : "Roo.grid.ColumnModel",
873 "desc" : "The column id",
881 "desc" : "the index, or -1 if not found"
886 "name" : "getTotalWidth",
887 "desc" : "Returns the total width of all columns.",
889 "isConstructor" : false,
891 "memberOf" : "Roo.grid.ColumnModel",
898 "name" : "includeHidden",
900 "desc" : "True to include hidden column widths",
913 "name" : "purgeListeners",
914 "desc" : "Removes all listeners for this object",
916 "isConstructor" : false,
918 "memberOf" : "Roo.util.Observable",
930 "desc" : "Appends an event handler to this element (shorthand for addListener)",
932 "isConstructor" : false,
934 "memberOf" : "Roo.util.Observable",
941 "name" : "eventName",
943 "desc" : "The type of event to listen for",
949 "desc" : "The method the event invokes",
955 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
961 "desc" : "(optional)",
970 "desc" : "Removes a listener (shorthand for removeListener)",
972 "isConstructor" : false,
974 "memberOf" : "Roo.util.Observable",
981 "name" : "eventName",
983 "desc" : "The type of event to listen for",
989 "desc" : "The handler to remove",
995 "desc" : "(optional) The scope (this object) for the handler",
1003 "name" : "addEvents",
1004 "desc" : "Used to define events on this Observable",
1006 "isConstructor" : false,
1007 "isPrivate" : false,
1008 "memberOf" : "Roo.util.Observable",
1017 "desc" : "The object with the events defined",
1018 "isOptional" : false
1025 "name" : "releaseCapture",
1026 "desc" : "Removes <b>all</b> added captures from the Observable.",
1028 "isConstructor" : false,
1029 "isPrivate" : false,
1030 "memberOf" : "Roo.util.Observable",
1038 "type" : "Observable",
1039 "desc" : "The Observable to release",
1040 "isOptional" : false
1047 "name" : "removeListener",
1048 "desc" : "Removes a listener",
1050 "isConstructor" : false,
1051 "isPrivate" : false,
1052 "memberOf" : "Roo.util.Observable",
1059 "name" : "eventName",
1061 "desc" : "The type of event to listen for",
1062 "isOptional" : false
1066 "type" : "Function",
1067 "desc" : "The handler to remove",
1068 "isOptional" : false
1073 "desc" : "(optional) The scope (this object) for the handler",
1074 "isOptional" : false
1081 "name" : "fireEvent",
1082 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1084 "isConstructor" : false,
1085 "isPrivate" : false,
1086 "memberOf" : "Roo.util.Observable",
1093 "name" : "eventName",
1096 "isOptional" : false
1100 "type" : "Object...",
1101 "desc" : "Variable number of parameters are passed to handlers",
1102 "isOptional" : false
1109 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1114 "name" : "hasListener",
1115 "desc" : "Checks to see if this object has any listeners for a specified event",
1117 "isConstructor" : false,
1118 "isPrivate" : false,
1119 "memberOf" : "Roo.util.Observable",
1126 "name" : "eventName",
1128 "desc" : "The name of the event to check for",
1129 "isOptional" : false
1136 "desc" : "True if the event is being listened for, else false"
1142 "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.",
1144 "isConstructor" : false,
1145 "isPrivate" : false,
1146 "memberOf" : "Roo.util.Observable",
1154 "type" : "Observable",
1155 "desc" : "The Observable to capture",
1156 "isOptional" : false
1160 "type" : "Function",
1161 "desc" : "The function to call",
1162 "isOptional" : false
1167 "desc" : "(optional) The scope (this object) for the fn",
1168 "isOptional" : false
1175 "name" : "addListener",
1176 "desc" : "Appends an event handler to this component",
1178 "isConstructor" : false,
1179 "isPrivate" : false,
1180 "memberOf" : "Roo.util.Observable",
1187 "name" : "eventName",
1189 "desc" : "The type of event to listen for",
1190 "isOptional" : false
1194 "type" : "Function",
1195 "desc" : "The method the event invokes",
1196 "isOptional" : false
1201 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1202 "isOptional" : false
1207 "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>",
1208 "isOptional" : false
1217 "name" : "hiddenchange",
1218 "desc" : "Fires when a column is hidden or \"unhidden\".",
1219 "memberOf" : "Roo.grid.ColumnModel",
1227 "type" : "ColumnModel",
1229 "isOptional" : false
1232 "name" : "columnIndex",
1234 "desc" : "The column index",
1235 "isOptional" : false
1240 "desc" : "true if hidden, false otherwise",
1241 "isOptional" : false
1248 "name" : "headerchange",
1249 "desc" : "Fires when the text of a header changes.",
1250 "memberOf" : "Roo.grid.ColumnModel",
1258 "type" : "ColumnModel",
1260 "isOptional" : false
1263 "name" : "columnIndex",
1265 "desc" : "The column index",
1266 "isOptional" : false
1271 "desc" : "The new header text",
1272 "isOptional" : false
1279 "name" : "columlockchange",
1280 "desc" : "Fires when a column's locked state is changed",
1281 "memberOf" : "Roo.grid.ColumnModel",
1289 "type" : "ColumnModel",
1291 "isOptional" : false
1294 "name" : "colIndex",
1297 "isOptional" : false
1302 "desc" : "true if locked",
1303 "isOptional" : false
1310 "name" : "columnmoved",
1311 "desc" : "Fires when a column is moved.",
1312 "memberOf" : "Roo.grid.ColumnModel",
1320 "type" : "ColumnModel",
1322 "isOptional" : false
1325 "name" : "oldIndex",
1328 "isOptional" : false
1331 "name" : "newIndex",
1334 "isOptional" : false
1341 "name" : "widthchange",
1342 "desc" : "Fires when the width of a column changes.",
1343 "memberOf" : "Roo.grid.ColumnModel",
1351 "type" : "ColumnModel",
1353 "isOptional" : false
1356 "name" : "columnIndex",
1358 "desc" : "The column index",
1359 "isOptional" : false
1362 "name" : "newWidth",
1364 "desc" : "The new width",
1365 "isOptional" : false