"Roo.Component",
"Roo.util.Observable"
],
- "desc" : "Bootstrap Table class",
+ "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,
"isBuiltin" : false,
"isOptional" : false
}
],
- "returns" : [
- ],
+ "returns" : [],
"config" : [
{
"name" : "footerShow",
"type" : "Boolean",
"desc" : "auto hide footer if only one page (default false)",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "scrollBody",
"false"
]
},
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "A column for th grid.",
+ "memberOf" : "Roo.bootstrap.Table",
+ "optvals" : []
+ },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
- },
- {
- "name" : "border",
- "type" : "Number",
- "desc" : "Specifies whether the table cells should have borders or not",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
+ "optvals" : []
},
{
- "name" : "width",
+ "name" : "minColumnWidth",
"type" : "Number",
- "desc" : "Specifies the width of a table",
+ "desc" : "default 50 pixels minimum column width",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "bordered",
"type" : "boolean",
"desc" : "Add borders to the table",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
- },
- {
- "name" : "rules",
- "type" : "String",
- "desc" : "Specifies which parts of the inside borders that should be visible",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component",
- "optvals" : [
- ]
- },
- {
- "name" : "layout",
- "type" : "String",
- "desc" : "table layout (auto | fixed | initial | inherit)",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "condensed",
"type" : "boolean",
"desc" : "Format condensed",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
+ "optvals" : []
},
{
- "name" : "frame",
- "type" : "String",
- "desc" : "Specifies which parts of the outside borders that should be visible",
+ "name" : "store",
+ "type" : "Roo.data.Store|Roo.data.SimpleStore",
+ "desc" : "The data store to use",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "cellSelection",
"false"
]
},
- {
- "name" : "sortable",
- "type" : "String",
- "desc" : "Specifies that the table should be sortable",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
- },
{
"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",
- "optvals" : [
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.RowSelectionModel|Roo.grid.CellSelectionModel",
+ "desc" : "The selection model to use (cell selection is not supported yet)",
+ "memberOf" : "Roo.bootstrap.Table",
+ "optvals" : []
},
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "striped",
"type" : "boolean",
"desc" : "Should the rows be alternative striped",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
- },
- {
- "name" : "cellspacing",
- "type" : "Number",
- "desc" : "Specifies the space between cells",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Specifies the alignment of a table according to surrounding text",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- "left",
- "center",
- "right"
- ]
+ "optvals" : []
},
{
"name" : "lazyLoad",
"type" : "Boolean",
"desc" : "auto load data while scrolling to the end (default false)",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "footer",
"type" : "Roo.bootstrap.PagingToolbar",
"desc" : "a paging toolbar",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "table class",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
- },
- {
- "name" : "bgcolor",
- "type" : "String",
- "desc" : "Specifies the background color for a table",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "headerShow",
"type" : "boolean",
"desc" : "Add hover highlighting",
"memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
- },
- {
- "name" : "cellpadding",
- "type" : "Number",
- "desc" : "Specifies the space between the cell wall and the cell content",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "visibilityEl",
"parent"
]
},
+ {
+ "name" : "enableColumnResize",
+ "type" : "Boolean",
+ "desc" : "default true if columns can be resized (drag/drop)",
+ "memberOf" : "Roo.bootstrap.Table",
+ "optvals" : []
+ },
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- ]
- },
- {
- "name" : "summary",
- "type" : "String",
- "desc" : "Specifies a summary of the content of a table",
- "memberOf" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
},
{
"name" : "rowSelection",
{
"name" : "responsive",
"type" : "boolean",
- "desc" : "Format condensed",
+ "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" : "Roo.bootstrap.Table",
- "optvals" : [
- ]
+ "optvals" : []
}
],
"methods" : [
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
- "name" : "getGridEl",
- "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "name" : "getRowIndex",
+ "desc" : "get the Row Index from a dom element.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Roo.Element",
+ "desc" : "The row to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "ensureVisible",
+ "desc" : "Scrolls the specified cell into view",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "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",
+ "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "cell",
+ "type" : "domElement",
+ "desc" : "to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getHeaderIndex",
+ "desc" : "get the header TH element for columnIndex",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
],
+ "returns" : []
+ },
+ {
+ "name" : "focusRow",
+ "desc" : "Focuses the specified row.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getGridEl",
+ "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "focusCell",
+ "desc" : "Focuses the specified cell.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
"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",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "show",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "setVisibilityEl",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "getVisibilityEl",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "initEvents",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "getChildContainer",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "destroy",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "isVisible",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "setDisabled",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "focus",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "un",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addEvents",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "releaseCapture",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "removeListener",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addListener",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
],
"events" : [
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "headercontextmenu",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowdblclick",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "contextmenu",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
+ },
+ {
+ "name" : "mousedown",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "memberOf" : "Roo.bootstrap.Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
"name" : "rowcontextmenu",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "cellcontextmenu",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "celldblclick",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowclass",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseover",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "mouseout",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "cellclick",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "rowclick",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "childrenrendered",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforerender",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "disable",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "render",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "destroy",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "hide",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforehide",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "show",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforeshow",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "enable",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "beforedestroy",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
]
}
\ No newline at end of file