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.",
32 "name" : "autoSizeColumns",
34 "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.",
35 "memberOf" : "Roo.grid.Grid",
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" : "maxRowsToMeasure",
48 "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).",
49 "memberOf" : "Roo.grid.Grid",
53 "name" : "minColumnWidth",
55 "desc" : "The minimum width a column can be resized to. Default is 25.",
56 "memberOf" : "Roo.grid.Grid",
60 "name" : "autoExpandColumn",
62 "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.",
63 "memberOf" : "Roo.grid.Grid",
67 "name" : "autoExpandMax",
69 "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
70 "memberOf" : "Roo.grid.Grid",
74 "name" : "enableRowHeightSync",
76 "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
77 "memberOf" : "Roo.grid.Grid",
81 "name" : "monitorWindowResize",
83 "desc" : "True to autoSize the grid when the window resizes. Default is true.",
84 "memberOf" : "Roo.grid.Grid",
88 "name" : "autoExpandMin",
90 "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
91 "memberOf" : "Roo.grid.Grid",
97 "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
98 "memberOf" : "Roo.grid.Grid",
102 "name" : "autoWidth",
104 "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.",
105 "memberOf" : "Roo.grid.Grid",
111 "desc" : "- drag drop group.",
112 "memberOf" : "Roo.grid.Grid",
116 "name" : "enableDrag",
118 "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
119 "memberOf" : "Roo.grid.Grid",
123 "name" : "maxHeight",
125 "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
126 "memberOf" : "Roo.grid.Grid",
130 "name" : "trackMouseOver",
132 "desc" : "True to highlight rows when the mouse is over. Default is true.",
133 "memberOf" : "Roo.grid.Grid",
139 "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
140 "memberOf" : "Roo.grid.Grid",
144 "name" : "stripeRows",
146 "desc" : "True to stripe the rows. Default is true.",
147 "memberOf" : "Roo.grid.Grid",
151 "name" : "enableColumnMove",
153 "desc" : "True to enable drag and drop reorder of columns. Default is true.",
154 "memberOf" : "Roo.grid.Grid",
158 "name" : "enableColumnHide",
160 "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
161 "memberOf" : "Roo.grid.Grid",
165 "name" : "autoSizeHeaders",
167 "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
168 "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",
179 "name" : "dropTarget",
180 "type" : "Roo.dd.DropTarget",
181 "desc" : "An {@link Roo.dd.DropTarget} config",
182 "memberOf" : "Roo.grid.Grid",
186 "name" : "autoHeight",
188 "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
189 "memberOf" : "Roo.grid.Grid",
195 "name" : "getSelectionModel",
196 "desc" : "Returns the grid's SelectionModel.",
198 "isConstructor" : false,
200 "memberOf" : "Roo.grid.Grid",
209 "type" : "SelectionModel",
216 "desc" : "Destroy this grid.",
218 "isConstructor" : false,
220 "memberOf" : "Roo.grid.Grid",
229 "desc" : "True to remove the element",
236 "name" : "getColumnModel",
237 "desc" : "Returns the grid's ColumnModel.",
239 "isConstructor" : false,
241 "memberOf" : "Roo.grid.Grid",
250 "type" : "ColumnModel",
256 "name" : "getGridEl",
257 "desc" : "Returns the grid's underlying element.",
259 "isConstructor" : false,
261 "memberOf" : "Roo.grid.Grid",
271 "desc" : "The element"
276 "name" : "getDataSource",
277 "desc" : "Returns the grid's DataSource.",
279 "isConstructor" : false,
281 "memberOf" : "Roo.grid.Grid",
290 "type" : "DataSource",
297 "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.",
299 "isConstructor" : false,
301 "memberOf" : "Roo.grid.Grid",
311 "desc" : "Returns the grid's GridView object.",
313 "isConstructor" : false,
315 "memberOf" : "Roo.grid.Grid",
330 "name" : "getDragDropText",
331 "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
333 "isConstructor" : false,
335 "memberOf" : "Roo.grid.Grid",
350 "name" : "reconfigure",
351 "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
353 "isConstructor" : false,
355 "memberOf" : "Roo.grid.Grid",
362 "name" : "dataSource",
363 "type" : "Roo.data.Store",
364 "desc" : "The new {@link Roo.data.Store} object",
369 "type" : "Roo.grid.ColumnModel",
370 "desc" : "new {@link Roo.grid.ColumnModel} object",
377 "name" : "addColumns",
378 "desc" : "addColumns\nAdd's a column, default at the end..",
380 "isConstructor" : false,
382 "memberOf" : "Roo.grid.Grid",
391 "desc" : "to add (default end)",
397 "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
405 "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
407 "isConstructor" : false,
409 "memberOf" : "Roo.grid.Grid",
418 "type" : "Roo.grid.Grid",
424 "name" : "purgeListeners",
425 "desc" : "Removes all listeners for this object",
427 "isConstructor" : false,
429 "memberOf" : "Roo.util.Observable",
439 "desc" : "Appends an event handler to this element (shorthand for addListener)",
441 "isConstructor" : false,
443 "memberOf" : "Roo.util.Observable",
450 "name" : "eventName",
452 "desc" : "The type of event to listen for",
458 "desc" : "The method the event invokes",
464 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
470 "desc" : "(optional)",
478 "desc" : "Removes a listener (shorthand for removeListener)",
480 "isConstructor" : false,
482 "memberOf" : "Roo.util.Observable",
489 "name" : "eventName",
491 "desc" : "The type of event to listen for",
497 "desc" : "The handler to remove",
503 "desc" : "(optional) The scope (this object) for the handler",
510 "name" : "addEvents",
511 "desc" : "Used to define events on this Observable",
513 "isConstructor" : false,
515 "memberOf" : "Roo.util.Observable",
524 "desc" : "The object with the events defined",
531 "name" : "releaseCapture",
532 "desc" : "Removes <b>all</b> added captures from the Observable.",
534 "isConstructor" : false,
536 "memberOf" : "Roo.util.Observable",
544 "type" : "Observable",
545 "desc" : "The Observable to release",
552 "name" : "removeListener",
553 "desc" : "Removes a listener",
555 "isConstructor" : false,
557 "memberOf" : "Roo.util.Observable",
564 "name" : "eventName",
566 "desc" : "The type of event to listen for",
572 "desc" : "The handler to remove",
578 "desc" : "(optional) The scope (this object) for the handler",
585 "name" : "fireEvent",
586 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
588 "isConstructor" : false,
590 "memberOf" : "Roo.util.Observable",
597 "name" : "eventName",
604 "type" : "Object...",
605 "desc" : "Variable number of parameters are passed to handlers",
613 "desc" : "returns false if any of the handlers return false otherwise it returns true"
618 "name" : "hasListener",
619 "desc" : "Checks to see if this object has any listeners for a specified event",
621 "isConstructor" : false,
623 "memberOf" : "Roo.util.Observable",
630 "name" : "eventName",
632 "desc" : "The name of the event to check for",
640 "desc" : "True if the event is being listened for, else false"
646 "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.",
648 "isConstructor" : false,
650 "memberOf" : "Roo.util.Observable",
658 "type" : "Observable",
659 "desc" : "The Observable to capture",
665 "desc" : "The function to call",
671 "desc" : "(optional) The scope (this object) for the fn",
678 "name" : "addListener",
679 "desc" : "Appends an event handler to this component",
681 "isConstructor" : false,
683 "memberOf" : "Roo.util.Observable",
690 "name" : "eventName",
692 "desc" : "The type of event to listen for",
698 "desc" : "The method the event invokes",
704 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
710 "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>",
719 "name" : "rowcontextmenu",
720 "desc" : "Fires when a row is right clicked",
721 "memberOf" : "Roo.grid.Grid",
741 "type" : "Roo.EventObject",
749 "name" : "columnmove",
750 "desc" : "Fires when the user moves a column",
751 "memberOf" : "Roo.grid.Grid",
773 "name" : "headercontextmenu",
774 "desc" : "Fires when a header is right clicked",
775 "memberOf" : "Roo.grid.Grid",
788 "name" : "columnIndex",
795 "type" : "Roo.EventObject",
804 "desc" : "Fires when the grid is rendered",
805 "memberOf" : "Roo.grid.Grid",
821 "name" : "bodyscroll",
822 "desc" : "Fires when the body element is scrolled",
823 "memberOf" : "Roo.grid.Grid",
830 "name" : "scrollLeft",
836 "name" : "scrollTop",
845 "name" : "columnresize",
846 "desc" : "Fires when the user resizes a column",
847 "memberOf" : "Roo.grid.Grid",
854 "name" : "columnIndex",
870 "desc" : "Fires when a drag operation is complete",
871 "memberOf" : "Roo.grid.Grid",
885 "type" : "Roo.GridDD",
886 "desc" : "The drag drop object",
892 "desc" : "The raw browser event",
900 "desc" : "The raw mouseout event for the entire grid.",
901 "memberOf" : "Roo.grid.Grid",
909 "type" : "Roo.EventObject",
917 "name" : "cellclick",
918 "desc" : "Fires when a cell is clicked",
919 "memberOf" : "Roo.grid.Grid",
938 "name" : "columnIndex",
945 "type" : "Roo.EventObject",
954 "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.",
955 "memberOf" : "Roo.grid.Grid",
969 "type" : "Roo.GridDD",
970 "desc" : "The drag drop object",
976 "desc" : "The target drag drop object",
982 "desc" : "The raw browser event",
990 "desc" : "Fires when a row is rendered, so you can change add a style to it.",
991 "memberOf" : "Roo.grid.Grid",
1000 "desc" : "The grid view",
1001 "isOptional" : false
1006 "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
1007 "isOptional" : false
1014 "desc" : "The raw keydown event for the entire grid.",
1015 "memberOf" : "Roo.grid.Grid",
1023 "type" : "Roo.EventObject",
1025 "isOptional" : false
1031 "name" : "mousedown",
1032 "desc" : "The raw mousedown event for the entire grid.",
1033 "memberOf" : "Roo.grid.Grid",
1041 "type" : "Roo.EventObject",
1043 "isOptional" : false
1049 "name" : "dragenter",
1050 "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1051 "memberOf" : "Roo.grid.Grid",
1061 "isOptional" : false
1065 "type" : "Roo.GridDD",
1066 "desc" : "The drag drop object",
1067 "isOptional" : false
1070 "name" : "targetId",
1072 "desc" : "The target drag drop object",
1073 "isOptional" : false
1078 "desc" : "The raw browser event",
1079 "isOptional" : false
1086 "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1087 "memberOf" : "Roo.grid.Grid",
1097 "isOptional" : false
1101 "type" : "Roo.GridDD",
1102 "desc" : "The drag drop object",
1103 "isOptional" : false
1106 "name" : "targetId",
1108 "desc" : "The target drag drop object",
1109 "isOptional" : false
1114 "desc" : "The raw browser event",
1115 "isOptional" : false
1122 "desc" : "The raw mouseup event for the entire grid.",
1123 "memberOf" : "Roo.grid.Grid",
1131 "type" : "Roo.EventObject",
1133 "isOptional" : false
1139 "name" : "keypress",
1140 "desc" : "The raw keypress event for the entire grid.",
1141 "memberOf" : "Roo.grid.Grid",
1149 "type" : "Roo.EventObject",
1151 "isOptional" : false
1157 "name" : "headerclick",
1158 "desc" : "Fires when a header is clicked",
1159 "memberOf" : "Roo.grid.Grid",
1169 "isOptional" : false
1172 "name" : "columnIndex",
1175 "isOptional" : false
1179 "type" : "Roo.EventObject",
1181 "isOptional" : false
1187 "name" : "mouseover",
1188 "desc" : "The raw mouseover event for the entire grid.",
1189 "memberOf" : "Roo.grid.Grid",
1197 "type" : "Roo.EventObject",
1199 "isOptional" : false
1205 "name" : "headerdblclick",
1206 "desc" : "Fires when a header cell is double clicked",
1207 "memberOf" : "Roo.grid.Grid",
1217 "isOptional" : false
1220 "name" : "columnIndex",
1223 "isOptional" : false
1227 "type" : "Roo.EventObject",
1229 "isOptional" : false
1235 "name" : "dragdrop",
1236 "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1237 "memberOf" : "Roo.grid.Grid",
1247 "isOptional" : false
1251 "type" : "Roo.GridDD",
1252 "desc" : "The drag drop object",
1253 "isOptional" : false
1256 "name" : "targetId",
1258 "desc" : "The target drag drop object",
1259 "isOptional" : false
1264 "desc" : "The raw browser event",
1265 "isOptional" : false
1271 "name" : "rowclick",
1272 "desc" : "Fires when a row is clicked",
1273 "memberOf" : "Roo.grid.Grid",
1283 "isOptional" : false
1286 "name" : "rowIndex",
1289 "isOptional" : false
1293 "type" : "Roo.EventObject",
1295 "isOptional" : false
1302 "desc" : "The raw click event for the entire grid.",
1303 "memberOf" : "Roo.grid.Grid",
1311 "type" : "Roo.EventObject",
1313 "isOptional" : false
1319 "name" : "rowdblclick",
1320 "desc" : "Fires when a row is double clicked",
1321 "memberOf" : "Roo.grid.Grid",
1331 "isOptional" : false
1334 "name" : "rowIndex",
1337 "isOptional" : false
1341 "type" : "Roo.EventObject",
1343 "isOptional" : false
1349 "name" : "startdrag",
1350 "desc" : "Fires when row(s) start being dragged",
1351 "memberOf" : "Roo.grid.Grid",
1361 "isOptional" : false
1365 "type" : "Roo.GridDD",
1366 "desc" : "The drag drop object",
1367 "isOptional" : false
1372 "desc" : "The raw browser event",
1373 "isOptional" : false
1379 "name" : "dblclick",
1380 "desc" : "The raw dblclick event for the entire grid.",
1381 "memberOf" : "Roo.grid.Grid",
1389 "type" : "Roo.EventObject",
1391 "isOptional" : false
1397 "name" : "cellcontextmenu",
1398 "desc" : "Fires when a cell is right clicked",
1399 "memberOf" : "Roo.grid.Grid",
1409 "isOptional" : false
1412 "name" : "rowIndex",
1415 "isOptional" : false
1418 "name" : "cellIndex",
1421 "isOptional" : false
1425 "type" : "Roo.EventObject",
1427 "isOptional" : false
1433 "name" : "contextmenu",
1434 "desc" : "The raw contextmenu event for the entire grid.",
1435 "memberOf" : "Roo.grid.Grid",
1443 "type" : "Roo.EventObject",
1445 "isOptional" : false
1451 "name" : "celldblclick",
1452 "desc" : "Fires when a cell is double clicked",
1453 "memberOf" : "Roo.grid.Grid",
1463 "isOptional" : false
1466 "name" : "rowIndex",
1469 "isOptional" : false
1472 "name" : "columnIndex",
1475 "isOptional" : false
1479 "type" : "Roo.EventObject",
1481 "isOptional" : false