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.",
13 "type" : "Roo.grid.GridEditor",
14 "desc" : "(Optional) For grid editors - returns the grid editor",
15 "memberOf" : "Roo.grid.ColumnModel",
22 "desc" : "(Optional)",
23 "memberOf" : "Roo.grid.ColumnModel",
30 "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>",
31 "memberOf" : "Roo.util.Observable",
38 "desc" : "(Optional)",
39 "memberOf" : "Roo.grid.ColumnModel",
46 "desc" : "(Optional)",
47 "memberOf" : "Roo.grid.ColumnModel",
54 "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
55 "memberOf" : "Roo.grid.ColumnModel",
62 "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
63 "memberOf" : "Roo.grid.ColumnModel",
70 "desc" : "(Optional) True to hide the column. Defaults to false.",
71 "memberOf" : "Roo.grid.ColumnModel",
78 "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
79 "memberOf" : "Roo.grid.ColumnModel",
86 "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
87 "memberOf" : "Roo.grid.ColumnModel",
94 "desc" : "(Optional)",
95 "memberOf" : "Roo.grid.ColumnModel",
102 "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",
103 "memberOf" : "Roo.grid.ColumnModel",
110 "desc" : "(Optional)",
111 "memberOf" : "Roo.grid.ColumnModel",
118 "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}.",
119 "memberOf" : "Roo.grid.ColumnModel",
126 "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
127 "memberOf" : "Roo.grid.ColumnModel",
134 "desc" : "The header text to display in the Grid view.",
135 "memberOf" : "Roo.grid.ColumnModel",
140 "name" : "resizable",
142 "desc" : "(Optional) False to disable column resizing. Defaults to true.",
143 "memberOf" : "Roo.grid.ColumnModel",
148 "name" : "dataIndex",
150 "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.",
151 "memberOf" : "Roo.grid.ColumnModel",
158 "desc" : "(Optional)",
159 "memberOf" : "Roo.grid.ColumnModel",
166 "name" : "setRenderer",
167 "desc" : "Sets the rendering (formatting) function for a column.",
169 "isConstructor" : false,
171 "memberOf" : "Roo.grid.ColumnModel",
180 "desc" : "The column index",
186 "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>",
195 "desc" : "Returns true if the column is hidden.",
197 "isConstructor" : false,
199 "memberOf" : "Roo.grid.ColumnModel",
208 "desc" : "The column index",
221 "name" : "setColumnHeader",
222 "desc" : "Sets the header for a column.",
224 "isConstructor" : false,
226 "memberOf" : "Roo.grid.ColumnModel",
235 "desc" : "The column index",
241 "desc" : "The new header",
249 "name" : "getColumnCount",
250 "desc" : "Returns the number of columns.",
252 "isConstructor" : false,
254 "memberOf" : "Roo.grid.ColumnModel",
270 "name" : "getColumnHeader",
271 "desc" : "Returns the header for the specified column.",
273 "isConstructor" : false,
275 "memberOf" : "Roo.grid.ColumnModel",
284 "desc" : "The column index",
297 "name" : "getRenderer",
298 "desc" : "Returns the rendering (formatting) function defined for the column.",
300 "isConstructor" : false,
302 "memberOf" : "Roo.grid.ColumnModel",
311 "desc" : "The column index.",
319 "desc" : "The function used to render the cell. See {@link #setRenderer}."
324 "name" : "getColumnTooltip",
325 "desc" : "Returns the tooltip for the specified column.",
327 "isConstructor" : false,
329 "memberOf" : "Roo.grid.ColumnModel",
338 "desc" : "The column index",
351 "name" : "setColumnWidth",
352 "desc" : "Sets the width for a column.",
354 "isConstructor" : false,
356 "memberOf" : "Roo.grid.ColumnModel",
365 "desc" : "The column index",
371 "desc" : "The new width",
379 "name" : "setDataIndex",
380 "desc" : "Sets the dataIndex for a column.",
382 "isConstructor" : false,
384 "memberOf" : "Roo.grid.ColumnModel",
393 "desc" : "The column index",
397 "name" : "dataIndex",
399 "desc" : "The new dataIndex",
407 "name" : "isCellEditable",
408 "desc" : "Returns true if the cell is editable.",
410 "isConstructor" : false,
412 "memberOf" : "Roo.grid.ColumnModel",
421 "desc" : "The column index",
427 "desc" : "The row index - this is nto actually used..?",
440 "name" : "getColumnsBy",
441 "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
443 "isConstructor" : false,
445 "memberOf" : "Roo.grid.ColumnModel",
460 "desc" : "(optional)",
473 "name" : "getColumnWidth",
474 "desc" : "Returns the width for the specified column.",
476 "isConstructor" : false,
478 "memberOf" : "Roo.grid.ColumnModel",
487 "desc" : "The column index",
501 "desc" : "Returns true if the column width cannot be changed",
503 "isConstructor" : false,
505 "memberOf" : "Roo.grid.ColumnModel",
516 "name" : "getCellEditor",
517 "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
519 "isConstructor" : false,
521 "memberOf" : "Roo.grid.ColumnModel",
530 "desc" : "The column index",
536 "desc" : "The row index",
549 "name" : "getColumnId",
550 "desc" : "Returns the id of the column at the specified index.",
552 "isConstructor" : false,
554 "memberOf" : "Roo.grid.ColumnModel",
563 "desc" : "The column index",
576 "name" : "getDataIndex",
577 "desc" : "Returns the dataIndex for the specified column.",
579 "isConstructor" : false,
581 "memberOf" : "Roo.grid.ColumnModel",
590 "desc" : "The column index",
603 "name" : "isResizable",
604 "desc" : "Returns true if the column can be resized",
606 "isConstructor" : false,
608 "memberOf" : "Roo.grid.ColumnModel",
624 "name" : "setColumnTooltip",
625 "desc" : "Sets the tooltip for a column.",
627 "isConstructor" : false,
629 "memberOf" : "Roo.grid.ColumnModel",
638 "desc" : "The column index",
644 "desc" : "The new tooltip",
652 "name" : "setHidden",
653 "desc" : "Sets if a column is hidden.",
655 "isConstructor" : false,
657 "memberOf" : "Roo.grid.ColumnModel",
666 "desc" : "The column index",
672 "desc" : "True if the column is hidden",
680 "name" : "setEditable",
681 "desc" : "Sets if a column is editable.",
683 "isConstructor" : false,
685 "memberOf" : "Roo.grid.ColumnModel",
694 "desc" : "The column index",
700 "desc" : "True if the column is editable",
708 "name" : "getColumnById",
709 "desc" : "Returns the column for a specified id.",
711 "isConstructor" : false,
713 "memberOf" : "Roo.grid.ColumnModel",
722 "desc" : "The column id",
730 "desc" : "the column"
735 "name" : "getColumnByDataIndex",
736 "desc" : "Returns the column for a specified dataIndex.",
738 "isConstructor" : false,
740 "memberOf" : "Roo.grid.ColumnModel",
747 "name" : "dataIndex",
749 "desc" : "The column dataIndex",
756 "type" : "Object|Boolean",
757 "desc" : "the column or false if not found"
762 "name" : "setEditor",
763 "desc" : "Sets the editor for a column.",
765 "isConstructor" : false,
767 "memberOf" : "Roo.grid.ColumnModel",
776 "desc" : "The column index",
782 "desc" : "The editor object",
790 "name" : "findColumnIndex",
791 "desc" : "Returns the index for a specified column dataIndex.",
793 "isConstructor" : false,
795 "memberOf" : "Roo.grid.ColumnModel",
802 "name" : "dataIndex",
804 "desc" : "The column dataIndex",
812 "desc" : "the index, or -1 if not found"
817 "name" : "isSortable",
818 "desc" : "Returns true if the specified column is sortable.",
820 "isConstructor" : false,
822 "memberOf" : "Roo.grid.ColumnModel",
831 "desc" : "The column index",
844 "name" : "getIndexById",
845 "desc" : "Returns the index for a specified column id.",
847 "isConstructor" : false,
849 "memberOf" : "Roo.grid.ColumnModel",
858 "desc" : "The column id",
866 "desc" : "the index, or -1 if not found"
871 "name" : "getTotalWidth",
872 "desc" : "Returns the total width of all columns.",
874 "isConstructor" : false,
876 "memberOf" : "Roo.grid.ColumnModel",
883 "name" : "includeHidden",
885 "desc" : "True to include hidden column widths",
898 "name" : "purgeListeners",
899 "desc" : "Removes all listeners for this object",
901 "isConstructor" : false,
903 "memberOf" : "Roo.util.Observable",
915 "desc" : "Appends an event handler to this element (shorthand for addListener)",
917 "isConstructor" : false,
919 "memberOf" : "Roo.util.Observable",
926 "name" : "eventName",
928 "desc" : "The type of event to listen for",
934 "desc" : "The method the event invokes",
940 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
946 "desc" : "(optional)",
955 "desc" : "Removes a listener (shorthand for removeListener)",
957 "isConstructor" : false,
959 "memberOf" : "Roo.util.Observable",
966 "name" : "eventName",
968 "desc" : "The type of event to listen for",
974 "desc" : "The handler to remove",
980 "desc" : "(optional) The scope (this object) for the handler",
988 "name" : "addEvents",
989 "desc" : "Used to define events on this Observable",
991 "isConstructor" : false,
993 "memberOf" : "Roo.util.Observable",
1002 "desc" : "The object with the events defined",
1003 "isOptional" : false
1010 "name" : "releaseCapture",
1011 "desc" : "Removes <b>all</b> added captures from the Observable.",
1013 "isConstructor" : false,
1014 "isPrivate" : false,
1015 "memberOf" : "Roo.util.Observable",
1023 "type" : "Observable",
1024 "desc" : "The Observable to release",
1025 "isOptional" : false
1032 "name" : "removeListener",
1033 "desc" : "Removes a listener",
1035 "isConstructor" : false,
1036 "isPrivate" : false,
1037 "memberOf" : "Roo.util.Observable",
1044 "name" : "eventName",
1046 "desc" : "The type of event to listen for",
1047 "isOptional" : false
1051 "type" : "Function",
1052 "desc" : "The handler to remove",
1053 "isOptional" : false
1058 "desc" : "(optional) The scope (this object) for the handler",
1059 "isOptional" : false
1066 "name" : "fireEvent",
1067 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1069 "isConstructor" : false,
1070 "isPrivate" : false,
1071 "memberOf" : "Roo.util.Observable",
1078 "name" : "eventName",
1081 "isOptional" : false
1085 "type" : "Object...",
1086 "desc" : "Variable number of parameters are passed to handlers",
1087 "isOptional" : false
1094 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1099 "name" : "hasListener",
1100 "desc" : "Checks to see if this object has any listeners for a specified event",
1102 "isConstructor" : false,
1103 "isPrivate" : false,
1104 "memberOf" : "Roo.util.Observable",
1111 "name" : "eventName",
1113 "desc" : "The name of the event to check for",
1114 "isOptional" : false
1121 "desc" : "True if the event is being listened for, else false"
1127 "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.",
1129 "isConstructor" : false,
1130 "isPrivate" : false,
1131 "memberOf" : "Roo.util.Observable",
1139 "type" : "Observable",
1140 "desc" : "The Observable to capture",
1141 "isOptional" : false
1145 "type" : "Function",
1146 "desc" : "The function to call",
1147 "isOptional" : false
1152 "desc" : "(optional) The scope (this object) for the fn",
1153 "isOptional" : false
1160 "name" : "addListener",
1161 "desc" : "Appends an event handler to this component",
1163 "isConstructor" : false,
1164 "isPrivate" : false,
1165 "memberOf" : "Roo.util.Observable",
1172 "name" : "eventName",
1174 "desc" : "The type of event to listen for",
1175 "isOptional" : false
1179 "type" : "Function",
1180 "desc" : "The method the event invokes",
1181 "isOptional" : false
1186 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1187 "isOptional" : false
1192 "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>",
1193 "isOptional" : false
1202 "name" : "hiddenchange",
1203 "desc" : "Fires when a column is hidden or \"unhidden\".",
1212 "type" : "ColumnModel",
1214 "isOptional" : false
1217 "name" : "columnIndex",
1219 "desc" : "The column index",
1220 "isOptional" : false
1225 "desc" : "true if hidden, false otherwise",
1226 "isOptional" : false
1233 "name" : "headerchange",
1234 "desc" : "Fires when the text of a header changes.",
1243 "type" : "ColumnModel",
1245 "isOptional" : false
1248 "name" : "columnIndex",
1250 "desc" : "The column index",
1251 "isOptional" : false
1256 "desc" : "The new header text",
1257 "isOptional" : false
1264 "name" : "columlockchange",
1265 "desc" : "Fires when a column's locked state is changed",
1274 "type" : "ColumnModel",
1276 "isOptional" : false
1279 "name" : "colIndex",
1282 "isOptional" : false
1287 "desc" : "true if locked",
1288 "isOptional" : false
1295 "name" : "columnmoved",
1296 "desc" : "Fires when a column is moved.",
1305 "type" : "ColumnModel",
1307 "isOptional" : false
1310 "name" : "oldIndex",
1313 "isOptional" : false
1316 "name" : "newIndex",
1319 "isOptional" : false
1326 "name" : "widthchange",
1327 "desc" : "Fires when the width of a column changes.",
1336 "type" : "ColumnModel",
1338 "isOptional" : false
1341 "name" : "columnIndex",
1343 "desc" : "The column index",
1344 "isOptional" : false
1347 "name" : "newWidth",
1349 "desc" : "The new width",
1350 "isOptional" : false