2 "name" : "Roo.grid.EditorGrid",
7 "desc" : "Class for creating and editable grid.",
11 "memberOf" : "EditorGrid",
19 "type" : "String/HTMLElement/Roo.Element",
20 "desc" : "The element into which this grid will be rendered - \nThe container MUST have some type of size defined for the grid to fill. The container will be \nautomatically set to position relative if it isn't already.",
24 "name" : "dataSource",
26 "desc" : "The data model to bind to",
32 "desc" : "The column model with info about this grid's columns",
41 "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>",
42 "memberOf" : "Roo.util.Observable",
46 "name" : "autoSizeColumns",
48 "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
49 "memberOf" : "Roo.grid.Grid",
53 "name" : "maxRowsToMeasure",
55 "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
56 "memberOf" : "Roo.grid.Grid",
60 "name" : "minColumnWidth",
62 "desc" : "The minimum width a column can be resized to. Default is 25.",
63 "memberOf" : "Roo.grid.Grid",
69 "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
70 "memberOf" : "Roo.grid.Grid",
74 "name" : "autoExpandColumn",
76 "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
77 "memberOf" : "Roo.grid.Grid",
81 "name" : "autoExpandMax",
83 "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
84 "memberOf" : "Roo.grid.Grid",
88 "name" : "enableRowHeightSync",
90 "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
91 "memberOf" : "Roo.grid.Grid",
95 "name" : "enableDrop",
97 "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
98 "memberOf" : "Roo.grid.Grid",
102 "name" : "monitorWindowResize",
104 "desc" : "True to autoSize the grid when the window resizes. Default is true.",
105 "memberOf" : "Roo.grid.Grid",
109 "name" : "autoExpandMin",
111 "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
112 "memberOf" : "Roo.grid.Grid",
118 "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
119 "memberOf" : "Roo.grid.Grid",
123 "name" : "enableDrag",
125 "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
126 "memberOf" : "Roo.grid.Grid",
132 "desc" : "- drag drop group.",
133 "memberOf" : "Roo.grid.Grid",
137 "name" : "autoWidth",
139 "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
140 "memberOf" : "Roo.grid.Grid",
144 "name" : "maxHeight",
146 "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
147 "memberOf" : "Roo.grid.Grid",
151 "name" : "trackMouseOver",
153 "desc" : "True to highlight rows when the mouse is over. Default is true.",
154 "memberOf" : "Roo.grid.Grid",
160 "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
161 "memberOf" : "Roo.grid.Grid",
165 "name" : "stripeRows",
167 "desc" : "True to stripe the rows. Default is true.",
168 "memberOf" : "Roo.grid.Grid",
172 "name" : "enableColumnMove",
174 "desc" : "True to enable drag and drop reorder of columns. Default is true.",
175 "memberOf" : "Roo.grid.Grid",
179 "name" : "enableColumnHide",
181 "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
182 "memberOf" : "Roo.grid.Grid",
186 "name" : "clicksToEdit",
188 "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
189 "memberOf" : "Roo.grid.EditorGrid",
193 "name" : "autoSizeHeaders",
195 "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
196 "memberOf" : "Roo.grid.Grid",
200 "name" : "enableDragDrop",
202 "desc" : "True to enable drag and drop of rows. Default is false.",
203 "memberOf" : "Roo.grid.Grid",
207 "name" : "dropTarget",
208 "type" : "Roo.dd.DropTarget",
209 "desc" : "An {@link Roo.dd.DropTarget} config",
210 "memberOf" : "Roo.grid.Grid",
214 "name" : "dragGroup",
216 "desc" : "- drag group (?? not sure if needed.)",
217 "memberOf" : "Roo.grid.Grid",
221 "name" : "autoHeight",
223 "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
224 "memberOf" : "Roo.grid.Grid",
230 "name" : "stopEditing",
231 "desc" : "Stops any active editing",
233 "isConstructor" : false,
235 "memberOf" : "Roo.grid.EditorGrid",
244 "name" : "getDragDropText",
245 "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
247 "isConstructor" : false,
249 "memberOf" : "Roo.grid.EditorGrid",
264 "name" : "startEditing",
265 "desc" : "Starts editing the specified for the specified row/column",
267 "isConstructor" : false,
269 "memberOf" : "Roo.grid.EditorGrid",
291 "name" : "getSelectionModel",
292 "desc" : "Returns the grid's SelectionModel.",
294 "isConstructor" : false,
296 "memberOf" : "Roo.grid.Grid",
305 "type" : "SelectionModel",
312 "desc" : "Destroy this grid.",
314 "isConstructor" : false,
316 "memberOf" : "Roo.grid.Grid",
325 "desc" : "True to remove the element",
332 "name" : "getColumnModel",
333 "desc" : "Returns the grid's ColumnModel.",
335 "isConstructor" : false,
337 "memberOf" : "Roo.grid.Grid",
346 "type" : "ColumnModel",
352 "name" : "getGridEl",
353 "desc" : "Returns the grid's underlying element.",
355 "isConstructor" : false,
357 "memberOf" : "Roo.grid.Grid",
367 "desc" : "The element"
372 "name" : "getDataSource",
373 "desc" : "Returns the grid's DataSource.",
375 "isConstructor" : false,
377 "memberOf" : "Roo.grid.Grid",
386 "type" : "DataSource",
393 "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
395 "isConstructor" : false,
397 "memberOf" : "Roo.grid.Grid",
407 "desc" : "Returns the grid's GridView object.",
409 "isConstructor" : false,
411 "memberOf" : "Roo.grid.Grid",
426 "name" : "reconfigure",
427 "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
429 "isConstructor" : false,
431 "memberOf" : "Roo.grid.Grid",
438 "name" : "dataSource",
439 "type" : "Roo.data.Store",
440 "desc" : "The new {@link Roo.data.Store} object",
445 "type" : "Roo.grid.ColumnModel",
446 "desc" : "new {@link Roo.grid.ColumnModel} object",
453 "name" : "addColumns",
454 "desc" : "addColumns\nAdd's a column, default at the end..",
456 "isConstructor" : false,
458 "memberOf" : "Roo.grid.Grid",
467 "desc" : "to add (default end)",
473 "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
481 "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
483 "isConstructor" : false,
485 "memberOf" : "Roo.grid.Grid",
494 "type" : "Roo.grid.Grid",
500 "name" : "purgeListeners",
501 "desc" : "Removes all listeners for this object",
503 "isConstructor" : false,
505 "memberOf" : "Roo.util.Observable",
515 "desc" : "Appends an event handler to this element (shorthand for addListener)",
517 "isConstructor" : false,
519 "memberOf" : "Roo.util.Observable",
526 "name" : "eventName",
528 "desc" : "The type of event to listen for",
534 "desc" : "The method the event invokes",
540 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
546 "desc" : "(optional)",
554 "desc" : "Removes a listener (shorthand for removeListener)",
556 "isConstructor" : false,
558 "memberOf" : "Roo.util.Observable",
565 "name" : "eventName",
567 "desc" : "The type of event to listen for",
573 "desc" : "The handler to remove",
579 "desc" : "(optional) The scope (this object) for the handler",
586 "name" : "addEvents",
587 "desc" : "Used to define events on this Observable",
589 "isConstructor" : false,
591 "memberOf" : "Roo.util.Observable",
600 "desc" : "The object with the events defined",
607 "name" : "releaseCapture",
608 "desc" : "Removes <b>all</b> added captures from the Observable.",
610 "isConstructor" : false,
612 "memberOf" : "Roo.util.Observable",
620 "type" : "Observable",
621 "desc" : "The Observable to release",
628 "name" : "removeListener",
629 "desc" : "Removes a listener",
631 "isConstructor" : false,
633 "memberOf" : "Roo.util.Observable",
640 "name" : "eventName",
642 "desc" : "The type of event to listen for",
648 "desc" : "The handler to remove",
654 "desc" : "(optional) The scope (this object) for the handler",
661 "name" : "fireEvent",
662 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
664 "isConstructor" : false,
666 "memberOf" : "Roo.util.Observable",
673 "name" : "eventName",
680 "type" : "Object...",
681 "desc" : "Variable number of parameters are passed to handlers",
689 "desc" : "returns false if any of the handlers return false otherwise it returns true"
694 "name" : "hasListener",
695 "desc" : "Checks to see if this object has any listeners for a specified event",
697 "isConstructor" : false,
699 "memberOf" : "Roo.util.Observable",
706 "name" : "eventName",
708 "desc" : "The name of the event to check for",
716 "desc" : "True if the event is being listened for, else false"
722 "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.",
724 "isConstructor" : false,
726 "memberOf" : "Roo.util.Observable",
734 "type" : "Observable",
735 "desc" : "The Observable to capture",
741 "desc" : "The function to call",
747 "desc" : "(optional) The scope (this object) for the fn",
754 "name" : "addListener",
755 "desc" : "Appends an event handler to this component",
757 "isConstructor" : false,
759 "memberOf" : "Roo.util.Observable",
766 "name" : "eventName",
768 "desc" : "The type of event to listen for",
774 "desc" : "The method the event invokes",
780 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
786 "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>",
795 "name" : "validateedit",
796 "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
797 "memberOf" : "Roo.grid.EditorGrid",
806 "desc" : "An edit event (see above for description)",
813 "name" : "beforeedit",
814 "desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
815 "memberOf" : "Roo.grid.EditorGrid",
824 "desc" : "An edit event (see above for description)",
831 "name" : "afteredit",
832 "desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
833 "memberOf" : "Roo.grid.EditorGrid",
842 "desc" : "An edit event (see above for description)",
849 "name" : "rowcontextmenu",
850 "desc" : "Fires when a row is right clicked",
851 "memberOf" : "Roo.grid.Grid",
871 "type" : "Roo.EventObject",
879 "name" : "columnmove",
880 "desc" : "Fires when the user moves a column",
881 "memberOf" : "Roo.grid.Grid",
903 "name" : "headercontextmenu",
904 "desc" : "Fires when a header is right clicked",
905 "memberOf" : "Roo.grid.Grid",
918 "name" : "columnIndex",
925 "type" : "Roo.EventObject",
934 "desc" : "Fires when the grid is rendered",
935 "memberOf" : "Roo.grid.Grid",
951 "name" : "bodyscroll",
952 "desc" : "Fires when the body element is scrolled",
953 "memberOf" : "Roo.grid.Grid",
960 "name" : "scrollLeft",
966 "name" : "scrollTop",
975 "name" : "columnresize",
976 "desc" : "Fires when the user resizes a column",
977 "memberOf" : "Roo.grid.Grid",
984 "name" : "columnIndex",
1000 "desc" : "Fires when a drag operation is complete",
1001 "memberOf" : "Roo.grid.Grid",
1011 "isOptional" : false
1015 "type" : "Roo.GridDD",
1016 "desc" : "The drag drop object",
1017 "isOptional" : false
1022 "desc" : "The raw browser event",
1023 "isOptional" : false
1029 "name" : "mouseout",
1030 "desc" : "The raw mouseout event for the entire grid.",
1031 "memberOf" : "Roo.grid.Grid",
1039 "type" : "Roo.EventObject",
1041 "isOptional" : false
1047 "name" : "cellclick",
1048 "desc" : "Fires when a cell is clicked",
1049 "memberOf" : "Roo.grid.Grid",
1059 "isOptional" : false
1062 "name" : "rowIndex",
1065 "isOptional" : false
1068 "name" : "columnIndex",
1071 "isOptional" : false
1075 "type" : "Roo.EventObject",
1077 "isOptional" : false
1083 "name" : "dragover",
1084 "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
1085 "memberOf" : "Roo.grid.Grid",
1095 "isOptional" : false
1099 "type" : "Roo.GridDD",
1100 "desc" : "The drag drop object",
1101 "isOptional" : false
1104 "name" : "targetId",
1106 "desc" : "The target drag drop object",
1107 "isOptional" : false
1112 "desc" : "The raw browser event",
1113 "isOptional" : false
1119 "name" : "rowclass",
1120 "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1121 "memberOf" : "Roo.grid.Grid",
1128 "name" : "gridview",
1129 "type" : "GridView",
1130 "desc" : "The grid view",
1131 "isOptional" : false
1136 "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
1137 "isOptional" : false
1144 "desc" : "The raw keydown event for the entire grid.",
1145 "memberOf" : "Roo.grid.Grid",
1153 "type" : "Roo.EventObject",
1155 "isOptional" : false
1161 "name" : "mousedown",
1162 "desc" : "The raw mousedown event for the entire grid.",
1163 "memberOf" : "Roo.grid.Grid",
1171 "type" : "Roo.EventObject",
1173 "isOptional" : false
1179 "name" : "dragenter",
1180 "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1181 "memberOf" : "Roo.grid.Grid",
1191 "isOptional" : false
1195 "type" : "Roo.GridDD",
1196 "desc" : "The drag drop object",
1197 "isOptional" : false
1200 "name" : "targetId",
1202 "desc" : "The target drag drop object",
1203 "isOptional" : false
1208 "desc" : "The raw browser event",
1209 "isOptional" : false
1216 "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1217 "memberOf" : "Roo.grid.Grid",
1227 "isOptional" : false
1231 "type" : "Roo.GridDD",
1232 "desc" : "The drag drop object",
1233 "isOptional" : false
1236 "name" : "targetId",
1238 "desc" : "The target drag drop object",
1239 "isOptional" : false
1244 "desc" : "The raw browser event",
1245 "isOptional" : false
1252 "desc" : "The raw mouseup event for the entire grid.",
1253 "memberOf" : "Roo.grid.Grid",
1261 "type" : "Roo.EventObject",
1263 "isOptional" : false
1269 "name" : "keypress",
1270 "desc" : "The raw keypress event for the entire grid.",
1271 "memberOf" : "Roo.grid.Grid",
1279 "type" : "Roo.EventObject",
1281 "isOptional" : false
1287 "name" : "headerclick",
1288 "desc" : "Fires when a header is clicked",
1289 "memberOf" : "Roo.grid.Grid",
1299 "isOptional" : false
1302 "name" : "columnIndex",
1305 "isOptional" : false
1309 "type" : "Roo.EventObject",
1311 "isOptional" : false
1317 "name" : "mouseover",
1318 "desc" : "The raw mouseover event for the entire grid.",
1319 "memberOf" : "Roo.grid.Grid",
1327 "type" : "Roo.EventObject",
1329 "isOptional" : false
1335 "name" : "headerdblclick",
1336 "desc" : "Fires when a header cell is double clicked",
1337 "memberOf" : "Roo.grid.Grid",
1347 "isOptional" : false
1350 "name" : "columnIndex",
1353 "isOptional" : false
1357 "type" : "Roo.EventObject",
1359 "isOptional" : false
1365 "name" : "dragdrop",
1366 "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1367 "memberOf" : "Roo.grid.Grid",
1377 "isOptional" : false
1381 "type" : "Roo.GridDD",
1382 "desc" : "The drag drop object",
1383 "isOptional" : false
1386 "name" : "targetId",
1388 "desc" : "The target drag drop object",
1389 "isOptional" : false
1394 "desc" : "The raw browser event",
1395 "isOptional" : false
1401 "name" : "rowclick",
1402 "desc" : "Fires when a row is clicked",
1403 "memberOf" : "Roo.grid.Grid",
1413 "isOptional" : false
1416 "name" : "rowIndex",
1419 "isOptional" : false
1423 "type" : "Roo.EventObject",
1425 "isOptional" : false
1432 "desc" : "The raw click event for the entire grid.",
1433 "memberOf" : "Roo.grid.Grid",
1441 "type" : "Roo.EventObject",
1443 "isOptional" : false
1449 "name" : "rowdblclick",
1450 "desc" : "Fires when a row is double clicked",
1451 "memberOf" : "Roo.grid.Grid",
1461 "isOptional" : false
1464 "name" : "rowIndex",
1467 "isOptional" : false
1471 "type" : "Roo.EventObject",
1473 "isOptional" : false
1479 "name" : "startdrag",
1480 "desc" : "Fires when row(s) start being dragged",
1481 "memberOf" : "Roo.grid.Grid",
1491 "isOptional" : false
1495 "type" : "Roo.GridDD",
1496 "desc" : "The drag drop object",
1497 "isOptional" : false
1502 "desc" : "The raw browser event",
1503 "isOptional" : false
1509 "name" : "dblclick",
1510 "desc" : "The raw dblclick event for the entire grid.",
1511 "memberOf" : "Roo.grid.Grid",
1519 "type" : "Roo.EventObject",
1521 "isOptional" : false
1527 "name" : "cellcontextmenu",
1528 "desc" : "Fires when a cell is right clicked",
1529 "memberOf" : "Roo.grid.Grid",
1539 "isOptional" : false
1542 "name" : "rowIndex",
1545 "isOptional" : false
1548 "name" : "cellIndex",
1551 "isOptional" : false
1555 "type" : "Roo.EventObject",
1557 "isOptional" : false
1563 "name" : "contextmenu",
1564 "desc" : "The raw contextmenu event for the entire grid.",
1565 "memberOf" : "Roo.grid.Grid",
1573 "type" : "Roo.EventObject",
1575 "isOptional" : false
1581 "name" : "celldblclick",
1582 "desc" : "Fires when a cell is double clicked",
1583 "memberOf" : "Roo.grid.Grid",
1593 "isOptional" : false
1596 "name" : "rowIndex",
1599 "isOptional" : false
1602 "name" : "columnIndex",
1605 "isOptional" : false
1609 "type" : "Roo.EventObject",
1611 "isOptional" : false