"Roo.grid.Grid",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "This class represents the interface of a component based property grid control.\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.PropertyGrid(\"my-container-id\", {\n \n });\n // set any options\n grid.render();\n</code></pre>",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "PropertyGrid",
"example" : "",
"deprecated" : "",
}
],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
- "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",
- "optvals" : []
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "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",
- "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"
},
{
- "name" : "customEditors",
+ "name" : "propertyNames",
"type" : "Object",
- "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
- "memberOf" : "Roo.grid.PropertyGrid",
- "optvals" : []
+ "desc" : "map of property Names to their displayed value",
+ "memberOf" : "Roo.grid.PropertyGrid"
},
{
- "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",
- "optvals" : []
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "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" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "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",
- "optvals" : []
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "autoExpandMax",
+ "name" : "minColumnWidth",
"type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "monitorWindowResize",
+ "type" : "Boolean",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableRowHeightSync",
"type" : "Boolean",
"desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "propertyNames",
- "type" : "Object",
- "desc" : "map of property Names to their displayed value",
- "memberOf" : "Roo.grid.PropertyGrid",
- "optvals" : []
+ "name" : "ds",
+ "type" : "Roo.grid.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "enableDrop",
+ "name" : "autoSizeHeaders",
"type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "monitorWindowResize",
- "type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "view",
+ "name" : "listeners",
"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",
- "optvals" : []
+ "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"
},
{
- "name" : "enableDrag",
+ "name" : "enableColumnHide",
"type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "autoWidth",
+ "name" : "enableDragDrop",
"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.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "maxHeight",
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "clicksToEdit",
"type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf" : "Roo.grid.EditorGrid"
},
{
- "name" : "trackMouseOver",
+ "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"
+ },
+ {
+ "name" : "maxRowsToMeasure",
"type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "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"
},
{
"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",
- "optvals" : []
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
- },
- {
- "name" : "enableColumnMove",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "name" : "customEditors",
+ "type" : "Object",
+ "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
+ "memberOf" : "Roo.grid.PropertyGrid"
},
{
- "name" : "enableColumnHide",
+ "name" : "autoHeight",
"type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
- },
- {
- "name" : "clicksToEdit",
- "type" : "Number",
- "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf" : "Roo.grid.EditorGrid",
- "optvals" : []
+ "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "autoSizeHeaders",
+ "name" : "autoSizeColumns",
"type" : "Boolean",
- "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "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"
},
{
- "name" : "enableDragDrop",
+ "name" : "enableDrag",
"type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "memberOf" : "Roo.grid.Grid"
},
{
- "name" : "dragGroup",
- "type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid",
- "optvals" : []
+ "name" : "autoWidth",
+ "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.",
+ "memberOf" : "Roo.grid.Grid"
},
{
- "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",
- "optvals" : []
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid"
}
],
"methods" : [
{
"name" : "getSource",
+ "type" : "function",
"desc" : "Gets all the data from the grid.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.PropertyGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "setSource",
+ "type" : "function",
"desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.PropertyGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "data",
},
{
"name" : "stopEditing",
+ "type" : "function",
"desc" : "Stops any active editing",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getDragDropText",
+ "type" : "function",
"desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "startEditing",
+ "type" : "function",
"desc" : "Starts editing the specified for the specified row/column",
+ "sig" : "(rowIndex, colIndex)",
+ "static" : false,
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "rowIndex",
},
{
"name" : "getSelectionModel",
+ "type" : "function",
"desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "removeEl",
},
{
"name" : "getColumnModel",
+ "type" : "function",
"desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "getGridEl",
+ "type" : "function",
"desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "getDataSource",
+ "type" : "function",
"desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "autoSize",
+ "type" : "function",
"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.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getView",
+ "type" : "function",
"desc" : "Returns the grid's GridView object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "reconfigure",
+ "type" : "function",
"desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "dataSource",
},
{
"name" : "addColumns",
+ "type" : "function",
"desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "position",
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "on",
+ "type" : "function",
"desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "un",
+ "type" : "function",
"desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "addEvents",
+ "type" : "function",
"desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
},
{
"name" : "releaseCapture",
+ "type" : "function",
"desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "fireEvent",
+ "type" : "function",
"desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "hasListener",
+ "type" : "function",
"desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "capture",
+ "type" : "function",
"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.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
},
{
"name" : "addListener",
+ "type" : "function",
"desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"events" : [
{
"name" : "beforepropertychange",
+ "type" : "function",
"desc" : "Fires before a property changes (return false to stop?)",
- "memberOf" : "Roo.grid.PropertyGrid",
+ "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
},
{
"name" : "propertychange",
+ "type" : "function",
"desc" : "Fires after a property changes",
- "memberOf" : "Roo.grid.PropertyGrid",
+ "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
},
{
"name" : "validateedit",
+ "type" : "function",
"desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
},
{
"name" : "beforeedit",
+ "type" : "function",
"desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
},
{
"name" : "afteredit",
+ "type" : "function",
"desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
},
{
"name" : "rowcontextmenu",
+ "type" : "function",
"desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "columnmove",
+ "type" : "function",
"desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "headercontextmenu",
+ "type" : "function",
"desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "bodyscroll",
+ "type" : "function",
"desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "columnresize",
+ "type" : "function",
"desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "enddrag",
+ "type" : "function",
"desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "mouseout",
+ "type" : "function",
"desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "cellclick",
+ "type" : "function",
"desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "dragover",
+ "type" : "function",
"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.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "rowclass",
+ "type" : "function",
"desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "keydown",
+ "type" : "function",
"desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "mousedown",
+ "type" : "function",
"desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "dragenter",
+ "type" : "function",
"desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "dragout",
+ "type" : "function",
"desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "mouseup",
+ "type" : "function",
"desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "keypress",
+ "type" : "function",
"desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "headerclick",
+ "type" : "function",
"desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "mouseover",
+ "type" : "function",
"desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "headerdblclick",
+ "type" : "function",
"desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "dragdrop",
+ "type" : "function",
"desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "rowclick",
+ "type" : "function",
"desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "click",
+ "type" : "function",
"desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "rowdblclick",
+ "type" : "function",
"desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "startdrag",
+ "type" : "function",
"desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "dblclick",
+ "type" : "function",
"desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "cellcontextmenu",
+ "type" : "function",
"desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "contextmenu",
+ "type" : "function",
"desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
},
{
"name" : "celldblclick",
+ "type" : "function",
"desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
"memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
projects / roojs1 / blobdiff