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.",
27 "type" : "Roo.grid.GridEditor",
28 "desc" : "(Optional) For grid editors - returns the grid editor",
29 "memberOf" : "Roo.grid.ColumnModel",
35 "desc" : "(Optional)",
36 "memberOf" : "Roo.grid.ColumnModel",
42 "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>",
43 "memberOf" : "Roo.util.Observable",
49 "desc" : "(Optional)",
50 "memberOf" : "Roo.grid.ColumnModel",
56 "desc" : "(Optional)",
57 "memberOf" : "Roo.grid.ColumnModel",
63 "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
64 "memberOf" : "Roo.grid.ColumnModel",
70 "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
71 "memberOf" : "Roo.grid.ColumnModel",
77 "desc" : "(Optional) True to hide the column. Defaults to false.",
78 "memberOf" : "Roo.grid.ColumnModel",
84 "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
85 "memberOf" : "Roo.grid.ColumnModel",
91 "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
92 "memberOf" : "Roo.grid.ColumnModel",
98 "desc" : "(Optional)",
99 "memberOf" : "Roo.grid.ColumnModel",
105 "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",
106 "memberOf" : "Roo.grid.ColumnModel",
112 "desc" : "(Optional)",
113 "memberOf" : "Roo.grid.ColumnModel",
119 "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}.",
120 "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",
133 "desc" : "The header text to display in the Grid view.",
134 "memberOf" : "Roo.grid.ColumnModel",
138 "name" : "resizable",
140 "desc" : "(Optional) False to disable column resizing. Defaults to true.",
141 "memberOf" : "Roo.grid.ColumnModel",
145 "name" : "dataIndex",
147 "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.",
148 "memberOf" : "Roo.grid.ColumnModel",
154 "desc" : "(Optional)",
155 "memberOf" : "Roo.grid.ColumnModel",
161 "name" : "setRenderer",
162 "desc" : "Sets the rendering (formatting) function for a column.",
164 "isConstructor" : false,
166 "memberOf" : "Roo.grid.ColumnModel",
175 "desc" : "The column index",
181 "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>",
189 "desc" : "Returns true if the column is hidden.",
191 "isConstructor" : false,
193 "memberOf" : "Roo.grid.ColumnModel",
202 "desc" : "The column index",
215 "name" : "setColumnHeader",
216 "desc" : "Sets the header for a column.",
218 "isConstructor" : false,
220 "memberOf" : "Roo.grid.ColumnModel",
229 "desc" : "The column index",
235 "desc" : "The new header",
242 "name" : "getColumnCount",
243 "desc" : "Returns the number of columns.",
245 "isConstructor" : false,
247 "memberOf" : "Roo.grid.ColumnModel",
262 "name" : "getColumnHeader",
263 "desc" : "Returns the header for the specified column.",
265 "isConstructor" : false,
267 "memberOf" : "Roo.grid.ColumnModel",
276 "desc" : "The column index",
289 "name" : "getRenderer",
290 "desc" : "Returns the rendering (formatting) function defined for the column.",
292 "isConstructor" : false,
294 "memberOf" : "Roo.grid.ColumnModel",
303 "desc" : "The column index.",
311 "desc" : "The function used to render the cell. See {@link #setRenderer}."
316 "name" : "getColumnTooltip",
317 "desc" : "Returns the tooltip for the specified column.",
319 "isConstructor" : false,
321 "memberOf" : "Roo.grid.ColumnModel",
330 "desc" : "The column index",
343 "name" : "setColumnWidth",
344 "desc" : "Sets the width for a column.",
346 "isConstructor" : false,
348 "memberOf" : "Roo.grid.ColumnModel",
357 "desc" : "The column index",
363 "desc" : "The new width",
370 "name" : "setDataIndex",
371 "desc" : "Sets the dataIndex for a column.",
373 "isConstructor" : false,
375 "memberOf" : "Roo.grid.ColumnModel",
384 "desc" : "The column index",
388 "name" : "dataIndex",
390 "desc" : "The new dataIndex",
397 "name" : "isCellEditable",
398 "desc" : "Returns true if the cell is editable.",
400 "isConstructor" : false,
402 "memberOf" : "Roo.grid.ColumnModel",
411 "desc" : "The column index",
417 "desc" : "The row index - this is nto actually used..?",
430 "name" : "getColumnsBy",
431 "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
433 "isConstructor" : false,
435 "memberOf" : "Roo.grid.ColumnModel",
450 "desc" : "(optional)",
463 "name" : "getColumnWidth",
464 "desc" : "Returns the width for the specified column.",
466 "isConstructor" : false,
468 "memberOf" : "Roo.grid.ColumnModel",
477 "desc" : "The column index",
491 "desc" : "Returns true if the column width cannot be changed",
493 "isConstructor" : false,
495 "memberOf" : "Roo.grid.ColumnModel",
504 "name" : "getCellEditor",
505 "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
507 "isConstructor" : false,
509 "memberOf" : "Roo.grid.ColumnModel",
518 "desc" : "The column index",
524 "desc" : "The row index",
537 "name" : "getColumnId",
538 "desc" : "Returns the id of the column at the specified index.",
540 "isConstructor" : false,
542 "memberOf" : "Roo.grid.ColumnModel",
551 "desc" : "The column index",
564 "name" : "getDataIndex",
565 "desc" : "Returns the dataIndex for the specified column.",
567 "isConstructor" : false,
569 "memberOf" : "Roo.grid.ColumnModel",
578 "desc" : "The column index",
591 "name" : "isResizable",
592 "desc" : "Returns true if the column can be resized",
594 "isConstructor" : false,
596 "memberOf" : "Roo.grid.ColumnModel",
611 "name" : "setColumnTooltip",
612 "desc" : "Sets the tooltip for a column.",
614 "isConstructor" : false,
616 "memberOf" : "Roo.grid.ColumnModel",
625 "desc" : "The column index",
631 "desc" : "The new tooltip",
638 "name" : "setHidden",
639 "desc" : "Sets if a column is hidden.",
641 "isConstructor" : false,
643 "memberOf" : "Roo.grid.ColumnModel",
652 "desc" : "The column index",
658 "desc" : "True if the column is hidden",
665 "name" : "setEditable",
666 "desc" : "Sets if a column is editable.",
668 "isConstructor" : false,
670 "memberOf" : "Roo.grid.ColumnModel",
679 "desc" : "The column index",
685 "desc" : "True if the column is editable",
692 "name" : "getColumnById",
693 "desc" : "Returns the column for a specified id.",
695 "isConstructor" : false,
697 "memberOf" : "Roo.grid.ColumnModel",
706 "desc" : "The column id",
714 "desc" : "the column"
719 "name" : "getColumnByDataIndex",
720 "desc" : "Returns the column for a specified dataIndex.",
722 "isConstructor" : false,
724 "memberOf" : "Roo.grid.ColumnModel",
731 "name" : "dataIndex",
733 "desc" : "The column dataIndex",
740 "type" : "Object|Boolean",
741 "desc" : "the column or false if not found"
746 "name" : "setEditor",
747 "desc" : "Sets the editor for a column.",
749 "isConstructor" : false,
751 "memberOf" : "Roo.grid.ColumnModel",
760 "desc" : "The column index",
766 "desc" : "The editor object",
773 "name" : "findColumnIndex",
774 "desc" : "Returns the index for a specified column dataIndex.",
776 "isConstructor" : false,
778 "memberOf" : "Roo.grid.ColumnModel",
785 "name" : "dataIndex",
787 "desc" : "The column dataIndex",
795 "desc" : "the index, or -1 if not found"
800 "name" : "isSortable",
801 "desc" : "Returns true if the specified column is sortable.",
803 "isConstructor" : false,
805 "memberOf" : "Roo.grid.ColumnModel",
814 "desc" : "The column index",
827 "name" : "getIndexById",
828 "desc" : "Returns the index for a specified column id.",
830 "isConstructor" : false,
832 "memberOf" : "Roo.grid.ColumnModel",
841 "desc" : "The column id",
849 "desc" : "the index, or -1 if not found"
854 "name" : "getTotalWidth",
855 "desc" : "Returns the total width of all columns.",
857 "isConstructor" : false,
859 "memberOf" : "Roo.grid.ColumnModel",
866 "name" : "includeHidden",
868 "desc" : "True to include hidden column widths",
881 "name" : "purgeListeners",
882 "desc" : "Removes all listeners for this object",
884 "isConstructor" : false,
886 "memberOf" : "Roo.util.Observable",
896 "desc" : "Appends an event handler to this element (shorthand for addListener)",
898 "isConstructor" : false,
900 "memberOf" : "Roo.util.Observable",
907 "name" : "eventName",
909 "desc" : "The type of event to listen for",
915 "desc" : "The method the event invokes",
921 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
927 "desc" : "(optional)",
935 "desc" : "Removes a listener (shorthand for removeListener)",
937 "isConstructor" : false,
939 "memberOf" : "Roo.util.Observable",
946 "name" : "eventName",
948 "desc" : "The type of event to listen for",
954 "desc" : "The handler to remove",
960 "desc" : "(optional) The scope (this object) for the handler",
967 "name" : "addEvents",
968 "desc" : "Used to define events on this Observable",
970 "isConstructor" : false,
972 "memberOf" : "Roo.util.Observable",
981 "desc" : "The object with the events defined",
988 "name" : "releaseCapture",
989 "desc" : "Removes <b>all</b> added captures from the Observable.",
991 "isConstructor" : false,
993 "memberOf" : "Roo.util.Observable",
1001 "type" : "Observable",
1002 "desc" : "The Observable to release",
1003 "isOptional" : false
1009 "name" : "removeListener",
1010 "desc" : "Removes a listener",
1012 "isConstructor" : false,
1013 "isPrivate" : false,
1014 "memberOf" : "Roo.util.Observable",
1021 "name" : "eventName",
1023 "desc" : "The type of event to listen for",
1024 "isOptional" : false
1028 "type" : "Function",
1029 "desc" : "The handler to remove",
1030 "isOptional" : false
1035 "desc" : "(optional) The scope (this object) for the handler",
1036 "isOptional" : false
1042 "name" : "fireEvent",
1043 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1045 "isConstructor" : false,
1046 "isPrivate" : false,
1047 "memberOf" : "Roo.util.Observable",
1054 "name" : "eventName",
1057 "isOptional" : false
1061 "type" : "Object...",
1062 "desc" : "Variable number of parameters are passed to handlers",
1063 "isOptional" : false
1070 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1075 "name" : "hasListener",
1076 "desc" : "Checks to see if this object has any listeners for a specified event",
1078 "isConstructor" : false,
1079 "isPrivate" : false,
1080 "memberOf" : "Roo.util.Observable",
1087 "name" : "eventName",
1089 "desc" : "The name of the event to check for",
1090 "isOptional" : false
1097 "desc" : "True if the event is being listened for, else false"
1103 "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.",
1105 "isConstructor" : false,
1106 "isPrivate" : false,
1107 "memberOf" : "Roo.util.Observable",
1115 "type" : "Observable",
1116 "desc" : "The Observable to capture",
1117 "isOptional" : false
1121 "type" : "Function",
1122 "desc" : "The function to call",
1123 "isOptional" : false
1128 "desc" : "(optional) The scope (this object) for the fn",
1129 "isOptional" : false
1135 "name" : "addListener",
1136 "desc" : "Appends an event handler to this component",
1138 "isConstructor" : false,
1139 "isPrivate" : false,
1140 "memberOf" : "Roo.util.Observable",
1147 "name" : "eventName",
1149 "desc" : "The type of event to listen for",
1150 "isOptional" : false
1154 "type" : "Function",
1155 "desc" : "The method the event invokes",
1156 "isOptional" : false
1161 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1162 "isOptional" : false
1167 "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>",
1168 "isOptional" : false
1176 "name" : "hiddenchange",
1177 "desc" : "Fires when a column is hidden or \"unhidden\".",
1178 "memberOf" : "Roo.grid.ColumnModel",
1186 "type" : "ColumnModel",
1188 "isOptional" : false
1191 "name" : "columnIndex",
1193 "desc" : "The column index",
1194 "isOptional" : false
1199 "desc" : "true if hidden, false otherwise",
1200 "isOptional" : false
1206 "name" : "headerchange",
1207 "desc" : "Fires when the text of a header changes.",
1208 "memberOf" : "Roo.grid.ColumnModel",
1216 "type" : "ColumnModel",
1218 "isOptional" : false
1221 "name" : "columnIndex",
1223 "desc" : "The column index",
1224 "isOptional" : false
1229 "desc" : "The new header text",
1230 "isOptional" : false
1236 "name" : "columlockchange",
1237 "desc" : "Fires when a column's locked state is changed",
1238 "memberOf" : "Roo.grid.ColumnModel",
1246 "type" : "ColumnModel",
1248 "isOptional" : false
1251 "name" : "colIndex",
1254 "isOptional" : false
1259 "desc" : "true if locked",
1260 "isOptional" : false
1266 "name" : "columnmoved",
1267 "desc" : "Fires when a column is moved.",
1268 "memberOf" : "Roo.grid.ColumnModel",
1276 "type" : "ColumnModel",
1278 "isOptional" : false
1281 "name" : "oldIndex",
1284 "isOptional" : false
1287 "name" : "newIndex",
1290 "isOptional" : false
1296 "name" : "widthchange",
1297 "desc" : "Fires when the width of a column changes.",
1298 "memberOf" : "Roo.grid.ColumnModel",
1306 "type" : "ColumnModel",
1308 "isOptional" : false
1311 "name" : "columnIndex",
1313 "desc" : "The column index",
1314 "isOptional" : false
1317 "name" : "newWidth",
1319 "desc" : "The new width",
1320 "isOptional" : false