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/>",
12 "name" : "autoSizeColumns",
14 "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.",
15 "memberOf" : "Roo.grid.Grid",
22 "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>",
23 "memberOf" : "Roo.util.Observable",
28 "name" : "maxRowsToMeasure",
30 "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).",
31 "memberOf" : "Roo.grid.Grid",
36 "name" : "minColumnWidth",
38 "desc" : "The minimum width a column can be resized to. Default is 25.",
39 "memberOf" : "Roo.grid.Grid",
44 "name" : "autoExpandColumn",
46 "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.",
47 "memberOf" : "Roo.grid.Grid",
52 "name" : "autoExpandMax",
54 "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
55 "memberOf" : "Roo.grid.Grid",
60 "name" : "enableRowHeightSync",
62 "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
63 "memberOf" : "Roo.grid.Grid",
68 "name" : "monitorWindowResize",
70 "desc" : "True to autoSize the grid when the window resizes. Default is true.",
71 "memberOf" : "Roo.grid.Grid",
76 "name" : "autoExpandMin",
78 "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
79 "memberOf" : "Roo.grid.Grid",
86 "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
87 "memberOf" : "Roo.grid.Grid",
94 "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.",
95 "memberOf" : "Roo.grid.Grid",
102 "desc" : "- drag drop group.",
103 "memberOf" : "Roo.grid.Grid",
108 "name" : "enableDrag",
110 "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
111 "memberOf" : "Roo.grid.Grid",
116 "name" : "maxHeight",
118 "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
119 "memberOf" : "Roo.grid.Grid",
124 "name" : "trackMouseOver",
126 "desc" : "True to highlight rows when the mouse is over. Default is true.",
127 "memberOf" : "Roo.grid.Grid",
134 "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
135 "memberOf" : "Roo.grid.Grid",
140 "name" : "stripeRows",
142 "desc" : "True to stripe the rows. Default is true.",
143 "memberOf" : "Roo.grid.Grid",
148 "name" : "enableColumnMove",
150 "desc" : "True to enable drag and drop reorder of columns. Default is true.",
151 "memberOf" : "Roo.grid.Grid",
156 "name" : "enableColumnHide",
158 "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
159 "memberOf" : "Roo.grid.Grid",
164 "name" : "autoSizeHeaders",
166 "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
167 "memberOf" : "Roo.grid.Grid",
172 "name" : "enableDragDrop",
174 "desc" : "True to enable drag and drop of rows. Default is false.",
175 "memberOf" : "Roo.grid.Grid",
180 "name" : "dropTarget",
181 "type" : "Roo.dd.DropTarget",
182 "desc" : "An {@link Roo.dd.DropTarget} config",
183 "memberOf" : "Roo.grid.Grid",
188 "name" : "autoHeight",
190 "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
191 "memberOf" : "Roo.grid.Grid",
198 "name" : "getSelectionModel",
199 "desc" : "Returns the grid's SelectionModel.",
201 "isConstructor" : false,
203 "memberOf" : "Roo.grid.Grid",
213 "type" : "SelectionModel",
220 "desc" : "Destroy this grid.",
222 "isConstructor" : false,
224 "memberOf" : "Roo.grid.Grid",
233 "desc" : "True to remove the element",
241 "name" : "getColumnModel",
242 "desc" : "Returns the grid's ColumnModel.",
244 "isConstructor" : false,
246 "memberOf" : "Roo.grid.Grid",
256 "type" : "ColumnModel",
262 "name" : "getGridEl",
263 "desc" : "Returns the grid's underlying element.",
265 "isConstructor" : false,
267 "memberOf" : "Roo.grid.Grid",
278 "desc" : "The element"
283 "name" : "getDataSource",
284 "desc" : "Returns the grid's DataSource.",
286 "isConstructor" : false,
288 "memberOf" : "Roo.grid.Grid",
298 "type" : "DataSource",
305 "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.",
307 "isConstructor" : false,
309 "memberOf" : "Roo.grid.Grid",
321 "desc" : "Returns the grid's GridView object.",
323 "isConstructor" : false,
325 "memberOf" : "Roo.grid.Grid",
341 "name" : "getDragDropText",
342 "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
344 "isConstructor" : false,
346 "memberOf" : "Roo.grid.Grid",
362 "name" : "reconfigure",
363 "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
365 "isConstructor" : false,
367 "memberOf" : "Roo.grid.Grid",
374 "name" : "dataSource",
375 "type" : "Roo.data.Store",
376 "desc" : "The new {@link Roo.data.Store} object",
381 "type" : "Roo.grid.ColumnModel",
382 "desc" : "new {@link Roo.grid.ColumnModel} object",
391 "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
393 "isConstructor" : false,
395 "memberOf" : "Roo.grid.Grid",
405 "type" : "Roo.grid.Grid",
411 "name" : "purgeListeners",
412 "desc" : "Removes all listeners for this object",
414 "isConstructor" : false,
416 "memberOf" : "Roo.util.Observable",
428 "desc" : "Appends an event handler to this element (shorthand for addListener)",
430 "isConstructor" : false,
432 "memberOf" : "Roo.util.Observable",
439 "name" : "eventName",
441 "desc" : "The type of event to listen for",
447 "desc" : "The method the event invokes",
453 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
459 "desc" : "(optional)",
468 "desc" : "Removes a listener (shorthand for removeListener)",
470 "isConstructor" : false,
472 "memberOf" : "Roo.util.Observable",
479 "name" : "eventName",
481 "desc" : "The type of event to listen for",
487 "desc" : "The handler to remove",
493 "desc" : "(optional) The scope (this object) for the handler",
501 "name" : "addEvents",
502 "desc" : "Used to define events on this Observable",
504 "isConstructor" : false,
506 "memberOf" : "Roo.util.Observable",
515 "desc" : "The object with the events defined",
523 "name" : "releaseCapture",
524 "desc" : "Removes <b>all</b> added captures from the Observable.",
526 "isConstructor" : false,
528 "memberOf" : "Roo.util.Observable",
536 "type" : "Observable",
537 "desc" : "The Observable to release",
545 "name" : "removeListener",
546 "desc" : "Removes a listener",
548 "isConstructor" : false,
550 "memberOf" : "Roo.util.Observable",
557 "name" : "eventName",
559 "desc" : "The type of event to listen for",
565 "desc" : "The handler to remove",
571 "desc" : "(optional) The scope (this object) for the handler",
579 "name" : "fireEvent",
580 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
582 "isConstructor" : false,
584 "memberOf" : "Roo.util.Observable",
591 "name" : "eventName",
598 "type" : "Object...",
599 "desc" : "Variable number of parameters are passed to handlers",
607 "desc" : "returns false if any of the handlers return false otherwise it returns true"
612 "name" : "hasListener",
613 "desc" : "Checks to see if this object has any listeners for a specified event",
615 "isConstructor" : false,
617 "memberOf" : "Roo.util.Observable",
624 "name" : "eventName",
626 "desc" : "The name of the event to check for",
634 "desc" : "True if the event is being listened for, else false"
640 "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.",
642 "isConstructor" : false,
644 "memberOf" : "Roo.util.Observable",
652 "type" : "Observable",
653 "desc" : "The Observable to capture",
659 "desc" : "The function to call",
665 "desc" : "(optional) The scope (this object) for the fn",
673 "name" : "addListener",
674 "desc" : "Appends an event handler to this component",
676 "isConstructor" : false,
678 "memberOf" : "Roo.util.Observable",
685 "name" : "eventName",
687 "desc" : "The type of event to listen for",
693 "desc" : "The method the event invokes",
699 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
705 "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>",
715 "name" : "rowcontextmenu",
716 "desc" : "Fires when a row is right clicked",
737 "type" : "Roo.EventObject",
746 "name" : "columnmove",
747 "desc" : "Fires when the user moves a column",
771 "name" : "headercontextmenu",
772 "desc" : "Fires when a header is right clicked",
786 "name" : "columnIndex",
793 "type" : "Roo.EventObject",
803 "desc" : "Fires when the grid is rendered",
821 "name" : "bodyscroll",
822 "desc" : "Fires when the body element is scrolled",
830 "name" : "scrollLeft",
836 "name" : "scrollTop",
846 "name" : "columnresize",
847 "desc" : "Fires when the user resizes a column",
855 "name" : "columnIndex",
872 "desc" : "Fires when a drag operation is complete",
887 "type" : "Roo.GridDD",
888 "desc" : "The drag drop object",
894 "desc" : "The raw browser event",
903 "desc" : "The raw mouseout event for the entire grid.",
912 "type" : "Roo.EventObject",
921 "name" : "cellclick",
922 "desc" : "Fires when a cell is clicked",
942 "name" : "columnIndex",
949 "type" : "Roo.EventObject",
959 "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.",
974 "type" : "Roo.GridDD",
975 "desc" : "The drag drop object",
981 "desc" : "The target drag drop object",
987 "desc" : "The raw browser event",
996 "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1004 "name" : "gridview",
1005 "type" : "GridView",
1006 "desc" : "The grid view",
1007 "isOptional" : false
1012 "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
1013 "isOptional" : false
1021 "desc" : "The raw keydown event for the entire grid.",
1030 "type" : "Roo.EventObject",
1032 "isOptional" : false
1039 "name" : "mousedown",
1040 "desc" : "The raw mousedown event for the entire grid.",
1049 "type" : "Roo.EventObject",
1051 "isOptional" : false
1058 "name" : "dragenter",
1059 "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1070 "isOptional" : false
1074 "type" : "Roo.GridDD",
1075 "desc" : "The drag drop object",
1076 "isOptional" : false
1079 "name" : "targetId",
1081 "desc" : "The target drag drop object",
1082 "isOptional" : false
1087 "desc" : "The raw browser event",
1088 "isOptional" : false
1096 "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1107 "isOptional" : false
1111 "type" : "Roo.GridDD",
1112 "desc" : "The drag drop object",
1113 "isOptional" : false
1116 "name" : "targetId",
1118 "desc" : "The target drag drop object",
1119 "isOptional" : false
1124 "desc" : "The raw browser event",
1125 "isOptional" : false
1133 "desc" : "The raw mouseup event for the entire grid.",
1142 "type" : "Roo.EventObject",
1144 "isOptional" : false
1151 "name" : "keypress",
1152 "desc" : "The raw keypress event for the entire grid.",
1161 "type" : "Roo.EventObject",
1163 "isOptional" : false
1170 "name" : "headerclick",
1171 "desc" : "Fires when a header is clicked",
1182 "isOptional" : false
1185 "name" : "columnIndex",
1188 "isOptional" : false
1192 "type" : "Roo.EventObject",
1194 "isOptional" : false
1201 "name" : "mouseover",
1202 "desc" : "The raw mouseover event for the entire grid.",
1211 "type" : "Roo.EventObject",
1213 "isOptional" : false
1220 "name" : "headerdblclick",
1221 "desc" : "Fires when a header cell is double clicked",
1232 "isOptional" : false
1235 "name" : "columnIndex",
1238 "isOptional" : false
1242 "type" : "Roo.EventObject",
1244 "isOptional" : false
1251 "name" : "dragdrop",
1252 "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1263 "isOptional" : false
1267 "type" : "Roo.GridDD",
1268 "desc" : "The drag drop object",
1269 "isOptional" : false
1272 "name" : "targetId",
1274 "desc" : "The target drag drop object",
1275 "isOptional" : false
1280 "desc" : "The raw browser event",
1281 "isOptional" : false
1288 "name" : "rowclick",
1289 "desc" : "Fires when a row is clicked",
1300 "isOptional" : false
1303 "name" : "rowIndex",
1306 "isOptional" : false
1310 "type" : "Roo.EventObject",
1312 "isOptional" : false
1320 "desc" : "The raw click event for the entire grid.",
1329 "type" : "Roo.EventObject",
1331 "isOptional" : false
1338 "name" : "rowdblclick",
1339 "desc" : "Fires when a row is double clicked",
1350 "isOptional" : false
1353 "name" : "rowIndex",
1356 "isOptional" : false
1360 "type" : "Roo.EventObject",
1362 "isOptional" : false
1369 "name" : "startdrag",
1370 "desc" : "Fires when row(s) start being dragged",
1381 "isOptional" : false
1385 "type" : "Roo.GridDD",
1386 "desc" : "The drag drop object",
1387 "isOptional" : false
1392 "desc" : "The raw browser event",
1393 "isOptional" : false
1400 "name" : "dblclick",
1401 "desc" : "The raw dblclick event for the entire grid.",
1410 "type" : "Roo.EventObject",
1412 "isOptional" : false
1419 "name" : "cellcontextmenu",
1420 "desc" : "Fires when a cell is right clicked",
1431 "isOptional" : false
1434 "name" : "rowIndex",
1437 "isOptional" : false
1440 "name" : "cellIndex",
1443 "isOptional" : false
1447 "type" : "Roo.EventObject",
1449 "isOptional" : false
1456 "name" : "contextmenu",
1457 "desc" : "The raw contextmenu event for the entire grid.",
1466 "type" : "Roo.EventObject",
1468 "isOptional" : false
1475 "name" : "celldblclick",
1476 "desc" : "Fires when a cell is double clicked",
1487 "isOptional" : false
1490 "name" : "rowIndex",
1493 "isOptional" : false
1496 "name" : "columnIndex",
1499 "isOptional" : false
1503 "type" : "Roo.EventObject",
1505 "isOptional" : false