2 "name" : "Roo.grid.Grid",
8 "Roo.grid.PropertyGrid"
10 "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/>",
11 "isSingleton" : false,
22 "type" : "String/HTMLElement/Roo.Element",
23 "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.",
29 "desc" : "A config object that sets properties on this grid.",
38 "name" : "autoSizeColumns",
40 "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.",
46 "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>",
47 "memberOf" : "Roo.util.Observable"
51 "type" : "Roo.grid.ColumnModel",
52 "desc" : "The columns of the grid",
56 "name" : "maxRowsToMeasure",
58 "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).",
62 "name" : "minColumnWidth",
64 "desc" : "The minimum width a column can be resized to. Default is 25.",
70 "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
75 "type" : "Roo.Toolbar",
76 "desc" : "a toolbar for buttons etc.",
80 "name" : "autoExpandColumn",
82 "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.",
86 "name" : "autoExpandMax",
88 "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
92 "name" : "enableRowHeightSync",
94 "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
98 "name" : "enableDrop",
100 "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
104 "name" : "monitorWindowResize",
106 "desc" : "True to autoSize the grid when the window resizes. Default is true.",
110 "name" : "autoExpandMin",
112 "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
117 "type" : "Roo.grid.GridView",
118 "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
123 "type" : "Roo.grid.Store",
124 "desc" : "The data store for the grid",
130 "desc" : "- drag drop group.",
134 "name" : "enableDrag",
136 "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
140 "name" : "autoWidth",
142 "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.",
146 "name" : "maxHeight",
148 "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
152 "name" : "trackMouseOver",
154 "desc" : "True to highlight rows when the mouse is over. Default is true.",
160 "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
164 "name" : "stripeRows",
166 "desc" : "True to stripe the rows. Default is true.",
170 "name" : "enableColumnMove",
172 "desc" : "True to enable drag and drop reorder of columns. Default is true.",
176 "name" : "enableColumnHide",
178 "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
182 "name" : "autoSizeHeaders",
184 "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
188 "name" : "enableDragDrop",
190 "desc" : "True to enable drag and drop of rows. Default is false.",
194 "name" : "dropTarget",
195 "type" : "Roo.dd.DropTarget",
196 "desc" : "An {@link Roo.dd.DropTarget} config",
201 "type" : "Roo.grid.AbstractSelectionModel",
202 "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
206 "name" : "dragGroup",
208 "desc" : "- drag group (?? not sure if needed.)",
212 "name" : "autoHeight",
214 "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
220 "name" : "getSelectionModel",
222 "desc" : "Returns the grid's SelectionModel.",
223 "sig" : "()\n{\n\n}",
227 "isConstructor" : false,
239 "type" : "SelectionModel",
247 "desc" : "Destroy this grid.",
248 "sig" : "(removeEl)",
252 "isConstructor" : false,
264 "desc" : "True to remove the element",
271 "name" : "getColumnModel",
273 "desc" : "Returns the grid's ColumnModel.",
274 "sig" : "()\n{\n\n}",
278 "isConstructor" : false,
290 "type" : "ColumnModel",
296 "name" : "getGridEl",
298 "desc" : "Returns the grid's underlying element.",
299 "sig" : "()\n{\n\n}",
303 "isConstructor" : false,
316 "desc" : "The element"
321 "name" : "getDataSource",
323 "desc" : "Returns the grid's DataSource.",
324 "sig" : "()\n{\n\n}",
328 "isConstructor" : false,
340 "type" : "DataSource",
348 "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.",
349 "sig" : "()\n{\n\n}",
353 "isConstructor" : false,
367 "desc" : "Returns the grid's GridView object.",
368 "sig" : "()\n{\n\n}",
372 "isConstructor" : false,
390 "name" : "getDragDropText",
392 "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
393 "sig" : "()\n{\n\n}",
397 "isConstructor" : false,
415 "name" : "reconfigure",
417 "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
418 "sig" : "(dataSource, The)",
422 "isConstructor" : false,
432 "name" : "dataSource",
433 "type" : "Roo.data.Store",
434 "desc" : "The new {@link Roo.data.Store} object",
439 "type" : "Roo.grid.ColumnModel",
440 "desc" : "new {@link Roo.grid.ColumnModel} object",
447 "name" : "addColumns",
449 "desc" : "addColumns\nAdd's a column, default at the end..",
450 "sig" : "(position, of)",
454 "isConstructor" : false,
466 "desc" : "to add (default end)",
472 "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.",
482 "sig" : "()\n{\n\n}",
486 "isConstructor" : false,
498 "type" : "Roo.grid.Grid",
504 "name" : "purgeListeners",
506 "desc" : "Removes all listeners for this object",
507 "sig" : "()\n{\n\n}",
509 "memberOf" : "Roo.util.Observable",
511 "isConstructor" : false,
525 "desc" : "Appends an event handler to this element (shorthand for addListener)",
526 "sig" : "(eventName, handler, scope, options)",
528 "memberOf" : "Roo.util.Observable",
530 "isConstructor" : false,
540 "name" : "eventName",
542 "desc" : "The type of event to listen for",
548 "desc" : "The method the event invokes",
554 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
560 "desc" : "(optional)",
569 "desc" : "Removes a listener (shorthand for removeListener)",
570 "sig" : "(eventName, handler, scope)",
572 "memberOf" : "Roo.util.Observable",
574 "isConstructor" : false,
584 "name" : "eventName",
586 "desc" : "The type of event to listen for",
592 "desc" : "The handler to remove",
598 "desc" : "(optional) The scope (this object) for the handler",
605 "name" : "addEvents",
607 "desc" : "Used to define events on this Observable",
610 "memberOf" : "Roo.util.Observable",
612 "isConstructor" : false,
624 "desc" : "The object with the events defined",
631 "name" : "releaseCapture",
633 "desc" : "Removes <b>all</b> added captures from the Observable.",
636 "memberOf" : "Roo.util.Observable",
638 "isConstructor" : false,
649 "type" : "Observable",
650 "desc" : "The Observable to release",
657 "name" : "removeListener",
659 "desc" : "Removes a listener",
660 "sig" : "(eventName, handler, scope)",
662 "memberOf" : "Roo.util.Observable",
664 "isConstructor" : false,
674 "name" : "eventName",
676 "desc" : "The type of event to listen for",
682 "desc" : "The handler to remove",
688 "desc" : "(optional) The scope (this object) for the handler",
695 "name" : "fireEvent",
697 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
698 "sig" : "(eventName, args)",
700 "memberOf" : "Roo.util.Observable",
702 "isConstructor" : false,
712 "name" : "eventName",
719 "type" : "Object...",
720 "desc" : "Variable number of parameters are passed to handlers",
728 "desc" : "returns false if any of the handlers return false otherwise it returns true"
733 "name" : "hasListener",
735 "desc" : "Checks to see if this object has any listeners for a specified event",
736 "sig" : "(eventName)",
738 "memberOf" : "Roo.util.Observable",
740 "isConstructor" : false,
750 "name" : "eventName",
752 "desc" : "The name of the event to check for",
760 "desc" : "True if the event is being listened for, else false"
767 "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.",
768 "sig" : "(o, fn, scope)",
770 "memberOf" : "Roo.util.Observable",
772 "isConstructor" : false,
783 "type" : "Observable",
784 "desc" : "The Observable to capture",
790 "desc" : "The function to call",
796 "desc" : "(optional) The scope (this object) for the fn",
803 "name" : "addListener",
805 "desc" : "Appends an event handler to this component",
806 "sig" : "(eventName, handler, scope, options)",
808 "memberOf" : "Roo.util.Observable",
810 "isConstructor" : false,
820 "name" : "eventName",
822 "desc" : "The type of event to listen for",
828 "desc" : "The method the event invokes",
834 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
840 "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>",
849 "name" : "rowcontextmenu",
851 "desc" : "Fires when a row is right clicked",
852 "sig" : "function (_self, rowIndex, e)\n{\n\n}",
873 "type" : "Roo.EventObject",
881 "name" : "columnmove",
883 "desc" : "Fires when the user moves a column",
884 "sig" : "function (oldIndex, newIndex)\n{\n\n}",
907 "name" : "headercontextmenu",
909 "desc" : "Fires when a header is right clicked",
910 "sig" : "function (_self, columnIndex, e)\n{\n\n}",
924 "name" : "columnIndex",
931 "type" : "Roo.EventObject",
941 "desc" : "Fires when the grid is rendered",
942 "sig" : "function (grid)\n{\n\n}",
959 "name" : "bodyscroll",
961 "desc" : "Fires when the body element is scrolled",
962 "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
970 "name" : "scrollLeft",
976 "name" : "scrollTop",
985 "name" : "columnresize",
987 "desc" : "Fires when the user resizes a column",
988 "sig" : "function (columnIndex, newSize)\n{\n\n}",
996 "name" : "columnIndex",
1005 "isOptional" : false
1012 "type" : "function",
1013 "desc" : "Fires when a drag operation is complete",
1014 "sig" : "function (_self, dd, e)\n{\n\n}",
1025 "isOptional" : false
1029 "type" : "Roo.GridDD",
1030 "desc" : "The drag drop object",
1031 "isOptional" : false
1036 "desc" : "The raw browser event",
1037 "isOptional" : false
1043 "name" : "mouseout",
1044 "type" : "function",
1045 "desc" : "The raw mouseout event for the entire grid.",
1046 "sig" : "function (e)\n{\n\n}",
1055 "type" : "Roo.EventObject",
1057 "isOptional" : false
1063 "name" : "cellclick",
1064 "type" : "function",
1065 "desc" : "Fires when a cell is clicked",
1066 "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
1077 "isOptional" : false
1080 "name" : "rowIndex",
1083 "isOptional" : false
1086 "name" : "columnIndex",
1089 "isOptional" : false
1093 "type" : "Roo.EventObject",
1095 "isOptional" : false
1101 "name" : "dragover",
1102 "type" : "function",
1103 "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.",
1104 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1115 "isOptional" : false
1119 "type" : "Roo.GridDD",
1120 "desc" : "The drag drop object",
1121 "isOptional" : false
1124 "name" : "targetId",
1126 "desc" : "The target drag drop object",
1127 "isOptional" : false
1132 "desc" : "The raw browser event",
1133 "isOptional" : false
1139 "name" : "rowclass",
1140 "type" : "function",
1141 "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1142 "sig" : "function (gridview, rowcfg)\n{\n\n}",
1150 "name" : "gridview",
1151 "type" : "GridView",
1152 "desc" : "The grid view",
1153 "isOptional" : false
1158 "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
1159 "isOptional" : false
1166 "type" : "function",
1167 "desc" : "The raw keydown event for the entire grid.",
1168 "sig" : "function (e)\n{\n\n}",
1177 "type" : "Roo.EventObject",
1179 "isOptional" : false
1185 "name" : "mousedown",
1186 "type" : "function",
1187 "desc" : "The raw mousedown event for the entire grid.",
1188 "sig" : "function (e)\n{\n\n}",
1197 "type" : "Roo.EventObject",
1199 "isOptional" : false
1205 "name" : "dragenter",
1206 "type" : "function",
1207 "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1208 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1219 "isOptional" : false
1223 "type" : "Roo.GridDD",
1224 "desc" : "The drag drop object",
1225 "isOptional" : false
1228 "name" : "targetId",
1230 "desc" : "The target drag drop object",
1231 "isOptional" : false
1236 "desc" : "The raw browser event",
1237 "isOptional" : false
1244 "type" : "function",
1245 "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1246 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1257 "isOptional" : false
1261 "type" : "Roo.GridDD",
1262 "desc" : "The drag drop object",
1263 "isOptional" : false
1266 "name" : "targetId",
1268 "desc" : "The target drag drop object",
1269 "isOptional" : false
1274 "desc" : "The raw browser event",
1275 "isOptional" : false
1282 "type" : "function",
1283 "desc" : "The raw mouseup event for the entire grid.",
1284 "sig" : "function (e)\n{\n\n}",
1293 "type" : "Roo.EventObject",
1295 "isOptional" : false
1301 "name" : "keypress",
1302 "type" : "function",
1303 "desc" : "The raw keypress event for the entire grid.",
1304 "sig" : "function (e)\n{\n\n}",
1313 "type" : "Roo.EventObject",
1315 "isOptional" : false
1321 "name" : "headerclick",
1322 "type" : "function",
1323 "desc" : "Fires when a header is clicked",
1324 "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1335 "isOptional" : false
1338 "name" : "columnIndex",
1341 "isOptional" : false
1345 "type" : "Roo.EventObject",
1347 "isOptional" : false
1353 "name" : "mouseover",
1354 "type" : "function",
1355 "desc" : "The raw mouseover event for the entire grid.",
1356 "sig" : "function (e)\n{\n\n}",
1365 "type" : "Roo.EventObject",
1367 "isOptional" : false
1373 "name" : "headerdblclick",
1374 "type" : "function",
1375 "desc" : "Fires when a header cell is double clicked",
1376 "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1387 "isOptional" : false
1390 "name" : "columnIndex",
1393 "isOptional" : false
1397 "type" : "Roo.EventObject",
1399 "isOptional" : false
1405 "name" : "dragdrop",
1406 "type" : "function",
1407 "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1408 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1419 "isOptional" : false
1423 "type" : "Roo.GridDD",
1424 "desc" : "The drag drop object",
1425 "isOptional" : false
1428 "name" : "targetId",
1430 "desc" : "The target drag drop object",
1431 "isOptional" : false
1436 "desc" : "The raw browser event",
1437 "isOptional" : false
1443 "name" : "rowclick",
1444 "type" : "function",
1445 "desc" : "Fires when a row is clicked",
1446 "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1457 "isOptional" : false
1460 "name" : "rowIndex",
1463 "isOptional" : false
1467 "type" : "Roo.EventObject",
1469 "isOptional" : false
1476 "type" : "function",
1477 "desc" : "The raw click event for the entire grid.",
1478 "sig" : "function (e)\n{\n\n}",
1487 "type" : "Roo.EventObject",
1489 "isOptional" : false
1495 "name" : "rowdblclick",
1496 "type" : "function",
1497 "desc" : "Fires when a row is double clicked",
1498 "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1509 "isOptional" : false
1512 "name" : "rowIndex",
1515 "isOptional" : false
1519 "type" : "Roo.EventObject",
1521 "isOptional" : false
1527 "name" : "startdrag",
1528 "type" : "function",
1529 "desc" : "Fires when row(s) start being dragged",
1530 "sig" : "function (_self, dd, e)\n{\n\n}",
1541 "isOptional" : false
1545 "type" : "Roo.GridDD",
1546 "desc" : "The drag drop object",
1547 "isOptional" : false
1552 "desc" : "The raw browser event",
1553 "isOptional" : false
1559 "name" : "dblclick",
1560 "type" : "function",
1561 "desc" : "The raw dblclick event for the entire grid.",
1562 "sig" : "function (e)\n{\n\n}",
1571 "type" : "Roo.EventObject",
1573 "isOptional" : false
1579 "name" : "cellcontextmenu",
1580 "type" : "function",
1581 "desc" : "Fires when a cell is right clicked",
1582 "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
1593 "isOptional" : false
1596 "name" : "rowIndex",
1599 "isOptional" : false
1602 "name" : "cellIndex",
1605 "isOptional" : false
1609 "type" : "Roo.EventObject",
1611 "isOptional" : false
1617 "name" : "contextmenu",
1618 "type" : "function",
1619 "desc" : "The raw contextmenu event for the entire grid.",
1620 "sig" : "function (e)\n{\n\n}",
1629 "type" : "Roo.EventObject",
1631 "isOptional" : false
1637 "name" : "celldblclick",
1638 "type" : "function",
1639 "desc" : "Fires when a cell is double clicked",
1640 "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
1651 "isOptional" : false
1654 "name" : "rowIndex",
1657 "isOptional" : false
1660 "name" : "columnIndex",
1663 "isOptional" : false
1667 "type" : "Roo.EventObject",
1669 "isOptional" : false