2 "name" : "Roo.grid.Grid",
7 "Roo.grid.EditorGrid" : [
8 "Roo.grid.PropertyGrid"
17 "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 "isSingleton" : false,
22 "isBuilderTop" : false,
31 "type" : "String/HTMLElement/Roo.Element",
32 "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.",
38 "desc" : "A config object that sets properties on this grid.",
48 "type" : "Roo.PagingToolbar",
49 "desc" : "the paging toolbar",
55 "name" : "autoSizeColumns",
57 "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.",
65 "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>",
66 "memberOf" : "Roo.util.Observable",
72 "type" : "Roo.grid.ColumnModel",
73 "desc" : "The columns of the grid",
79 "name" : "maxRowsToMeasure",
81 "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).",
87 "name" : "minColumnWidth",
89 "desc" : "The minimum width a column can be resized to. Default is 25.",
97 "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
104 "type" : "Roo.Toolbar",
105 "desc" : "a toolbar for buttons etc.",
107 "isOptional" : false,
111 "name" : "autoExpandColumn",
113 "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.",
115 "isOptional" : false,
119 "name" : "autoExpandMax",
121 "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
123 "isOptional" : false,
127 "name" : "enableRowHeightSync",
129 "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
131 "isOptional" : false,
135 "name" : "enableDrop",
137 "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
139 "isOptional" : false,
143 "name" : "monitorWindowResize",
145 "desc" : "True to autoSize the grid when the window resizes. Default is true.",
147 "isOptional" : false,
151 "name" : "autoExpandMin",
153 "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
155 "isOptional" : false,
160 "type" : "Roo.grid.GridView",
161 "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
163 "isOptional" : false,
168 "type" : "Roo.data.Store",
169 "desc" : "The data store for the grid",
171 "isOptional" : false,
177 "desc" : "- drag drop group.",
179 "isOptional" : false,
183 "name" : "enableDrag",
185 "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
187 "isOptional" : false,
191 "name" : "autoWidth",
193 "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.",
195 "isOptional" : false,
199 "name" : "maxHeight",
201 "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
203 "isOptional" : false,
207 "name" : "trackMouseOver",
209 "desc" : "True to highlight rows when the mouse is over. Default is true.",
211 "isOptional" : false,
217 "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
219 "isOptional" : false,
223 "name" : "stripeRows",
225 "desc" : "True to stripe the rows. Default is true.",
227 "isOptional" : false,
231 "name" : "enableColumnMove",
233 "desc" : "True to enable drag and drop reorder of columns. Default is true.",
235 "isOptional" : false,
239 "name" : "enableColumnHide",
241 "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
243 "isOptional" : false,
247 "name" : "autoSizeHeaders",
249 "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
251 "isOptional" : false,
255 "name" : "sortColMenu",
257 "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
259 "isOptional" : false,
263 "name" : "enableDragDrop",
265 "desc" : "True to enable drag and drop of rows. Default is false.",
267 "isOptional" : false,
271 "name" : "dropTarget",
272 "type" : "Roo.dd.DropTarget",
273 "desc" : "An {@link Roo.dd.DropTarget} config",
275 "isOptional" : false,
280 "type" : "Roo.grid.AbstractSelectionModel",
281 "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
283 "isOptional" : false,
287 "name" : "dragGroup",
289 "desc" : "- drag group (?? not sure if needed.)",
291 "isOptional" : false,
295 "name" : "autoHeight",
297 "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
299 "isOptional" : false,
305 "name" : "getSelectionModel",
307 "desc" : "Returns the grid's SelectionModel.",
308 "sig" : "()\n{\n\n}",
312 "isConstructor" : false,
324 "type" : "SelectionModel",
332 "desc" : "Destroy this grid.",
333 "sig" : "(removeEl)",
337 "isConstructor" : false,
349 "desc" : "True to remove the element",
356 "name" : "getColumnModel",
358 "desc" : "Returns the grid's ColumnModel.",
359 "sig" : "()\n{\n\n}",
363 "isConstructor" : false,
375 "type" : "ColumnModel",
381 "name" : "getGridEl",
383 "desc" : "Returns the grid's underlying element.",
384 "sig" : "()\n{\n\n}",
388 "isConstructor" : false,
401 "desc" : "The element"
406 "name" : "getDataSource",
408 "desc" : "Returns the grid's DataSource.",
409 "sig" : "()\n{\n\n}",
413 "isConstructor" : false,
425 "type" : "DataSource",
433 "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.",
434 "sig" : "()\n{\n\n}",
438 "isConstructor" : false,
452 "desc" : "Returns the grid's GridView object.",
453 "sig" : "()\n{\n\n}",
457 "isConstructor" : false,
475 "name" : "getDragDropText",
477 "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
478 "sig" : "()\n{\n\n}",
482 "isConstructor" : false,
500 "name" : "reconfigure",
502 "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
503 "sig" : "(dataSource, The)",
507 "isConstructor" : false,
517 "name" : "dataSource",
518 "type" : "Roo.data.Store",
519 "desc" : "The new {@link Roo.data.Store} object",
524 "type" : "Roo.grid.ColumnModel",
525 "desc" : "new {@link Roo.grid.ColumnModel} object",
532 "name" : "addColumns",
534 "desc" : "addColumns\nAdd's a column, default at the end..",
535 "sig" : "(position, of)",
539 "isConstructor" : false,
551 "desc" : "to add (default end)",
557 "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
566 "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
567 "sig" : "()\n{\n\n}",
571 "isConstructor" : false,
583 "type" : "Roo.grid.Grid",
589 "name" : "purgeListeners",
591 "desc" : "Removes all listeners for this object",
592 "sig" : "()\n{\n\n}",
594 "memberOf" : "Roo.util.Observable",
596 "isConstructor" : false,
610 "desc" : "Appends an event handler to this element (shorthand for addListener)",
611 "sig" : "(eventName, handler, scope, options)",
613 "memberOf" : "Roo.util.Observable",
615 "isConstructor" : false,
625 "name" : "eventName",
627 "desc" : "The type of event to listen for",
633 "desc" : "The method the event invokes",
639 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
645 "desc" : "(optional)",
654 "desc" : "Removes a listener (shorthand for removeListener)",
655 "sig" : "(eventName, handler, scope)",
657 "memberOf" : "Roo.util.Observable",
659 "isConstructor" : false,
669 "name" : "eventName",
671 "desc" : "The type of event to listen for",
677 "desc" : "The handler to remove",
683 "desc" : "(optional) The scope (this object) for the handler",
690 "name" : "addEvents",
692 "desc" : "Used to define events on this Observable",
695 "memberOf" : "Roo.util.Observable",
697 "isConstructor" : false,
709 "desc" : "The object with the events defined",
716 "name" : "releaseCapture",
718 "desc" : "Removes <b>all</b> added captures from the Observable.",
721 "memberOf" : "Roo.util.Observable",
723 "isConstructor" : false,
734 "type" : "Observable",
735 "desc" : "The Observable to release",
742 "name" : "removeListener",
744 "desc" : "Removes a listener",
745 "sig" : "(eventName, handler, scope)",
747 "memberOf" : "Roo.util.Observable",
749 "isConstructor" : false,
759 "name" : "eventName",
761 "desc" : "The type of event to listen for",
767 "desc" : "The handler to remove",
773 "desc" : "(optional) The scope (this object) for the handler",
780 "name" : "fireEvent",
782 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
783 "sig" : "(eventName, args)",
785 "memberOf" : "Roo.util.Observable",
787 "isConstructor" : false,
797 "name" : "eventName",
804 "type" : "Object...",
805 "desc" : "Variable number of parameters are passed to handlers",
813 "desc" : "returns false if any of the handlers return false otherwise it returns true"
818 "name" : "hasListener",
820 "desc" : "Checks to see if this object has any listeners for a specified event",
821 "sig" : "(eventName)",
823 "memberOf" : "Roo.util.Observable",
825 "isConstructor" : false,
835 "name" : "eventName",
837 "desc" : "The name of the event to check for",
845 "desc" : "True if the event is being listened for, else false"
852 "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.",
853 "sig" : "(o, fn, scope)",
855 "memberOf" : "Roo.util.Observable",
857 "isConstructor" : false,
868 "type" : "Observable",
869 "desc" : "The Observable to capture",
875 "desc" : "The function to call",
881 "desc" : "(optional) The scope (this object) for the fn",
888 "name" : "addListener",
890 "desc" : "Appends an event handler to this component",
891 "sig" : "(eventName, handler, scope, options)",
893 "memberOf" : "Roo.util.Observable",
895 "isConstructor" : false,
905 "name" : "eventName",
907 "desc" : "The type of event to listen for",
913 "desc" : "The method the event invokes",
919 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
925 "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>",
934 "name" : "rowcontextmenu",
936 "desc" : "Fires when a row is right clicked",
937 "sig" : "function (_self, rowIndex, e)\n{\n\n}",
958 "type" : "Roo.EventObject",
966 "name" : "columnmove",
968 "desc" : "Fires when the user moves a column",
969 "sig" : "function (oldIndex, newIndex)\n{\n\n}",
992 "name" : "headercontextmenu",
994 "desc" : "Fires when a header is right clicked",
995 "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1006 "isOptional" : false
1009 "name" : "columnIndex",
1012 "isOptional" : false
1016 "type" : "Roo.EventObject",
1018 "isOptional" : false
1025 "type" : "function",
1026 "desc" : "Fires when the grid is rendered",
1027 "sig" : "function (grid)\n{\n\n}",
1038 "isOptional" : false
1044 "name" : "bodyscroll",
1045 "type" : "function",
1046 "desc" : "Fires when the body element is scrolled",
1047 "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
1055 "name" : "scrollLeft",
1058 "isOptional" : false
1061 "name" : "scrollTop",
1064 "isOptional" : false
1070 "name" : "columnresize",
1071 "type" : "function",
1072 "desc" : "Fires when the user resizes a column",
1073 "sig" : "function (columnIndex, newSize)\n{\n\n}",
1081 "name" : "columnIndex",
1084 "isOptional" : false
1090 "isOptional" : false
1097 "type" : "function",
1098 "desc" : "Fires when a drag operation is complete",
1099 "sig" : "function (_self, dd, e)\n{\n\n}",
1110 "isOptional" : false
1114 "type" : "Roo.GridDD",
1115 "desc" : "The drag drop object",
1116 "isOptional" : false
1121 "desc" : "The raw browser event",
1122 "isOptional" : false
1128 "name" : "mouseout",
1129 "type" : "function",
1130 "desc" : "The raw mouseout event for the entire grid.",
1131 "sig" : "function (e)\n{\n\n}",
1140 "type" : "Roo.EventObject",
1142 "isOptional" : false
1148 "name" : "cellclick",
1149 "type" : "function",
1150 "desc" : "Fires when a cell is clicked",
1151 "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
1162 "isOptional" : false
1165 "name" : "rowIndex",
1168 "isOptional" : false
1171 "name" : "columnIndex",
1174 "isOptional" : false
1178 "type" : "Roo.EventObject",
1180 "isOptional" : false
1186 "name" : "dragover",
1187 "type" : "function",
1188 "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.",
1189 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1200 "isOptional" : false
1204 "type" : "Roo.GridDD",
1205 "desc" : "The drag drop object",
1206 "isOptional" : false
1209 "name" : "targetId",
1211 "desc" : "The target drag drop object",
1212 "isOptional" : false
1217 "desc" : "The raw browser event",
1218 "isOptional" : false
1224 "name" : "rowclass",
1225 "type" : "function",
1226 "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1227 "sig" : "function (gridview, rowcfg)\n{\n\n}",
1235 "name" : "gridview",
1236 "type" : "GridView",
1237 "desc" : "The grid view",
1238 "isOptional" : false
1243 "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
1244 "isOptional" : false
1251 "type" : "function",
1252 "desc" : "The raw keydown event for the entire grid.",
1253 "sig" : "function (e)\n{\n\n}",
1262 "type" : "Roo.EventObject",
1264 "isOptional" : false
1270 "name" : "mousedown",
1271 "type" : "function",
1272 "desc" : "The raw mousedown event for the entire grid.",
1273 "sig" : "function (e)\n{\n\n}",
1282 "type" : "Roo.EventObject",
1284 "isOptional" : false
1290 "name" : "dragenter",
1291 "type" : "function",
1292 "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1293 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1304 "isOptional" : false
1308 "type" : "Roo.GridDD",
1309 "desc" : "The drag drop object",
1310 "isOptional" : false
1313 "name" : "targetId",
1315 "desc" : "The target drag drop object",
1316 "isOptional" : false
1321 "desc" : "The raw browser event",
1322 "isOptional" : false
1329 "type" : "function",
1330 "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1331 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1342 "isOptional" : false
1346 "type" : "Roo.GridDD",
1347 "desc" : "The drag drop object",
1348 "isOptional" : false
1351 "name" : "targetId",
1353 "desc" : "The target drag drop object",
1354 "isOptional" : false
1359 "desc" : "The raw browser event",
1360 "isOptional" : false
1367 "type" : "function",
1368 "desc" : "The raw mouseup event for the entire grid.",
1369 "sig" : "function (e)\n{\n\n}",
1378 "type" : "Roo.EventObject",
1380 "isOptional" : false
1386 "name" : "keypress",
1387 "type" : "function",
1388 "desc" : "The raw keypress event for the entire grid.",
1389 "sig" : "function (e)\n{\n\n}",
1398 "type" : "Roo.EventObject",
1400 "isOptional" : false
1406 "name" : "headerclick",
1407 "type" : "function",
1408 "desc" : "Fires when a header is clicked",
1409 "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1420 "isOptional" : false
1423 "name" : "columnIndex",
1426 "isOptional" : false
1430 "type" : "Roo.EventObject",
1432 "isOptional" : false
1438 "name" : "mouseover",
1439 "type" : "function",
1440 "desc" : "The raw mouseover event for the entire grid.",
1441 "sig" : "function (e)\n{\n\n}",
1450 "type" : "Roo.EventObject",
1452 "isOptional" : false
1458 "name" : "headerdblclick",
1459 "type" : "function",
1460 "desc" : "Fires when a header cell is double clicked",
1461 "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1472 "isOptional" : false
1475 "name" : "columnIndex",
1478 "isOptional" : false
1482 "type" : "Roo.EventObject",
1484 "isOptional" : false
1490 "name" : "dragdrop",
1491 "type" : "function",
1492 "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1493 "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1504 "isOptional" : false
1508 "type" : "Roo.GridDD",
1509 "desc" : "The drag drop object",
1510 "isOptional" : false
1513 "name" : "targetId",
1515 "desc" : "The target drag drop object",
1516 "isOptional" : false
1521 "desc" : "The raw browser event",
1522 "isOptional" : false
1528 "name" : "rowclick",
1529 "type" : "function",
1530 "desc" : "Fires when a row is clicked",
1531 "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1542 "isOptional" : false
1545 "name" : "rowIndex",
1548 "isOptional" : false
1552 "type" : "Roo.EventObject",
1554 "isOptional" : false
1561 "type" : "function",
1562 "desc" : "The raw click event for the entire grid.",
1563 "sig" : "function (e)\n{\n\n}",
1572 "type" : "Roo.EventObject",
1574 "isOptional" : false
1580 "name" : "rowdblclick",
1581 "type" : "function",
1582 "desc" : "Fires when a row is double clicked",
1583 "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1594 "isOptional" : false
1597 "name" : "rowIndex",
1600 "isOptional" : false
1604 "type" : "Roo.EventObject",
1606 "isOptional" : false
1612 "name" : "startdrag",
1613 "type" : "function",
1614 "desc" : "Fires when row(s) start being dragged",
1615 "sig" : "function (_self, dd, e)\n{\n\n}",
1626 "isOptional" : false
1630 "type" : "Roo.GridDD",
1631 "desc" : "The drag drop object",
1632 "isOptional" : false
1637 "desc" : "The raw browser event",
1638 "isOptional" : false
1644 "name" : "dblclick",
1645 "type" : "function",
1646 "desc" : "The raw dblclick event for the entire grid.",
1647 "sig" : "function (e)\n{\n\n}",
1656 "type" : "Roo.EventObject",
1658 "isOptional" : false
1664 "name" : "cellcontextmenu",
1665 "type" : "function",
1666 "desc" : "Fires when a cell is right clicked",
1667 "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
1678 "isOptional" : false
1681 "name" : "rowIndex",
1684 "isOptional" : false
1687 "name" : "cellIndex",
1690 "isOptional" : false
1694 "type" : "Roo.EventObject",
1696 "isOptional" : false
1702 "name" : "contextmenu",
1703 "type" : "function",
1704 "desc" : "The raw contextmenu event for the entire grid.",
1705 "sig" : "function (e)\n{\n\n}",
1714 "type" : "Roo.EventObject",
1716 "isOptional" : false
1722 "name" : "celldblclick",
1723 "type" : "function",
1724 "desc" : "Fires when a cell is double clicked",
1725 "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
1736 "isOptional" : false
1739 "name" : "rowIndex",
1742 "isOptional" : false
1745 "name" : "columnIndex",
1748 "isOptional" : false
1752 "type" : "Roo.EventObject",
1754 "isOptional" : false