+++ /dev/null
-{
- "name" : "Roo.grid.ColumnModel",
- "augments" : [
- "Roo.util.Observable"
- ],
- "desc" : "This is the default implementation of a ColumnModel used by the Grid. It defines\nthe columns in the grid.\n<br>Usage:<br>\n <pre><code>\n var colModel = new Roo.grid.ColumnModel([\n\t{header: \"Ticker\", width: 60, sortable: true, locked: true},\n\t{header: \"Company Name\", width: 150, sortable: true},\n\t{header: \"Market Cap.\", width: 100, sortable: true},\n\t{header: \"$ Sales\", width: 100, sortable: true, renderer: money},\n\t{header: \"Employees\", width: 100, sortable: true, resizable: false}\n ]);\n </code></pre>\n<p>\nThe config options listed for this class are options which may appear in each\nindividual column definition.\n<br/>RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts.",
- "isSingleton" : false,
- "isStatic" : false,
- "isBuiltin" : false,
- "memberOf" : "ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "An Array of column config objects. See this class's\nconfig objects for details.",
- "isOptional" : false
- }
- ],
- "returns" : [
- ],
- "config" : [
- {
- "name" : "editor",
- "type" : "Roo.grid.GridEditor",
- "desc" : "(Optional) For grid editors - returns the grid editor",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "cursor",
- "type" : "String",
- "desc" : "(Optional)",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "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" : [
- ]
- },
- {
- "name" : "tooltip",
- "type" : "String",
- "desc" : "(Optional)",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "(Optional)",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "fixed",
- "type" : "Boolean",
- "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "(Optional) True to hide the column. Defaults to false.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "locked",
- "type" : "Boolean",
- "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "(Optional)",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "renderer",
- "type" : "Function",
- "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "(Optional)",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "sortable",
- "type" : "Boolean",
- "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "header",
- "type" : "String",
- "desc" : "The header text to display in the Grid view.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "(Optional) False to disable column resizing. Defaults to true.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "(Optional)",
- "memberOf" : "Roo.grid.ColumnModel",
- "values" : [
- ]
- }
- ],
- "methods" : [
- {
- "name" : "setRenderer",
- "desc" : "Sets the rendering (formatting) function for a column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "isHidden",
- "desc" : "Returns true if the column is hidden.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "setColumnHeader",
- "desc" : "Sets the header for a column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "header",
- "type" : "String",
- "desc" : "The new header",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "getColumnCount",
- "desc" : "Returns the number of columns.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnHeader",
- "desc" : "Returns the header for the specified column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getRenderer",
- "desc" : "Returns the rendering (formatting) function defined for the column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Function",
- "desc" : "The function used to render the cell. See {@link #setRenderer}."
- }
- ]
- },
- {
- "name" : "getColumnTooltip",
- "desc" : "Returns the tooltip for the specified column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "setColumnWidth",
- "desc" : "Sets the width for a column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "setDataIndex",
- "desc" : "Sets the dataIndex for a column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "dataIndex",
- "type" : "Number",
- "desc" : "The new dataIndex",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "isCellEditable",
- "desc" : "Returns true if the cell is editable.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The row index - this is nto actually used..?",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnsBy",
- "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "result"
- }
- ]
- },
- {
- "name" : "getColumnWidth",
- "desc" : "Returns the width for the specified column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isFixed",
- "desc" : "Returns true if the column width cannot be changed",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- ]
- },
- {
- "name" : "getCellEditor",
- "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnId",
- "desc" : "Returns the id of the column at the specified index.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "the id"
- }
- ]
- },
- {
- "name" : "getDataIndex",
- "desc" : "Returns the dataIndex for the specified column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isResizable",
- "desc" : "Returns true if the column can be resized",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "setColumnTooltip",
- "desc" : "Sets the tooltip for a column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "tooltip",
- "type" : "String",
- "desc" : "The new tooltip",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "setHidden",
- "desc" : "Sets if a column is hidden.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True if the column is hidden",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "setEditable",
- "desc" : "Sets if a column is editable.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "True if the column is editable",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "getColumnById",
- "desc" : "Returns the column for a specified id.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The column id",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "the column"
- }
- ]
- },
- {
- "name" : "getColumnByDataIndex",
- "desc" : "Returns the column for a specified dataIndex.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The column dataIndex",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object|Boolean",
- "desc" : "the column or false if not found"
- }
- ]
- },
- {
- "name" : "setEditor",
- "desc" : "Sets the editor for a column.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "editor",
- "type" : "Object",
- "desc" : "The editor object",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "findColumnIndex",
- "desc" : "Returns the index for a specified column dataIndex.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The column dataIndex",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "the index, or -1 if not found"
- }
- ]
- },
- {
- "name" : "isSortable",
- "desc" : "Returns true if the specified column is sortable.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getIndexById",
- "desc" : "Returns the index for a specified column id.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The column id",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "the index, or -1 if not found"
- }
- ]
- },
- {
- "name" : "getTotalWidth",
- "desc" : "Returns the total width of all columns.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.grid.ColumnModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "includeHidden",
- "type" : "Boolean",
- "desc" : "True to include hidden column widths",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "purgeListeners",
- "desc" : "Removes all listeners for this object",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- ]
- },
- {
- "name" : "on",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "un",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "addEvents",
- "desc" : "Used to define events on this Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "releaseCapture",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "removeListener",
- "desc" : "Removes a listener",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "fireEvent",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "hasListener",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "capture",
- "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.",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "addListener",
- "desc" : "Appends an event handler to this component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "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>",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- }
- ],
- "events" : [
- {
- "name" : "hiddenchange",
- "desc" : "Fires when a column is hidden or \"unhidden\".",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "true if hidden, false otherwise",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "headerchange",
- "desc" : "Fires when the text of a header changes.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "newText",
- "type" : "Number",
- "desc" : "The new header text",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "columlockchange",
- "desc" : "Fires when a column's locked state is changed",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "locked",
- "type" : "Boolean",
- "desc" : "true if locked",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "columnmoved",
- "desc" : "Fires when a column is moved.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "widthchange",
- "desc" : "Fires when the width of a column changes.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "newWidth",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- }
- ]
-}
\ No newline at end of file
projects / roojs1 / blobdiff