"Roo.Component",
"Roo.util.Observable"
],
- "desc" : "Bootstrap Table class",
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.TableBody"
+ ],
+ "tree_parent" : [],
+ "desc" : "Bootstrap Table class. This class represents the primary interface of a component based grid control.\nSimilar to Roo.grid.Grid\n<pre><code>\n var table = Roo.factory({\n xtype : 'Table',\n xns : Roo.bootstrap,\n autoSizeColumns: true,\n \n \n store : {\n xtype : 'Store',\n xns : Roo.data,\n remoteSort : true,\n sortInfo : { direction : 'ASC', field: 'name' },\n proxy : {\n xtype : 'HttpProxy',\n xns : Roo.data,\n method : 'GET',\n url : 'https://example.com/some.data.url.json'\n },\n reader : {\n xtype : 'JsonReader',\n xns : Roo.data,\n fields : [ 'id', 'name', whatever' ],\n id : 'id',\n root : 'data'\n }\n },\n cm : [\n {\n xtype : 'ColumnModel',\n xns : Roo.grid,\n align : 'center',\n cursor : 'pointer',\n dataIndex : 'is_in_group',\n header : \"Name\",\n sortable : true,\n renderer : function(v, x , r) { \n \n return String.format(\"{0}\", v)\n }\n width : 3\n } // more columns..\n ],\n selModel : {\n xtype : 'RowSelectionModel',\n xns : Roo.bootstrap.Table\n // you can add listeners to catch selection change here....\n }\n \n\n });\n // set any options\n grid.render(Roo.get(\"some-div\"));\n</code></pre>\n\nCurrently the Table uses multiple headers to try and handle XL / Medium etc... styling",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "Table",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ],
+ "returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "footerShow",
"type" : "Boolean",
- "desc" : "generate tfoot, default true",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(true",
- "false)"
- ]
+ "desc" : "e) generate tfoot, default true",
+ "memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component",
- "values" : [
- "(display",
- "visibility)"
- ]
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
"name" : "auto_hide_footer",
"type" : "Boolean",
"desc" : "auto hide footer if only one page (default false)",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "scrollBody",
"type" : "Boolean",
- "desc" : "default false - body scrolled / fixed header",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(true",
- "false)"
- ]
+ "desc" : "e) default false - body scrolled / fixed header",
+ "memberOf" : ""
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "A column for the grid.",
+ "memberOf" : ""
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
- },
- {
- "name" : "border",
- "type" : "Number",
- "desc" : "Specifies whether the table cells should have borders or not",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "width",
+ "name" : "minColumnWidth",
"type" : "Number",
- "desc" : "Specifies the width of a table",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "desc" : "default 50 pixels minimum column width",
+ "memberOf" : ""
},
{
"name" : "bordered",
"type" : "boolean",
"desc" : "Add borders to the table",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
- },
- {
- "name" : "rules",
- "type" : "String",
- "desc" : "Specifies which parts of the inside borders that should be visible",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "values" : [
- ]
- },
- {
- "name" : "layout",
- "type" : "String",
- "desc" : "table layout (auto | fixed | initial | inherit)",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : "Roo.Component"
},
{
"name" : "condensed",
"type" : "boolean",
"desc" : "Format condensed",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "frame",
- "type" : "String",
- "desc" : "Specifies which parts of the outside borders that should be visible",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to use",
+ "memberOf" : ""
},
{
"name" : "cellSelection",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(true",
- "false)"
- ]
- },
- {
- "name" : "sortable",
- "type" : "String",
- "desc" : "Specifies that the table should be sortable",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "desc" : "e) default false",
+ "memberOf" : ""
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "values" : [
- ]
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection model to use (cell selection is not supported yet)",
+ "memberOf" : ""
},
{
"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" : [
- ]
+ "memberOf" : "Roo.util.Observable"
},
{
"name" : "striped",
"type" : "boolean",
"desc" : "Should the rows be alternative striped",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
- },
- {
- "name" : "cellspacing",
- "type" : "Number",
- "desc" : "Specifies the space between cells",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Specifies the alignment of a table according to surrounding text",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(left",
- "center",
- "right)"
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "lazyLoad",
"type" : "Boolean",
"desc" : "auto load data while scrolling to the end (default false)",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "footer",
"type" : "Roo.bootstrap.PagingToolbar",
"desc" : "a paging toolbar",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "cls",
"type" : "String",
"desc" : "table class",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
- },
- {
- "name" : "bgcolor",
- "type" : "String",
- "desc" : "Specifies the background color for a table",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "headerShow",
"type" : "Boolean",
- "desc" : "generate thead, default true",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(true",
- "false)"
- ]
+ "desc" : "e) generate thead, default true",
+ "memberOf" : ""
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(true",
- "false)"
- ]
+ "desc" : "e) default false",
+ "memberOf" : ""
},
{
"name" : "hover",
"type" : "boolean",
"desc" : "Add hover highlighting",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
- },
- {
- "name" : "cellpadding",
- "type" : "Number",
- "desc" : "Specifies the space between the cell wall and the cell content",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "values" : [
- ]
+ "memberOf" : "Roo.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- "(el",
- "parent)"
- ]
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "enableColumnResize",
+ "type" : "Boolean",
+ "desc" : "default true if columns can be resized (drag/drop)",
+ "memberOf" : ""
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "values" : [
- ]
- },
- {
- "name" : "summary",
- "type" : "String",
- "desc" : "Specifies a summary of the content of a table",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "rowSelection",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- "(true",
- "false)"
- ]
+ "desc" : "e) default false",
+ "memberOf" : ""
},
{
"name" : "responsive",
"type" : "boolean",
- "desc" : "Format condensed",
- "memberOf" : "Roo.bootstrap.Table",
- "values" : [
- ]
+ "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
+ "memberOf" : ""
}
],
"methods" : [
{
"name" : "setRowVisibility",
+ "type" : "function",
"desc" : "Show or hide a row.",
+ "sig" : "(rowIndex, state)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "rowIndex",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
- "name" : "getGridEl",
- "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "name" : "getRowIndex",
+ "type" : "function",
+ "desc" : "get the Row Index from a dom element.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
+ {
+ "name" : "row",
+ "type" : "Roo.Element",
+ "desc" : "The row to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "ensureVisible",
+ "type" : "function",
+ "desc" : "Scrolls the specified cell into view",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getCellIndex",
+ "type" : "function",
+ "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
+ "sig" : "(cell)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cell",
+ "type" : "domElement",
+ "desc" : "to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getHeaderIndex",
+ "type" : "function",
+ "desc" : "get the header TH element for columnIndex",
+ "sig" : "(columnIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
],
+ "returns" : []
+ },
+ {
+ "name" : "focusRow",
+ "type" : "function",
+ "desc" : "Focuses the specified row.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "autoSize",
+ "type" : "function",
"desc" : "Forces a resize - used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "clear",
+ "type" : "function",
"desc" : "Remove all rows",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "focusCell",
+ "type" : "function",
+ "desc" : "Focuses the specified cell.",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "tooltipEl",
+ "type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "setVisibilityEl",
+ "type" : "function",
"desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "getVisibilityEl",
+ "type" : "function",
"desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "initEvents",
+ "type" : "function",
"desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "getChildContainer",
+ "type" : "function",
"desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "getId",
+ "type" : "function",
"desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "render",
+ "type" : "function",
"desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "container",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "isVisible",
+ "type" : "function",
"desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "setDisabled",
+ "type" : "function",
"desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "disabled",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "focus",
+ "type" : "function",
"desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "selectText",
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "setVisible",
+ "type" : "function",
"desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "visible",
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "getEl",
+ "type" : "function",
"desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"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" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"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",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
],
"events" : [
{
"name" : "rowsrendered",
+ "type" : "function",
"desc" : "Fires when all the rows have been rendered",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "headercontextmenu",
+ "type" : "function",
"desc" : "Fires when a header is right clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowdblclick",
+ "type" : "function",
"desc" : "Fires when a row is double clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "contextmenu",
+ "type" : "function",
"desc" : "The raw contextmenu event for the entire grid.",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
+ },
+ {
+ "name" : "mousedown",
+ "type" : "function",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
"name" : "rowcontextmenu",
+ "type" : "function",
"desc" : "Fires when a row is right clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "cellcontextmenu",
+ "type" : "function",
"desc" : "Fires when a cell is right clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "celldblclick",
+ "type" : "function",
"desc" : "Fires when a cell is double clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowclass",
+ "type" : "function",
"desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, rowcfg)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseover",
+ "type" : "function",
"desc" : "Fires when a mouseover occur",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseout",
+ "type" : "function",
"desc" : "Fires when a mouseout occur",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "cellclick",
+ "type" : "function",
"desc" : "Fires when a cell is clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowclick",
+ "type" : "function",
"desc" : "Fires when a row is clicked",
- "memberOf" : "Roo.bootstrap.Table",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "childrenrendered",
+ "type" : "function",
"desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforerender",
+ "type" : "function",
"desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforehide",
+ "type" : "function",
"desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforeshow",
+ "type" : "function",
"desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforedestroy",
+ "type" : "function",
"desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
]
}
\ No newline at end of file