2 "name" : "Roo.grid.Grid",
6 "desc" : "This class represents the primary interface of a component based grid control.\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.Grid(\"my-container-id\", {\n ds: myDataStore,\n cm: myColModel,\n selModel: mySelectionModel,\n autoSizeColumns: true,\n monitorWindowResize: false,\n trackMouseOver: true\n });\n // set any options\n grid.render();\n</code></pre>\n<b>Common Problems:</b><br/>\n- Grid does not resize properly when going smaller: Setting overflow hidden on the container\nelement will correct this<br/>\n- If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element\ndimensions. The grid adapts to your container's size, if your container has no size defined then the results\nare unpredictable.<br/>\n- Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the\ngrid to calculate dimensions/offsets.<br/>",
18 "type" : "String/HTMLElement/Roo.Element",
19 "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.",
25 "desc" : "A config object that sets properties on this grid.",
33 "name" : "autoSizeColumns",
35 "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.",
36 "memberOf" : "Roo.grid.Grid",
43 "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>",
44 "memberOf" : "Roo.util.Observable",
49 "name" : "maxRowsToMeasure",
51 "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).",
52 "memberOf" : "Roo.grid.Grid",
57 "name" : "minColumnWidth",
59 "desc" : "The minimum width a column can be resized to. Default is 25.",
60 "memberOf" : "Roo.grid.Grid",
65 "name" : "autoExpandColumn",
67 "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.",
68 "memberOf" : "Roo.grid.Grid",
73 "name" : "autoExpandMax",
75 "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
76 "memberOf" : "Roo.grid.Grid",
81 "name" : "enableRowHeightSync",
83 "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
84 "memberOf" : "Roo.grid.Grid",
89 "name" : "monitorWindowResize",
91 "desc" : "True to autoSize the grid when the window resizes. Default is true.",
92 "memberOf" : "Roo.grid.Grid",
97 "name" : "autoExpandMin",
99 "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
100 "memberOf" : "Roo.grid.Grid",
107 "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
108 "memberOf" : "Roo.grid.Grid",
113 "name" : "autoWidth",
115 "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.",
116 "memberOf" : "Roo.grid.Grid",
123 "desc" : "- drag drop group.",
124 "memberOf" : "Roo.grid.Grid",
129 "name" : "enableDrag",
131 "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
132 "memberOf" : "Roo.grid.Grid",
137 "name" : "maxHeight",
139 "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
140 "memberOf" : "Roo.grid.Grid",
145 "name" : "trackMouseOver",
147 "desc" : "True to highlight rows when the mouse is over. Default is true.",
148 "memberOf" : "Roo.grid.Grid",
155 "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
156 "memberOf" : "Roo.grid.Grid",
161 "name" : "stripeRows",
163 "desc" : "True to stripe the rows. Default is true.",
164 "memberOf" : "Roo.grid.Grid",
169 "name" : "enableColumnMove",
171 "desc" : "True to enable drag and drop reorder of columns. Default is true.",
172 "memberOf" : "Roo.grid.Grid",
177 "name" : "enableColumnHide",
179 "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
180 "memberOf" : "Roo.grid.Grid",
185 "name" : "autoSizeHeaders",
187 "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
188 "memberOf" : "Roo.grid.Grid",
193 "name" : "enableDragDrop",
195 "desc" : "True to enable drag and drop of rows. Default is false.",
196 "memberOf" : "Roo.grid.Grid",
201 "name" : "dropTarget",
202 "type" : "Roo.dd.DropTarget",
203 "desc" : "An {@link Roo.dd.DropTarget} config",
204 "memberOf" : "Roo.grid.Grid",
209 "name" : "autoHeight",
211 "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
212 "memberOf" : "Roo.grid.Grid",
219 "name" : "getSelectionModel",
220 "desc" : "Returns the grid's SelectionModel.",
222 "isConstructor" : false,
224 "memberOf" : "Roo.grid.Grid",
234 "type" : "SelectionModel",
241 "desc" : "Destroy this grid.",
243 "isConstructor" : false,
245 "memberOf" : "Roo.grid.Grid",
254 "desc" : "True to remove the element",
262 "name" : "getColumnModel",
263 "desc" : "Returns the grid's ColumnModel.",
265 "isConstructor" : false,
267 "memberOf" : "Roo.grid.Grid",
277 "type" : "ColumnModel",
283 "name" : "getGridEl",
284 "desc" : "Returns the grid's underlying element.",
286 "isConstructor" : false,
288 "memberOf" : "Roo.grid.Grid",
299 "desc" : "The element"
304 "name" : "getDataSource",
305 "desc" : "Returns the grid's DataSource.",
307 "isConstructor" : false,
309 "memberOf" : "Roo.grid.Grid",
319 "type" : "DataSource",
326 "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.",
328 "isConstructor" : false,
330 "memberOf" : "Roo.grid.Grid",
342 "desc" : "Returns the grid's GridView object.",
344 "isConstructor" : false,
346 "memberOf" : "Roo.grid.Grid",
362 "name" : "getDragDropText",
363 "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
365 "isConstructor" : false,
367 "memberOf" : "Roo.grid.Grid",
383 "name" : "reconfigure",
384 "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
386 "isConstructor" : false,
388 "memberOf" : "Roo.grid.Grid",
395 "name" : "dataSource",
396 "type" : "Roo.data.Store",
397 "desc" : "The new {@link Roo.data.Store} object",
402 "type" : "Roo.grid.ColumnModel",
403 "desc" : "new {@link Roo.grid.ColumnModel} object",
411 "name" : "addColumns",
412 "desc" : "addColumns\nAdd's a column, default at the end..",
414 "isConstructor" : false,
416 "memberOf" : "Roo.grid.Grid",
425 "desc" : "to add (default end)",
431 "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
440 "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
442 "isConstructor" : false,
444 "memberOf" : "Roo.grid.Grid",
454 "type" : "Roo.grid.Grid",
460 "name" : "purgeListeners",
461 "desc" : "Removes all listeners for this object",
463 "isConstructor" : false,
465 "memberOf" : "Roo.util.Observable",
477 "desc" : "Appends an event handler to this element (shorthand for addListener)",
479 "isConstructor" : false,
481 "memberOf" : "Roo.util.Observable",
488 "name" : "eventName",
490 "desc" : "The type of event to listen for",
496 "desc" : "The method the event invokes",
502 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
508 "desc" : "(optional)",
517 "desc" : "Removes a listener (shorthand for removeListener)",
519 "isConstructor" : false,
521 "memberOf" : "Roo.util.Observable",
528 "name" : "eventName",
530 "desc" : "The type of event to listen for",
536 "desc" : "The handler to remove",
542 "desc" : "(optional) The scope (this object) for the handler",
550 "name" : "addEvents",
551 "desc" : "Used to define events on this Observable",
553 "isConstructor" : false,
555 "memberOf" : "Roo.util.Observable",
564 "desc" : "The object with the events defined",
572 "name" : "releaseCapture",
573 "desc" : "Removes <b>all</b> added captures from the Observable.",
575 "isConstructor" : false,
577 "memberOf" : "Roo.util.Observable",
585 "type" : "Observable",
586 "desc" : "The Observable to release",
594 "name" : "removeListener",
595 "desc" : "Removes a listener",
597 "isConstructor" : false,
599 "memberOf" : "Roo.util.Observable",
606 "name" : "eventName",
608 "desc" : "The type of event to listen for",
614 "desc" : "The handler to remove",
620 "desc" : "(optional) The scope (this object) for the handler",
628 "name" : "fireEvent",
629 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
631 "isConstructor" : false,
633 "memberOf" : "Roo.util.Observable",
640 "name" : "eventName",
647 "type" : "Object...",
648 "desc" : "Variable number of parameters are passed to handlers",
656 "desc" : "returns false if any of the handlers return false otherwise it returns true"
661 "name" : "hasListener",
662 "desc" : "Checks to see if this object has any listeners for a specified event",
664 "isConstructor" : false,
666 "memberOf" : "Roo.util.Observable",
673 "name" : "eventName",
675 "desc" : "The name of the event to check for",
683 "desc" : "True if the event is being listened for, else false"
689 "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.",
691 "isConstructor" : false,
693 "memberOf" : "Roo.util.Observable",
701 "type" : "Observable",
702 "desc" : "The Observable to capture",
708 "desc" : "The function to call",
714 "desc" : "(optional) The scope (this object) for the fn",
722 "name" : "addListener",
723 "desc" : "Appends an event handler to this component",
725 "isConstructor" : false,
727 "memberOf" : "Roo.util.Observable",
734 "name" : "eventName",
736 "desc" : "The type of event to listen for",
742 "desc" : "The method the event invokes",
748 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
754 "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>",
764 "name" : "rowcontextmenu",
765 "desc" : "Fires when a row is right clicked",
766 "memberOf" : "Roo.grid.Grid",
786 "type" : "Roo.EventObject",
795 "name" : "columnmove",
796 "desc" : "Fires when the user moves a column",
797 "memberOf" : "Roo.grid.Grid",
820 "name" : "headercontextmenu",
821 "desc" : "Fires when a header is right clicked",
822 "memberOf" : "Roo.grid.Grid",
835 "name" : "columnIndex",
842 "type" : "Roo.EventObject",
852 "desc" : "Fires when the grid is rendered",
853 "memberOf" : "Roo.grid.Grid",
870 "name" : "bodyscroll",
871 "desc" : "Fires when the body element is scrolled",
872 "memberOf" : "Roo.grid.Grid",
879 "name" : "scrollLeft",
885 "name" : "scrollTop",
895 "name" : "columnresize",
896 "desc" : "Fires when the user resizes a column",
897 "memberOf" : "Roo.grid.Grid",
904 "name" : "columnIndex",
921 "desc" : "Fires when a drag operation is complete",
922 "memberOf" : "Roo.grid.Grid",
936 "type" : "Roo.GridDD",
937 "desc" : "The drag drop object",
943 "desc" : "The raw browser event",
952 "desc" : "The raw mouseout event for the entire grid.",
953 "memberOf" : "Roo.grid.Grid",
961 "type" : "Roo.EventObject",
970 "name" : "cellclick",
971 "desc" : "Fires when a cell is clicked",
972 "memberOf" : "Roo.grid.Grid",
991 "name" : "columnIndex",
998 "type" : "Roo.EventObject",
1000 "isOptional" : false
1007 "name" : "dragover",
1008 "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.",
1009 "memberOf" : "Roo.grid.Grid",
1019 "isOptional" : false
1023 "type" : "Roo.GridDD",
1024 "desc" : "The drag drop object",
1025 "isOptional" : false
1028 "name" : "targetId",
1030 "desc" : "The target drag drop object",
1031 "isOptional" : false
1036 "desc" : "The raw browser event",
1037 "isOptional" : false
1044 "name" : "rowclass",
1045 "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1046 "memberOf" : "Roo.grid.Grid",
1053 "name" : "gridview",
1054 "type" : "GridView",
1055 "desc" : "The grid view",
1056 "isOptional" : false
1061 "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
1062 "isOptional" : false
1070 "desc" : "The raw keydown event for the entire grid.",
1071 "memberOf" : "Roo.grid.Grid",
1079 "type" : "Roo.EventObject",
1081 "isOptional" : false
1088 "name" : "mousedown",
1089 "desc" : "The raw mousedown event for the entire grid.",
1090 "memberOf" : "Roo.grid.Grid",
1098 "type" : "Roo.EventObject",
1100 "isOptional" : false
1107 "name" : "dragenter",
1108 "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1109 "memberOf" : "Roo.grid.Grid",
1119 "isOptional" : false
1123 "type" : "Roo.GridDD",
1124 "desc" : "The drag drop object",
1125 "isOptional" : false
1128 "name" : "targetId",
1130 "desc" : "The target drag drop object",
1131 "isOptional" : false
1136 "desc" : "The raw browser event",
1137 "isOptional" : false
1145 "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1146 "memberOf" : "Roo.grid.Grid",
1156 "isOptional" : false
1160 "type" : "Roo.GridDD",
1161 "desc" : "The drag drop object",
1162 "isOptional" : false
1165 "name" : "targetId",
1167 "desc" : "The target drag drop object",
1168 "isOptional" : false
1173 "desc" : "The raw browser event",
1174 "isOptional" : false
1182 "desc" : "The raw mouseup event for the entire grid.",
1183 "memberOf" : "Roo.grid.Grid",
1191 "type" : "Roo.EventObject",
1193 "isOptional" : false
1200 "name" : "keypress",
1201 "desc" : "The raw keypress event for the entire grid.",
1202 "memberOf" : "Roo.grid.Grid",
1210 "type" : "Roo.EventObject",
1212 "isOptional" : false
1219 "name" : "headerclick",
1220 "desc" : "Fires when a header is clicked",
1221 "memberOf" : "Roo.grid.Grid",
1231 "isOptional" : false
1234 "name" : "columnIndex",
1237 "isOptional" : false
1241 "type" : "Roo.EventObject",
1243 "isOptional" : false
1250 "name" : "mouseover",
1251 "desc" : "The raw mouseover event for the entire grid.",
1252 "memberOf" : "Roo.grid.Grid",
1260 "type" : "Roo.EventObject",
1262 "isOptional" : false
1269 "name" : "headerdblclick",
1270 "desc" : "Fires when a header cell is double clicked",
1271 "memberOf" : "Roo.grid.Grid",
1281 "isOptional" : false
1284 "name" : "columnIndex",
1287 "isOptional" : false
1291 "type" : "Roo.EventObject",
1293 "isOptional" : false
1300 "name" : "dragdrop",
1301 "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1302 "memberOf" : "Roo.grid.Grid",
1312 "isOptional" : false
1316 "type" : "Roo.GridDD",
1317 "desc" : "The drag drop object",
1318 "isOptional" : false
1321 "name" : "targetId",
1323 "desc" : "The target drag drop object",
1324 "isOptional" : false
1329 "desc" : "The raw browser event",
1330 "isOptional" : false
1337 "name" : "rowclick",
1338 "desc" : "Fires when a row is clicked",
1339 "memberOf" : "Roo.grid.Grid",
1349 "isOptional" : false
1352 "name" : "rowIndex",
1355 "isOptional" : false
1359 "type" : "Roo.EventObject",
1361 "isOptional" : false
1369 "desc" : "The raw click event for the entire grid.",
1370 "memberOf" : "Roo.grid.Grid",
1378 "type" : "Roo.EventObject",
1380 "isOptional" : false
1387 "name" : "rowdblclick",
1388 "desc" : "Fires when a row is double clicked",
1389 "memberOf" : "Roo.grid.Grid",
1399 "isOptional" : false
1402 "name" : "rowIndex",
1405 "isOptional" : false
1409 "type" : "Roo.EventObject",
1411 "isOptional" : false
1418 "name" : "startdrag",
1419 "desc" : "Fires when row(s) start being dragged",
1420 "memberOf" : "Roo.grid.Grid",
1430 "isOptional" : false
1434 "type" : "Roo.GridDD",
1435 "desc" : "The drag drop object",
1436 "isOptional" : false
1441 "desc" : "The raw browser event",
1442 "isOptional" : false
1449 "name" : "dblclick",
1450 "desc" : "The raw dblclick event for the entire grid.",
1451 "memberOf" : "Roo.grid.Grid",
1459 "type" : "Roo.EventObject",
1461 "isOptional" : false
1468 "name" : "cellcontextmenu",
1469 "desc" : "Fires when a cell is right clicked",
1470 "memberOf" : "Roo.grid.Grid",
1480 "isOptional" : false
1483 "name" : "rowIndex",
1486 "isOptional" : false
1489 "name" : "cellIndex",
1492 "isOptional" : false
1496 "type" : "Roo.EventObject",
1498 "isOptional" : false
1505 "name" : "contextmenu",
1506 "desc" : "The raw contextmenu event for the entire grid.",
1507 "memberOf" : "Roo.grid.Grid",
1515 "type" : "Roo.EventObject",
1517 "isOptional" : false
1524 "name" : "celldblclick",
1525 "desc" : "Fires when a cell is double clicked",
1526 "memberOf" : "Roo.grid.Grid",
1536 "isOptional" : false
1539 "name" : "rowIndex",
1542 "isOptional" : false
1545 "name" : "columnIndex",
1548 "isOptional" : false
1552 "type" : "Roo.EventObject",
1554 "isOptional" : false