"isOptional" : false
}
],
- "returns" : [
- ],
+ "returns" : [],
"config" : [
{
"name" : "autoSizeColumns",
"type" : "Boolean",
"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.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "listeners",
"type" : "Object",
"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>",
"memberOf" : "Roo.util.Observable",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "maxRowsToMeasure",
"type" : "Boolean",
"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).",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "minColumnWidth",
"type" : "Number",
"desc" : "The minimum width a column can be resized to. Default is 25.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "ddText",
+ "type" : "String",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
+ "optvals" : []
},
{
"name" : "autoExpandColumn",
"type" : "String",
"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.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "autoExpandMax",
"type" : "Number",
"desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "enableRowHeightSync",
"type" : "Boolean",
"desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "optvals" : []
},
{
"name" : "monitorWindowResize",
"type" : "Boolean",
"desc" : "True to autoSize the grid when the window resizes. Default is true.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "autoExpandMin",
"type" : "Number",
"desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "view",
"type" : "Object",
"desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
- "name" : "autoWidth",
+ "name" : "enableDrag",
"type" : "Boolean",
- "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.",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
- "name" : "enableDrag",
+ "name" : "autoWidth",
"type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "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.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "trackMouseOver",
"type" : "Boolean",
"desc" : "True to highlight rows when the mouse is over. Default is true.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Object",
"desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "stripeRows",
"type" : "Boolean",
"desc" : "True to stripe the rows. Default is true.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "enableColumnMove",
"type" : "Boolean",
"desc" : "True to enable drag and drop reorder of columns. Default is true.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "enableColumnHide",
"type" : "Boolean",
"desc" : "True to enable hiding of columns with the header context menu. Default is true.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "autoSizeHeaders",
"type" : "Boolean",
"desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "enableDragDrop",
"type" : "Boolean",
"desc" : "True to enable drag and drop of rows. Default is false.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
+ "optvals" : []
},
{
"name" : "autoHeight",
"type" : "Boolean",
"desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
"memberOf" : "Roo.grid.Grid",
- "values" : [
- ]
+ "optvals" : []
}
],
"methods" : [
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "getColumnModel",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "getView",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "getDragDropText",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
- "name" : "render",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "name" : "addColumns",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
+ }
],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "un",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addEvents",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "releaseCapture",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "removeListener",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addListener",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
],
"events" : [
{
"name" : "rowcontextmenu",
"desc" : "Fires when a row is right clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "columnmove",
"desc" : "Fires when the user moves a column",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "headercontextmenu",
"desc" : "Fires when a header is right clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "render",
"desc" : "Fires when the grid is rendered",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "bodyscroll",
"desc" : "Fires when the body element is scrolled",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "columnresize",
"desc" : "Fires when the user resizes a column",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "enddrag",
"desc" : "Fires when a drag operation is complete",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseout",
"desc" : "The raw mouseout event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "cellclick",
"desc" : "Fires when a cell is clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "dragover",
"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.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowclass",
"desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "keydown",
"desc" : "The raw keydown event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mousedown",
"desc" : "The raw mousedown event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "dragenter",
"desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "dragout",
"desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseup",
"desc" : "The raw mouseup event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "keypress",
"desc" : "The raw keypress event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "headerclick",
"desc" : "Fires when a header is clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseover",
"desc" : "The raw mouseover event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "headerdblclick",
"desc" : "Fires when a header cell is double clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "dragdrop",
"desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowclick",
"desc" : "Fires when a row is clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "click",
"desc" : "The raw click event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowdblclick",
"desc" : "Fires when a row is double clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "startdrag",
"desc" : "Fires when row(s) start being dragged",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "dblclick",
"desc" : "The raw dblclick event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "cellcontextmenu",
"desc" : "Fires when a cell is right clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "contextmenu",
"desc" : "The raw contextmenu event for the entire grid.",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "celldblclick",
"desc" : "Fires when a cell is double clicked",
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
]
}
\ No newline at end of file