* <pre><code>
[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]
</code></pre>
- * @cfg {String} id (optional) The subscript within row Array that provides an ID for the Record
+
* @constructor
* Create a new JsonReader
* @param {Object} meta Metadata configuration options.
- * @param {Object} recordType Either an Array of field definition objects
+ * @param {Object|Array} recordType Either an Array of field definition objects
+ *
* @cfg {Array} fields Array of field definition objects
* @cfg {String} id Name of the property within a row object that contains a record identifier value.
* as specified to {@link Roo.data.Record#create},
* or an {@link Roo.data.Record} object
+ *
+ *
* created using {@link Roo.data.Record#create}.
*/
Roo.data.ArrayReader = function(meta, recordType){
/**
* Create a data block containing Roo.data.Records from an XML document.
* @param {Object} o An Array of row objects which represents the dataset.
- * @return {Object} data A data block which is used by an Roo.data.Store object as
+ * @return {Object} A data block which is used by an {@link Roo.data.Store} object as
* a cache of Roo.data.Records.
*/
readRecords : function(o){
* @class Roo.data.Connection
* @extends Roo.util.Observable
* The class encapsulates a connection to the page's originating domain, allowing requests to be made
- * either to a configured URL, or to a URL specified at request time.<br><br>
- * <p>
+ * either to a configured URL, or to a URL specified at request time.
+ *
* Requests made by this class are asynchronous, and will return immediately. No data from
* the server will be available to the statement immediately following the {@link #request} call.
- * To process returned data, use a callback in the request options object, or an event listener.</p><br>
- * <p>
+ * To process returned data, use a callback in the request options object, or an event listener.
+ *
* Note: If you are doing a file upload, you will not get a normal response object sent back to
* your callback or event handler. Since the upload is handled via in IFRAME, there is no XMLHttpRequest.
* The response object is created using the innerHTML of the IFRAME's document as the responseText
- * property and, if present, the IFRAME's XML document as the responseXML property.</p><br>
+ * property and, if present, the IFRAME's XML document as the responseXML property.
+ *
* This means that a valid XML or HTML document must be returned. If JSON data is required, it is suggested
* that it be placed either inside a <textarea> in an HTML document and retrieved from the responseText
* using a regex, or inside a CDATA section in an XML document and retrieved from the responseXML using
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden",
+ "desc" : "Fires before this menu is hidden (return false to block)",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
"name" : "id",
"type" : "String",
- "desc" : "(optional) The subscript within row Array that provides an ID for the Record",
+ "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
"memberOf" : ""
}
],
</span><span class="jsdoc-var">this.addEvents</span><span class="jsdoc-syntax">({
</span><span class="jsdoc-comment">/**
* @event beforeshow
- * Fires before this menu is displayed
+ * Fires before this menu is displayed (return false to block)
* @param {Roo.menu.Menu} this
*/
</span><span class="jsdoc-var">beforeshow </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-comment">/**
* @event beforehide
- * Fires before this menu is hidden
+ * Fires before this menu is hidden (return false to block)
* @param {Roo.menu.Menu} this
*/
</span><span class="jsdoc-var">beforehide </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">isVisible </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
</span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">!</span><span class="jsdoc-var">this.hidden</span><span class="jsdoc-syntax">;
},
- </span><span class="jsdoc-var">onMouseOut </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">){
+ </span><span class="jsdoc-var">onMouseOut </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">){
</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">t </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.findTargetItem</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">);
</span><span class="jsdoc-comment">//if(t ){
* the element (defaults to this.defaultAlign)
* @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
*/
- </span><span class="jsdoc-var">show </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">pos</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">parentMenu</span><span class="jsdoc-syntax">){
- </span><span class="jsdoc-var">this.parentMenu </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">parentMenu</span><span class="jsdoc-syntax">;
+ </span><span class="jsdoc-var">show </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">pos</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">parentMenu</span><span class="jsdoc-syntax">)
+ {
+ </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">false </span><span class="jsdoc-syntax">=== </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"beforeshow"</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">)) {
+ </span><span class="jsdoc-var">Roo.log</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"show canceled"</span><span class="jsdoc-syntax">);
+ </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
+ }
+ </span><span class="jsdoc-var">this.parentMenu </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">parentMenu</span><span class="jsdoc-syntax">;
</span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">){
</span><span class="jsdoc-var">this.render</span><span class="jsdoc-syntax">();
}
- </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"beforeshow"</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
+
</span><span class="jsdoc-var">this.showAt</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el.getAlignToXY</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">pos </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">this.defaultAlign</span><span class="jsdoc-syntax">), </span><span class="jsdoc-var">parentMenu</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">);
},
</span><span class="jsdoc-comment">/**
*/
</span><span class="jsdoc-var">hide </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">deep</span><span class="jsdoc-syntax">)
{
-
+ </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">false </span><span class="jsdoc-syntax">=== </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"beforehide"</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">)) {
+ </span><span class="jsdoc-var">Roo.log</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"hide canceled"</span><span class="jsdoc-syntax">);
+ </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
+ }
</span><span class="jsdoc-var">this.hideMenuItems</span><span class="jsdoc-syntax">();
</span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el </span><span class="jsdoc-syntax">&& </span><span class="jsdoc-var">this.isVisible</span><span class="jsdoc-syntax">()){
- </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"beforehide"</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
+
</span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.activeItem</span><span class="jsdoc-syntax">){
</span><span class="jsdoc-var">this.activeItem.deactivate</span><span class="jsdoc-syntax">();
</span><span class="jsdoc-var">this.activeItem </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
</span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">) {
</span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
}
- </span><span class="jsdoc-comment">//$(backdrop).remove()
+
</span><span class="jsdoc-var">this.el.select</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'.open'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.each</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">aa</span><span class="jsdoc-syntax">) {
</span><span class="jsdoc-var">aa.removeClass</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'open'</span><span class="jsdoc-syntax">);
- </span><span class="jsdoc-comment">//var parent = getParent($(this))
- //var relatedTarget = { relatedTarget: this }
- //$parent.trigger(e = $.Event('hide.bs.dropdown', relatedTarget))
- //if (e.isDefaultPrevented()) return
- //$parent.removeClass('open').trigger('hidden.bs.dropdown', relatedTarget)
- </span><span class="jsdoc-syntax">});
+ });
},
</span><span class="jsdoc-var">addxtypeChild </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">cntr</span><span class="jsdoc-syntax">) {
</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">comp</span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.bootstrap.Menu.superclass.addxtypeChild.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">cntr</span><span class="jsdoc-syntax">);
</span><span class="jsdoc-var">e.preventDefault</span><span class="jsdoc-syntax">();
}
- </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'click'</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
+ </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'click'</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">);
},
</span><span class="jsdoc-var">disable </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
* <pre><code>
[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]
</code></pre>
- * @cfg {String} id (optional) The subscript within row Array that provides an ID for the Record
+
* @constructor
* Create a new JsonReader
* @param {Object} meta Metadata configuration options.
- * @param {Object} recordType Either an Array of field definition objects
+ * @param {Object|Array} recordType Either an Array of field definition objects
+ *
* @cfg {Array} fields Array of field definition objects
* @cfg {String} id Name of the property within a row object that contains a record identifier value.
* as specified to {@link Roo.data.Record#create},
* or an {@link Roo.data.Record} object
+ *
+ *
* created using {@link Roo.data.Record#create}.
*/
</span><span class="jsdoc-var">Roo.data.ArrayReader </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">meta</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">recordType</span><span class="jsdoc-syntax">){
</span><span class="jsdoc-comment">/**
* Create a data block containing Roo.data.Records from an XML document.
* @param {Object} o An Array of row objects which represents the dataset.
- * @return {Object} data A data block which is used by an Roo.data.Store object as
+ * @return {Object} A data block which is used by an {@link Roo.data.Store} object as
* a cache of Roo.data.Records.
*/
</span><span class="jsdoc-var">readRecords </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">){
* @class Roo.data.Connection
* @extends Roo.util.Observable
* The class encapsulates a connection to the page's originating domain, allowing requests to be made
- * either to a configured URL, or to a URL specified at request time.<br><br>
- * <p>
+ * either to a configured URL, or to a URL specified at request time.
+ *
* Requests made by this class are asynchronous, and will return immediately. No data from
* the server will be available to the statement immediately following the {@link #request} call.
- * To process returned data, use a callback in the request options object, or an event listener.</p><br>
- * <p>
+ * To process returned data, use a callback in the request options object, or an event listener.
+ *
* Note: If you are doing a file upload, you will not get a normal response object sent back to
* your callback or event handler. Since the upload is handled via in IFRAME, there is no XMLHttpRequest.
* The response object is created using the innerHTML of the IFRAME's document as the responseText
- * property and, if present, the IFRAME's XML document as the responseXML property.</p><br>
+ * property and, if present, the IFRAME's XML document as the responseXML property.
+ *
* This means that a valid XML or HTML document must be returned. If JSON data is required, it is suggested
* that it be placed either inside a &lt;textarea> in an HTML document and retrieved from the responseText
* using a regex, or inside a CDATA section in an XML document and retrieved from the responseXML using
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : true,
+ "memberOf" : "Array",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : true,
+ "memberOf" : "Date",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : true,
+ "memberOf" : "Function",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : true,
+ "memberOf" : "Number",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Global Ajax request class.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Ajax",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Lightweight Dialog Class. The code below shows the creation of a typical dialog using existing HTML markup:\n<pre><code>\nvar dlg = new Roo.BasicDialog(\"my-dlg\", {\n height: 200,\n width: 300,\n minHeight: 100,\n minWidth: 150,\n modal: true,\n proxyDrag: true,\n shadow: true\n});\ndlg.addKeyListener(27, dlg.hide, dlg); // ESC can also close the dialog\ndlg.addButton('OK', dlg.hide, dlg); // Could call a save function instead of hiding\ndlg.addButton('Cancel', dlg.hide, dlg);\ndlg.show();\n</code></pre>\n <b>A Dialog should always be a direct child of the body element.</b>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BasicDialog",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The container element or DOM node, or its id",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "y",
],
"desc" : "This class represents a lightweight region in a layout manager. This region does not move dom nodes\nand does not have a titlebar, tabs or any other features. All it does is size and position \npanels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BasicLayoutRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class represents a common layout manager used in desktop applications. For screenshots and more details,\nplease see: <br><br>\n<a href=\"http://www.jackslocum.com/yui/2006/10/19/cross-browser-web-20-layouts-with-yahoo-ui/\">Cross Browser Layouts - Part 1</a><br>\n<a href=\"http://www.jackslocum.com/yui/2006/10/28/cross-browser-web-20-layouts-part-2-ajax-feed-viewer-20/\">Cross Browser Layouts - Part 2</a><br><br>\nExample:\n <pre><code>\n var layout = new Roo.BorderLayout(document.body, {\n north: {\n initialSize: 25,\n titlebar: false\n },\n west: {\n split:true,\n initialSize: 200,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true\n },\n east: {\n split:true,\n initialSize: 202,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true\n },\n south: {\n split:true,\n initialSize: 100,\n minSize: 100,\n maxSize: 200,\n titlebar: true,\n collapsible: true\n },\n center: {\n titlebar: true,\n autoScroll:true,\n resizeTabs: true,\n minTabWidth: 50,\n preferredTabWidth: 150\n }\n});\n\n// shorthand\nvar CP = Roo.ContentPanel;\n\nlayout.beginUpdate();\nlayout.add(\"north\", new CP(\"north\", \"North\"));\nlayout.add(\"south\", new CP(\"south\", {title: \"South\", closable: true}));\nlayout.add(\"west\", new CP(\"west\", {title: \"West\"}));\nlayout.add(\"east\", new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true}));\nlayout.add(\"center\", new CP(\"center1\", {title: \"Close Me\", closable: true}));\nlayout.add(\"center\", new CP(\"center2\", {title: \"Center Panel\", closable: false}));\nlayout.getRegion(\"center\").showPanel(\"center1\");\nlayout.endUpdate();\n</code></pre>\n\n<b>The container the layout is rendered into can be either the body element or any other element.\nIf it is not the body element, the container needs to either be an absolute positioned element,\nor you will need to add \"position:relative\" to the css of the container. You will also need to specify\nthe container size if it is not the body element.</b>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BorderLayout",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container this layout is bound to",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Base class for any visual {@link Roo.Component} that uses a box container. BoxComponent provides automatic box\nmodel adjustments for sizing and positioning and will work correctly withnin the Component rendering model. All\ncontainer classes should subclass BoxComponent so that they will work consistently when nested within other Ext\nlayout containers.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Roo.Element/String/Object",
+ "desc" : "The configuration options.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Simple Button class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Calendar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CalendarPanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Simple color palette class for choosing colors. The palette can be rendered to any container.<br />\nHere's an example of typical usage:\n<pre><code>\nvar cp = new Roo.ColorPalette({value:'993300'}); // initial selected color\ncp.render('my-div');\n\ncp.on('select', function(palette, selColor){\n // do something with selColor\n});\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ColorPalette",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Base class for all major Roo components. All subclasses of Component can automatically participate in the standard\nRoo component lifecycle of creation, rendering and destruction. They also have automatic support for basic hide/show\nand enable/disable behavior. Component allows any subclass to be lazy-rendered into any {@link Roo.Container} and\nto be automatically registered with the {@link Roo.ComponentMgr} so that it can be referenced at any time via {@link Roo.getCmp}.\nAll visual components (widgets) that require rendering into a layout should subclass Component.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Roo.Element/String/Object",
+ "desc" : "The configuration options. If an element is passed, it is set as the internal\nelement and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element\nand is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Provides a common registry of all components on a page so that they can be easily accessed by component id (see {@link Roo.getCmp}).",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ComponentMgr",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Standard composite class. Creates a Roo.Element for every element in the collection.\n<br><br>\n<b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element\nactions will be performed on all the elements in this collection.</b>\n<br><br>\nAll methods return <i>this</i> and can be chained.\n <pre><code>\n var els = Roo.select(\"#some-el div.some-class\", true);\n // or select directly from an existing element\n var el = Roo.get('some-el');\n el.select('div.some-class', true);\n\n els.setWidth(100); // all elements become 100 width\n els.hide(true); // all elements fade out and hide\n // or\n els.setWidth(100).hide(true);\n </code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CompositeElement",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Flyweight composite class. Reuses the same Roo.Element for element operations.\n <pre><code>\n var els = Roo.select(\"#some-el div.some-class\");\n // or select directly from an existing element\n var el = Roo.get('some-el');\n el.select('div.some-class');\n\n els.setWidth(100); // all elements become 100 width\n els.hide(true); // all elements fade out and hide\n // or\n els.setWidth(100).hide(true);\n </code></pre><br><br>\n<b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element\nactions will be performed on all the elements in this collection.</b>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CompositeElementLite",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A basic ContentPanel element.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ContentPanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The container element for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string to set only the title or a config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "(optional) Set the HTML content for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "region",
+ "type" : "String",
+ "desc" : "(optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "loadOnce",
],
"desc" : "A DnD enabled version of Roo.View.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DDView",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "Element/String",
+ "desc" : "The Element in which to create the View.",
+ "isOptional" : false
+ },
+ {
+ "name" : "tpl",
+ "type" : "String",
+ "desc" : "The template string used to create the markup for each element of the View",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The configuration properties. These include all the config options of\n{@link Roo.View} plus some specific to this class.<br>\n<p>\nDrag/drop is implemented by adding {@link Roo.data.Record}s to the target DDView. If copying is\nnot being performed, the original {@link Roo.data.Record} is removed from the source DDView.<br>\n<p>\nThe following extra CSS rules are needed to provide insertion point highlighting:<pre><code>\n.x-view-drag-insert-above {\n\tborder-top:1px dotted #3366cc;\n}\n.x-view-drag-insert-below {\n\tborder-bottom:1px dotted #3366cc;\n}\n</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "dropGroup",
],
"desc" : "Simple date picker class.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DatePicker",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "startDay",
],
"desc" : "Provides global access to BasicDialogs that have been created and\nsupport for z-indexing (layering) multiple open dialogs.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DialogManager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......)",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Document",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "the methods and properties of the 'base' class for the application.\n\n Generic Page handler - implement this to start your app..\n\neg.\n MyProject = new Roo.Document({\n events : {\n 'load' : true // your events..\n },\n listeners : {\n 'ready' : function() {\n // fired on Roo.onReady()\n }\n }",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Utility class for working with DOM and/or Templates. It transparently supports using HTML fragments or DOM.\nFor more information see <a href=\"http://web.archive.org/web/20071221063734/http://www.jackslocum.com/blog/2006/10/06/domhelper-create-elements-using-dom-html-fragments-or-templates/\">this blog post with examples</a>.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DomHelper",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in).\n<p>\nDomQuery supports most of the <a href=\"http://www.w3.org/TR/2005/WD-css3-selectors-20051215/\">CSS3 selectors spec</a>, along with some custom selectors and basic XPath.</p>\n\n<p>\nAll selectors, attribute filters and pseudos below can be combined infinitely in any order. For example \"div.foo:nth-child(odd)[@foo=bar].bar:first\" would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure.\n</p>\n<h4>Element Selectors:</h4>\n<ul class=\"list\">\n <li> <b>*</b> any element</li>\n <li> <b>E</b> an element with the tag E</li>\n <li> <b>E F</b> All descendent elements of E that have the tag F</li>\n <li> <b>E > F</b> or <b>E/F</b> all direct children elements of E that have the tag F</li>\n <li> <b>E + F</b> all elements with the tag F that are immediately preceded by an element with the tag E</li>\n <li> <b>E ~ F</b> all elements with the tag F that are preceded by a sibling element with the tag E</li>\n</ul>\n<h4>Attribute Selectors:</h4>\n<p>The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.</p>\n<ul class=\"list\">\n <li> <b>E[foo]</b> has an attribute \"foo\"</li>\n <li> <b>E[foo=bar]</b> has an attribute \"foo\" that equals \"bar\"</li>\n <li> <b>E[foo^=bar]</b> has an attribute \"foo\" that starts with \"bar\"</li>\n <li> <b>E[foo$=bar]</b> has an attribute \"foo\" that ends with \"bar\"</li>\n <li> <b>E[foo*=bar]</b> has an attribute \"foo\" that contains the substring \"bar\"</li>\n <li> <b>E[foo%=2]</b> has an attribute \"foo\" that is evenly divisible by 2</li>\n <li> <b>E[foo!=bar]</b> has an attribute \"foo\" that does not equal \"bar\"</li>\n</ul>\n<h4>Pseudo Classes:</h4>\n<ul class=\"list\">\n <li> <b>E:first-child</b> E is the first child of its parent</li>\n <li> <b>E:last-child</b> E is the last child of its parent</li>\n <li> <b>E:nth-child(<i>n</i>)</b> E is the <i>n</i>th child of its parent (1 based as per the spec)</li>\n <li> <b>E:nth-child(odd)</b> E is an odd child of its parent</li>\n <li> <b>E:nth-child(even)</b> E is an even child of its parent</li>\n <li> <b>E:only-child</b> E is the only child of its parent</li>\n <li> <b>E:checked</b> E is an element that is has a checked attribute that is true (e.g. a radio or checkbox) </li>\n <li> <b>E:first</b> the first E in the resultset</li>\n <li> <b>E:last</b> the last E in the resultset</li>\n <li> <b>E:nth(<i>n</i>)</b> the <i>n</i>th E in the resultset (1 based)</li>\n <li> <b>E:odd</b> shortcut for :nth-child(odd)</li>\n <li> <b>E:even</b> shortcut for :nth-child(even)</li>\n <li> <b>E:contains(foo)</b> E's innerHTML contains the substring \"foo\"</li>\n <li> <b>E:nodeValue(foo)</b> E contains a textNode with a nodeValue that equals \"foo\"</li>\n <li> <b>E:not(S)</b> an E element that does not match simple selector S</li>\n <li> <b>E:has(S)</b> an E element that has a descendent that matches simple selector S</li>\n <li> <b>E:next(S)</b> an E element whose next sibling matches simple selector S</li>\n <li> <b>E:prev(S)</b> an E element whose previous sibling matches simple selector S</li>\n</ul>\n<h4>CSS Value Selectors:</h4>\n<ul class=\"list\">\n <li> <b>E{display=none}</b> css value \"display\" that equals \"none\"</li>\n <li> <b>E{display^=none}</b> css value \"display\" that starts with \"none\"</li>\n <li> <b>E{display$=none}</b> css value \"display\" that ends with \"none\"</li>\n <li> <b>E{display*=none}</b> css value \"display\" that contains the substring \"none\"</li>\n <li> <b>E{display%=2}</b> css value \"display\" that is evenly divisible by 2</li>\n <li> <b>E{display!=none}</b> css value \"display\" that does not equal \"none\"</li>\n</ul>",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DomQuery",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "An effort at a dom based template engine..\n\nSimilar to XTemplate, except it uses dom parsing to create the template..\n\nSupported features:\n\n Tags:\n\n<pre><code>\n {a_variable} - output encoded.\n {a_variable.format:(\"Y-m-d\")} - call a method on the variable\n {a_variable:raw} - unencoded output\n {a_variable:toFixed(1,2)} - Roo.util.Format.\"toFixed\"\n {a_variable:this.method_on_template(...)} - call a method on the template object.\n \n</code></pre>\n The tpl tag:\n<pre><code>\n <div roo-for=\"a_variable or condition..\"></div>\n <div roo-if=\"a_variable or condition\"></div>\n <div roo-exec=\"some javascript\"></div>\n <div roo-name=\"named_template\"></div> \n \n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DomTemplate",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "html",
],
"desc" : "A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Editor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "Roo.form.Field",
+ "desc" : "The Field object (or descendant)",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Represents an Element in the DOM.<br><br>\nUsage:<br>\n<pre><code>\nvar el = Roo.get(\"my-div\");\n\n// or with getEl\nvar el = getEl(\"my-div\");\n\n// or with a DOM element\nvar el = Roo.get(myDivElement);\n</code></pre>\nUsing Roo.get() or getEl() instead of calling the constructor directly ensures you get the same object\neach call instead of constructing a new one.<br><br>\n<b>Animations</b><br />\nMany of the functions for manipulating an element have an optional \"animate\" parameter. The animate parameter\nshould either be a boolean (true) or an object literal with animation options. The animation options are:\n<pre>\nOption Default Description\n--------- -------- ---------------------------------------------\nduration .35 The duration of the animation in seconds\neasing easeOut The YUI easing method\ncallback none A function to execute when the anim completes\nscope this The scope (this) of the callback function\n</pre>\nAlso, the Anim object being used for the animation will be set on your options object as \"anim\", which allows you to stop or\nmanipulate the animation. Here's an example:\n<pre><code>\nvar el = Roo.get(\"my-div\");\n\n// no animation\nel.setWidth(100);\n\n// default animation\nel.setWidth(100, true);\n\n// animation with some options set\nel.setWidth(100, {\n duration: 1,\n callback: this.foo,\n scope: this\n});\n\n// using the \"anim\" property to get the Anim object\nvar opt = {\n duration: 1,\n callback: this.foo,\n scope: this\n};\nel.setWidth(100, opt);\n...\nif(opt.anim.isAnimated()){\n opt.anim.stop();\n}\n</code></pre>\n<b> Composite (Collections of) Elements</b><br />\nFor working with collections of Elements, see <a href=\"Roo.CompositeElement.html\">Roo.CompositeElement</a>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceNew",
+ "type" : "Boolean",
+ "desc" : "(optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class).",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides \nseveral useful events directly.\nSee {@link Roo.EventObject} for more details on normalized event objects.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "EventManager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "EventObject exposes the Yahoo! UI Event functionality directly on the object\npassed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code \nExample:\n<pre><code>\n function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject\n e.preventDefault();\n var target = e.getTarget();\n ...\n }\n var myDiv = Roo.get(\"myDiv\");\n myDiv.on(\"click\", handleClick);\n //or\n Roo.EventManager.on(\"myDiv\", 'click', handleClick);\n Roo.EventManager.addListener(\"myDiv\", 'click', handleClick);\n </code></pre>",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "EventObject",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "<p>A class to provide basic animation and visual effects support. <b>Note:</b> This class is automatically applied\nto the {@link Roo.Element} interface when included, so all effects calls should be performed via Element.\nConversely, since the effects are not actually defined in Element, Roo.Fx <b>must</b> be included in order for the \nElement effects to work.</p><br/>\n\n<p>It is important to note that although the Fx methods and many non-Fx Element methods support \"method chaining\" in that\nthey return the Element object itself as the method return value, it is not always possible to mix the two in a single\nmethod chain. The Fx methods use an internal effects queue so that each effect can be properly timed and sequenced.\nNon-Fx methods, on the other hand, have no such internal queueing and will always execute immediately. For this reason,\nwhile it may be possible to mix certain Fx and non-Fx method calls in a single chain, it may not always provide the\nexpected results and should be done with care.</p><br/>\n\n<p>Motion effects support 8-way anchoring, meaning that you can choose one of 8 different anchor points on the Element\nthat will serve as either the start or end point of the animation. Following are all of the supported anchor positions:</p>\n<pre>\nValue Description\n----- -----------------------------\ntl The top left corner\nt The center of the top edge\ntr The top right corner\nl The center of the left edge\nr The center of the right edge\nbl The bottom left corner\nb The center of the bottom edge\nbr The bottom right corner\n</pre>\n<b>Although some Fx methods accept specific custom config parameters, the ones shown in the Config Options section\nbelow are common options that can be passed to any Fx method.</b>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Fx",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "easing",
],
"desc" : "Create a new GridPanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "GridPanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "grid",
+ "type" : "Roo.grid.Grid",
+ "desc" : "The grid for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string to set only the panel's title, or a config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "loadOnce",
],
"desc" : "Provides a the editing component for the HTML editors in Roo. (bootstrap and Roo.form)\n\nany element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "HtmlEditorCore",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Shortcut class to create a JSON + {@link Roo.UpdateManager} template view. Usage:\n<pre><code>\nvar view = new Roo.JsonView({\n container: \"my-element\",\n tpl: '<div id=\"{id}\">{foo} - {bar}</div>', // auto create template\n multiSelect: true, \n jsonRoot: \"data\" \n});\n\n// listen for node click?\nview.on(\"click\", function(vw, index, node, e){\n alert('Node \"' + node.id + '\" at index: ' + index + \" was clicked.\");\n});\n\n// direct load of JSON data\nview.load(\"foobar.php\");\n\n// Example from my blog list\nvar tpl = new Roo.Template(\n '<div class=\"entry\">' +\n '<a class=\"entry-title\" href=\"{link}\">{title}</a>' +\n \"<h4>{date} by {author} | {comments} Comments</h4>{description}\" +\n \"</div><hr />\"\n);\n\nvar moreView = new Roo.JsonView({\n container : \"entry-list\", \n template : tpl,\n jsonRoot: \"posts\"\n});\nmoreView.on(\"beforerender\", this.sortEntries, this);\nmoreView.load({\n url: \"/blog/get-posts.php\",\n params: \"allposts=true\",\n text: \"Loading Blog Entries...\"\n});\n</code></pre>\n\nNote: old code is supported with arguments : (container, template, config)",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "JsonView",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "selectedClass",
],
"desc" : "Handles mapping keys to actions for an element. One key map can be used for multiple actions.\nThe constructor accepts the same config object as defined by {@link #addBinding}.\nIf you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key\ncombination it will call the function with this signature (if the match is a multi-key\ncombination the callback will still be called only once): (String key, Roo.EventObject e)\nA KeyMap can also handle a string representation of keys.<br />\nUsage:\n <pre><code>\n// map one key by key code\nvar map = new Roo.KeyMap(\"my-element\", {\n key: 13, // or Roo.EventObject.ENTER\n fn: myHandler,\n scope: myObject\n});\n\n// map multiple keys to one action by string\nvar map = new Roo.KeyMap(\"my-element\", {\n key: \"a\\r\\n\\t\",\n fn: myHandler,\n scope: myObject\n});\n\n// map multiple keys to multiple actions by strings and array of codes\nvar map = new Roo.KeyMap(\"my-element\", [\n {\n key: [10,13],\n fn: function(){ alert(\"Return was pressed\"); }\n }, {\n key: \"abc\",\n fn: function(){ alert('a, b or c was pressed'); }\n }, {\n key: \"\\t\",\n ctrl:true,\n shift:true,\n fn: function(){ alert('Control + shift + tab was pressed.'); }\n }\n]);\n</code></pre>\n<b>Note: A KeyMap starts enabled</b>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "KeyMap",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to bind to",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config (see {@link #addBinding})",
+ "isOptional" : false
+ },
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "(optional) The event to bind to (defaults to \"keydown\")",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "<p>Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind\nnavigation keys to function calls that will get called when the keys are pressed, providing an easy\nway to implement custom navigation schemes for any UI component.</p>\n<p>The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc,\npageUp, pageDown, del, home, end. Usage:</p>\n <pre><code>\nvar nav = new Roo.KeyNav(\"my-element\", {\n \"left\" : function(e){\n this.moveLeft(e.ctrlKey);\n },\n \"right\" : function(e){\n this.moveRight(e.ctrlKey);\n },\n \"enter\" : function(e){\n this.save();\n },\n scope : this\n});\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "KeyNav",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to bind to",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "disabled",
],
"desc" : "An extended {@link Roo.Element} object that supports a shadow and shim, constrain to viewport and\nautomatic maintaining of shadow/shim positions.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Layer",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "An object with config options.",
+ "isOptional" : false
+ },
+ {
+ "name" : "existingEl",
+ "type" : "String/HTMLElement",
+ "desc" : "(optional) Uses an existing DOM element. If the element is not found it creates it.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "shadow",
],
"desc" : "Dialog which provides adjustments for working with a layout in a Dialog.\nAdd your necessary layout config options to the dialog's config.<br>\nExample usage (including a nested layout):\n<pre><code>\nif(!dialog){\n dialog = new Roo.LayoutDialog(\"download-dlg\", {\n modal: true,\n width:600,\n height:450,\n shadow:true,\n minWidth:500,\n minHeight:350,\n autoTabs:true,\n proxyDrag:true,\n // layout config merges with the dialog config\n center:{\n tabPosition: \"top\",\n alwaysShowTabs: true\n }\n });\n dialog.addKeyListener(27, dialog.hide, dialog);\n dialog.setDefaultButton(dialog.addButton(\"Close\", dialog.hide, dialog));\n dialog.addButton(\"Build It!\", this.getDownload, this);\n\n // we can even add nested layouts\n var innerLayout = new Roo.BorderLayout(\"dl-inner\", {\n east: {\n initialSize: 200,\n autoScroll:true,\n split:true\n },\n center: {\n autoScroll:true\n }\n });\n innerLayout.beginUpdate();\n innerLayout.add(\"east\", new Roo.ContentPanel(\"dl-details\"));\n innerLayout.add(\"center\", new Roo.ContentPanel(\"selection-panel\"));\n innerLayout.endUpdate(true);\n\n var layout = dialog.getLayout();\n layout.beginUpdate();\n layout.add(\"center\", new Roo.ContentPanel(\"standard-panel\",\n {title: \"Download the Source\", fitToFrame:true}));\n layout.add(\"center\", new Roo.NestedLayoutPanel(innerLayout,\n {title: \"Build your own roo.js\"}));\n layout.getRegion(\"center\").showPanel(sp);\n layout.endUpdate();\n}\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LayoutDialog",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The id of or container element, or config",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Base class for layout managers.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LayoutManager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class represents a region in a layout manager.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LayoutRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "cmargins",
],
"desc" : "A simple utility class for generically masking elements while loading data. If the element being masked has\nan underlying {@link Roo.data.Store}, the masking will be automatically synchronized with the store's loading\nprocess and the mask element will be cached for reuse. For all other elements, this mask will replace the\nelement's UpdateManager load indicator and will be destroyed after the initial load.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LoadMask",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element or DOM node, or its id",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "msg",
],
"desc" : "Provides a template that can have child templates. The syntax is:\n<pre><code>\nvar t = new Roo.MasterTemplate(\n\t'<select name=\"{name}\">',\n\t\t'<tpl name=\"options\"><option value=\"{value:trim}\">{text:ellipsis(10)}</option></tpl>',\n\t'</select>'\n);\nt.add('options', {value: 'foo', text: 'bar'});\n// or you can add multiple child elements in one shot\nt.addAll('options', [\n {value: 'foo', text: 'bar'},\n {value: 'foo2', text: 'bar2'},\n {value: 'foo3', text: 'bar3'}\n]);\n// then append, applying the master template values\nt.append('my-form', {name: 'my-select'});\n</code></pre>\nA name attribute for the child template is not required if you have only one child\ntemplate or you want to refer to them by index.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MasterTemplate",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "html",
],
"desc" : "Create a new NestedLayoutPanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NestedLayoutPanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string to set only the title or a config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "loadOnce",
],
"desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "PagingToolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "pageSize",
],
"desc" : "Provides attractive and customizable tooltips for any element.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "QuickTips",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "showDelay",
],
"desc" : "This is a pre-built layout that represents a classic, 5-pane application. It consists of a header, a primary\ncenter region containing two nested regions (a top one for a list view and one for item preview below),\nand regions on either side that can be used for navigation, application commands, informational displays, etc.\nThe setup and configuration work exactly the same as it does for a {@link Roo.BorderLayout} - this class simply\nexpedites the setup of the overall layout and regions for this common application style.\nExample:\n <pre><code>\nvar reader = new Roo.ReaderLayout();\nvar CP = Roo.ContentPanel; // shortcut for adding\n\nreader.beginUpdate();\nreader.add(\"north\", new CP(\"north\", \"North\"));\nreader.add(\"west\", new CP(\"west\", {title: \"West\"}));\nreader.add(\"east\", new CP(\"east\", {title: \"East\"}));\n\nreader.regions.listView.add(new CP(\"listView\", \"List\"));\nreader.regions.preview.add(new CP(\"preview\", \"Preview\"));\nreader.endUpdate();\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ReaderLayout",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ },
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The container this layout is bound to (defaults to\ndocument.body if omitted)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "<p>Applies drag handles to an element to make it resizable. The drag handles are inserted into the element\nand positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap\nthe textarea in a div and set \"resizeChild\" to true (or to the id of the element), <b>or</b> set wrap:true in your config and\nthe element will be wrapped for you automatically.</p>\n<p>Here is the list of valid resize handles:</p>\n<pre>\nValue Description\n------ -------------------\n 'n' north\n 's' south\n 'e' east\n 'w' west\n 'nw' northwest\n 'sw' southwest\n 'se' southeast\n 'ne' northeast\n 'hd' horizontal drag\n 'all' all\n</pre>\n<p>Here's an example showing the creation of a typical Resizable:</p>\n<pre><code>\nvar resizer = new Roo.Resizable(\"element-id\", {\n handles: 'all',\n minWidth: 200,\n minHeight: 100,\n maxWidth: 500,\n maxHeight: 400,\n pinned: true\n});\nresizer.on(\"resize\", myHandler);\n</code></pre>\n<p>To hide a particular handle, set its display to none in CSS, or through script:<br>\nresizer.east.setDisplayed(false);</p>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Resizable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The id or element to resize",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "easing",
],
"desc" : "Simple class that can provide a shadow effect for any element. Note that the element MUST be absolutely positioned,\nand the shadow does not provide any shimming. This should be used only in simple cases -- for more advanced\nfunctionality that can also provide the same shadow effect, see the {@link Roo.Layer} class.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Shadow",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "offset",
],
"desc" : "Adapter that moves the splitter element to align with the resized sizing element. \nUsed with an absolute positioned SplitBar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "AbsoluteLayoutAdapter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The container that wraps around the absolute positioned content. If it's\ndocument.body, make sure you assign an id to the body element.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Default Adapter. It assumes the splitter and resizing element are not positioned\nelements and only gets/sets the width of the element. Generally used for table based layouts.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BasicLayoutAdapter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized).\n<br><br>\nUsage:\n<pre><code>\nvar split = new Roo.SplitBar(\"elementToDrag\", \"elementToSize\",\n Roo.SplitBar.HORIZONTAL, Roo.SplitBar.LEFT);\nsplit.setAdapter(new Roo.SplitBar.AbsoluteLayoutAdapter(\"container\"));\nsplit.minSize = 100;\nsplit.maxSize = 600;\nsplit.animate = true;\nsplit.on('moved', splitterMoved);\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SplitBar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "dragElement",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to be dragged and act as the SplitBar.",
+ "isOptional" : false
+ },
+ {
+ "name" : "resizingElement",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to be resized based on where the SplitBar element is dragged",
+ "isOptional" : false
+ },
+ {
+ "name" : "orientation",
+ "type" : "Number",
+ "desc" : "(optional) Either Roo.SplitBar.HORIZONTAL or Roo.SplitBar.VERTICAL. (Defaults to HORIZONTAL)",
+ "isOptional" : false
+ },
+ {
+ "name" : "placement",
+ "type" : "Number",
+ "desc" : "(optional) Either Roo.SplitBar.LEFT or Roo.SplitBar.RIGHT for horizontal or \n Roo.SplitBar.TOP or Roo.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial\n position of the SplitBar).",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A split button that provides a built-in dropdown arrow that can fire an event separately from the default\nclick event of the button. Typically this would be used to display a dropdown menu that provides additional\noptions to the primary button action, but any custom handler can provide the arrowclick implementation.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SplitButton",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "renderTo",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to append the button to",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Adds a splitbar and other (private) useful functionality to a {@link Roo.LayoutRegion}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SplitLayoutRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "cmargins",
],
"desc" : "A lightweight tab container.\n<br><br>\nUsage:\n<pre><code>\n// basic tabs 1, built from existing content\nvar tabs = new Roo.TabPanel(\"tabs1\");\ntabs.addTab(\"script\", \"View Script\");\ntabs.addTab(\"markup\", \"View Markup\");\ntabs.activate(\"script\");\n\n// more advanced tabs, built from javascript\nvar jtabs = new Roo.TabPanel(\"jtabs\");\njtabs.addTab(\"jtabs-1\", \"Normal Tab\", \"My content was added during construction.\");\n\n// set up the UpdateManager\nvar tab2 = jtabs.addTab(\"jtabs-2\", \"Ajax Tab 1\");\nvar updater = tab2.getUpdateManager();\nupdater.setDefaultUrl(\"ajax1.htm\");\ntab2.on('activate', updater.refresh, updater, true);\n\n// Use setUrl for Ajax loading\nvar tab3 = jtabs.addTab(\"jtabs-3\", \"Ajax Tab 2\");\ntab3.setUrl(\"ajax2.htm\", null, true);\n\n// Disabled tab\nvar tab4 = jtabs.addTab(\"tabs1-5\", \"Disabled Tab\", \"Can't see me cause I'm disabled\");\ntab4.disable();\n\njtabs.activate(\"jtabs-1\");\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabPanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The id, DOM element or Roo.Element container where this TabPanel is to be rendered.",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object/Boolean",
+ "desc" : "Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Represents an individual item (tab plus body) in a TabPanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabPanelItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The {@link Roo.TabPanel} this TabPanelItem belongs to",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of this TabPanelItem",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab of this TabPanelItem",
+ "isOptional" : false
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True to allow this TabPanelItem to be closable (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Represents an HTML fragment template. Templates can be precompiled for greater performance.\nFor a list of available format functions, see {@link Roo.util.Format}.<br />\nUsage:\n<pre><code>\nvar t = new Roo.Template({\n html : '<div name=\"{id}\">' + \n '<span class=\"{cls}\">{name:trim} {someval:this.myformat}{value:ellipsis(10)}</span>' +\n '</div>',\n myformat: function (value, allValues) {\n return 'XX' + value;\n }\n});\nt.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});\n</code></pre>\nFor more information see this blog post with examples:\n <a href=\"http://www.cnitblog.com/seeyeah/archive/2011/12/30/38728.html/\">DomHelper\n - Create Elements using DOM, HTML fragments and Templates</a>.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Template",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "- Configuration object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "html",
],
"desc" : "A button that renders into a toolbar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A standard {@link Roo.Button} config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A simple element that adds a greedy (100% width) horizontal space to a toolbar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Fill",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "The base class that other classes should extend in order to get some basic common toolbar item functionality.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A simple toolbar separator class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Separator",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A simple element that adds extra horizontal space to a toolbar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Spacer",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A menu button that renders into a toolbar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SplitButton",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A standard {@link Roo.SplitButton} config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A simple class that renders text directly into a toolbar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TextItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Basic Toolbar class.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "container",
],
"desc" : "Create a new TreePanel. - defaults to fit/scoll contents.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreePanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string to set only the panel's title, or a config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "loadOnce",
],
"desc" : "Default Content renderer. Updates the elements innerHTML with the responseText.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BasicRenderer",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "The defaults collection enables customizing the default properties of UpdateManager",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "defaults",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Provides AJAX-style update for Element object.<br><br>\nUsage:<br>\n<pre><code>\n// Get it from a Roo.Element object\nvar el = Roo.get(\"foo\");\nvar mgr = el.getUpdateManager();\nmgr.update(\"http://myserver.com/index.php\", \"param1=1&param2=2\");\n...\nmgr.formUpdate(\"myFormId\", \"http://myserver.com/index.php\");\n<br>\n// or directly (returns the same UpdateManager instance)\nvar mgr = new Roo.UpdateManager(\"myElementId\");\nmgr.startAutoRefresh(60, \"http://myserver.com/index.php\");\nmgr.on(\"update\", myFcnNeedsToKnow);\n<br>\n // short handed call directly from the element object\n Roo.get(\"foo\").load({\n url: \"bar.php\",\n scripts:true,\n params: \"for=bar\",\n text: \"Loading Foo...\"\n });\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "UpdateManager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to update",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceNew",
+ "type" : "Boolean",
+ "desc" : "(optional) By default the constructor checks to see if the passed element already has an UpdateManager and if it does it returns the same instance. This will skip that check (useful for extending this class).",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Create a \"View\" for an element based on a data model or UpdateManager and the supplied DomHelper template. \nThis class also supports single and multi selection modes. <br>\nCreate a data model bound view:\n <pre><code>\n var store = new Roo.data.Store(...);\n\n var view = new Roo.View({\n el : \"my-element\",\n tpl : '<div id=\"{0}\">{2} - {1}</div>', // auto create template\n \n singleSelect: true,\n selectedClass: \"ydataview-selected\",\n store: store\n });\n\n // listen for node click?\n view.on(\"click\", function(vw, index, node, e){\n alert('Node \"' + node.id + '\" at index: ' + index + \" was clicked.\");\n });\n\n // load XML data\n dataModel.load(\"foobar.xml\");\n </code></pre>\n For an example of creating a JSON/UpdateManager view, see {@link Roo.JsonView}.\n<br><br>\n<b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to\nIE\"s limited insertion support with tables and Opera\"s faulty event bubbling.</b>\n\nNote: old style constructor is still suported (container, template, config)",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "View",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "selectedClass",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.XComponent.event.events",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A delayed Element creator...\nOr a way to group chunks of interface together.\ntechnically this is a wrapper around a tree of Roo elements (which defines a 'module'),\n used in conjunction with XComponent.build() it will create an instance of each element,\n then call addxtype() to build the User interface.\n\nMypart.xyx = new Roo.XComponent({\n\n parent : 'Mypart.xyz', // empty == document.element.!!\n order : '001',\n name : 'xxxx'\n region : 'xxxx'\n disabled : function() {} \n \n tree : function() { // return an tree of xtype declared components\n var MODULE = this;\n return \n {\n xtype : 'NestedLayoutPanel',\n // technicall\n }\n ]\n})\n\n\nIt can be used to build a big heiracy, with parent etc.\nor you can just use this to render a single compoent to a dom element\nMYPART.render(Roo.Element | String(id) | dom_element )\n\n\nUsage patterns.\n\nClassic Roo\n\nRoo is designed primarily as a single page application, so the UI build for a standard interface will\nexpect a single 'TOP' level module normally indicated by the 'parent' of the XComponent definition being defined as false.\n\nEach sub module is expected to have a parent pointing to the class name of it's parent module.\n\nWhen the top level is false, a 'Roo.BorderLayout' is created and the element is flagged as 'topModule'\n- if mulitple topModules exist, the last one is defined as the top module.\n\nEmbeded Roo\n\nWhen the top level or multiple modules are to embedded into a existing HTML page,\nthe parent element can container '#id' of the element where the module will be drawn.\n\nBootstrap Roo\n\nUnlike classic Roo, the bootstrap tends not to be used as a single page.\nit relies more on a include mechanism, where sub modules are included into an outer page.\nThis is normally managed by the builder tools using Roo.apply( options, Included.Sub.Module )\n\nBootstrap Roo Included elements\n\nOur builder application needs the ability to preview these sub compoennts. They will normally have parent=false set,\nhence confusing the component builder as it thinks there are multiple top level elements. \n\nString Over-ride & Translations\n\nOur builder application writes all the strings as _strings and _named_strings. This is to enable the translation of elements,\nand also the 'overlaying of string values - needed when different versions of the same application with different text content\nare needed. @see Roo.XComponent.overlayString",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "XComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "",
+ "desc" : "{Object} configuration of component",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Provides a template that can have nested templates for loops or conditionals. The syntax is:\n<pre><code>\nvar t = new Roo.XTemplate(\n\t'<select name=\"{name}\">',\n\t\t'<tpl for=\"options\"><option value=\"{value:trim}\">{text:ellipsis(10)}</option></tpl>',\n\t'</select>'\n);\n \n// then append, applying the master template values\n </code></pre>\n\nSupported features:\n\n Tags:\n\n<pre><code>\n {a_variable} - output encoded.\n {a_variable.format:(\"Y-m-d\")} - call a method on the variable\n {a_variable:raw} - unencoded output\n {a_variable:toFixed(1,2)} - Roo.util.Format.\"toFixed\"\n {a_variable:this.method_on_template(...)} - call a method on the template object.\n \n</code></pre>\n The tpl tag:\n<pre><code>\n <tpl for=\"a_variable or condition..\"></tpl>\n <tpl if=\"a_variable or condition\"></tpl>\n <tpl exec=\"some javascript\"></tpl>\n <tpl name=\"named_template\"></tpl> (experimental)\n \n <tpl for=\".\"></tpl> - just iterate the property..\n <tpl for=\"..\"></tpl> - iterates with the parent (probably the template) \n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "XTemplate",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "html",
],
"desc" : "Bootstrap Alert class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Alert",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap BezierSignature class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BezierSignature",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Body class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Body",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Brick class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Brick",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Button class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "toggle",
],
"desc" : "Bootstrap ButtonGroup class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ButtonGroup",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "btn",
],
"desc" : "Bootstrap Calendar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Calendar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "startDay",
],
"desc" : "Bootstrap CheckBox class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CheckBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Column class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Column",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A combobox control with support for autocomplete, remote-loading, paging and many other features.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "growMax",
],
"desc" : "Bootstrap Component base class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Container class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Container",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "panel",
],
"desc" : "Bootstrap DateField class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DateField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap DateSplitField class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DateSplitField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "Bootstrap DocumentManager class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DocumentManager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "Bootstrap DocumentSlider class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DocumentSlider",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap DocumentViewer class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DocumentViewer",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Element class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap FieldLabel class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "FieldLabel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Form class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Form",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "Bootstrap Graph class\n> Prameters\n -sm {number} sm 4\n -md {number} md 5",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Graph",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "g_y",
],
"desc" : "Bootstrap Header class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Header",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap HtmlEditor class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "HtmlEditor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Img class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Img",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "src",
],
"desc" : "Bootstrap Input class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Layout Masonry class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LayoutMasonry",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "alternativePadWidth",
],
"desc" : "Bootstrap Layout Masonry class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LayoutMasonryAuto",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "isResizingContainer",
],
"desc" : "Bootstrap Link Class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Link",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "anchor",
],
"desc" : "Bootstrap LocationPicker class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "LocationPicker",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap MasonryBrick class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MasonryBrick",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Menu class - container for MenuItems",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "isLink",
},
{
"name" : "beforehide",
- "desc" : "Fires before this menu is hidden",
+ "desc" : "Fires before this menu is hidden (return false to block)",
"memberOf" : "",
"example" : "",
"deprecated" : "",
},
{
"name" : "beforeshow",
- "desc" : "Fires before this menu is displayed",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"memberOf" : "",
"example" : "",
"deprecated" : "",
],
"desc" : "Bootstrap MenuItem class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MenuItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Provides a common registry of all menu items on a page so that they can be easily accessed by id.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MenuMgr",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Bootstrap MenuSeparator class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MenuSeparator",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap MessageBar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MessageBar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used.\nExample usage:\n<pre><code>\n// Basic alert:\nRoo.Msg.alert('Status', 'Changes saved successfully.');\n\n// Prompt for user data:\nRoo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){\n if (btn == 'ok'){\n // process text value...\n }\n});\n\n// Show a dialog using config options:\nRoo.Msg.show({\n title:'Save Changes?',\n msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',\n buttons: Roo.Msg.YESNOCANCEL,\n fn: processResult,\n animEl: 'elId'\n});\n</code></pre>",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MessageBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Bootstrap Modal class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Modal",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap MoneyField class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MoneyField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "growMax",
],
"desc" : "Bootstrap MonthField class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MonthField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap NavGroup class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavGroup",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Sidebar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavHeaderbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "brand_href",
],
"desc" : "Bootstrap Navbar.NavItem class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap NavProgressBar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavProgressBar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap NavProgressItem class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavProgressItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Sidebar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavSidebar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Navbar.NavSidebarItem class\n{String} badgeWeight (default|primary|success|info|warning|danger)the extra classes for the badge\n{Boolean} open is the menu open\n{Boolean} buttonView use button as the tigger el rather that a (default false)\n{String} buttonWeight (default|primary|success|info|warning|danger)the extra classes for the button\n{String} buttonSize (sm|md|lg)the extra classes for the button\n{Boolean} showArrow show arrow next to the text (default true)",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavSidebarItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Sidebar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NavSimplebar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Navbar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Navbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap NumberField class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NumberField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Pagination class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Pagination",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap PaginationItem class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "PaginationItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "PagingToolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "An input with International dial-code selection",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "PhoneInput",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "Bootstrap Popover class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Popover",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "placement",
],
"desc" : "Bootstrap Progress class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Progress",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap ProgressBar class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ProgressBar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "label",
],
"desc" : "Bootstrap Radio class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Radio",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap RadioSet class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "RadioSet",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Row class (contains columns...)",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Row",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap SecurePass class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SecurePass",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Slider class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Slider",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Adapter that moves the splitter element to align with the resized sizing element. \nUsed with an absolute positioned SplitBar.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "AbsoluteLayoutAdapter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The container that wraps around the absolute positioned content. If it's\ndocument.body, make sure you assign an id to the body element.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Default Adapter. It assumes the splitter and resizing element are not positioned\nelements and only gets/sets the width of the element. Generally used for table based layouts.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BasicLayoutAdapter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized).\n<br><br>\nUsage:\n<pre><code>\nvar split = new Roo.bootstrap.SplitBar(\"elementToDrag\", \"elementToSize\",\n Roo.bootstrap.SplitBar.HORIZONTAL, Roo.bootstrap.SplitBar.LEFT);\nsplit.setAdapter(new Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter(\"container\"));\nsplit.minSize = 100;\nsplit.maxSize = 600;\nsplit.animate = true;\nsplit.on('moved', splitterMoved);\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SplitBar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Column class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabGroup",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "xsoff",
],
"desc" : "Bootstrap TabPanel class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabPanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Abstract base class for grid SelectionModels. It provides the interface that should be\nimplemented by descendant classes. This class should not be directly instantiated.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "AbstractSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "The default SelectionModel used by {@link Roo.bootstrap.Table}.\nIt supports multiple selections and keyboard selection/navigation.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "RowSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Table class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Table",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "footerShow",
],
"desc" : "Bootstrap TableBody class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TableBody",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "charoff",
],
"desc" : "Bootstrap TableCell class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TableCell",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "abbr",
],
"desc" : "Bootstrap TableRow class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TableRow",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "charoff",
],
"desc" : "Bootstrap TextArea class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TextArea",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap DateField class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TimeField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "validFeedbackIcon",
],
"desc" : "Bootstrap Tooltip class\nThis is basic at present - all componets support it by default, however they should add tooltipEl() method\nto determine which dom element triggers the tooltip.\n\nIt needs to add support for additional attributes like tooltip-position",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Tooltip",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).\nThe trigger has no default action, so you must assign a function to implement the trigger click handler by\noverriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox\nfor which you can provide a custom implementation. For example:\n<pre><code>\nvar trigger = new Roo.bootstrap.TriggerField();\ntrigger.onTriggerClick = myTriggerFn;\ntrigger.applyTo('my-field');\n</code></pre>\n\nHowever, in general you will most likely want to use TriggerField as the base class for a reusable component.\n{@link Roo.bootstrap.DateField} and {@link Roo.bootstrap.ComboBox} are perfect examples of this.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TriggerField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options (valid {@Roo.bootstrap.Input} config options will also be applied\nto the base TextField)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "Bootstrap UploadCropbox class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "UploadCropbox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap NumberBox class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NumberBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "footer",
],
"desc" : "Bootstrap TabBox class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap TabPane class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabPane",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.bootstrap.dash",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Basic Toolbar\n\nUsage:\n\n new Roo.bootstrap.HtmlEditor({\n ....\n toolbars : [\n new Roo.bootstrap.HtmlEditorToolbar1({\n disable : { fonts: 1 , format: 1, ..., ... , ...],\n btns : [ .... ]\n })\n }",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ToolbarStandard",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "btns",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.bootstrap.htmleditor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.bootstrap",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "This class represents a lightweight region in a layout manager. This region does not move dom nodes\nand does not have a titlebar, tabs or any other features. All it does is size and position \npanels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Basic",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class represents a common layout manager used in desktop applications. For screenshots and more details,\nplease see: examples/bootstrap/nested.html<br><br>\n \n<b>The container the layout is rendered into can be either the body element or any other element.\nIf it is not the body element, the container needs to either be an absolute positioned element,\nor you will need to add \"position:relative\" to the css of the container. You will also need to specify\nthe container size if it is not the body element.</b>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Border",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Base class for layout managers.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Manager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class represents a region in a layout manager.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Region",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "cmargins",
],
"desc" : "Adds a splitbar and other (private) useful functionality to a {@link Roo.LayoutRegion}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Split",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.bootstrap.layout",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Bootstrap MenuItem class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Menu class - container for Menu",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Bootstrap Separator class",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Separator",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.bootstrap.menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A basic ContentPanel element.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Content",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The container element for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string to set only the title or a config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "(optional) Set the HTML content for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "region",
+ "type" : "String",
+ "desc" : "(optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "loadOnce",
],
"desc" : "Create a new GridPanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A the config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Create a new Panel, that can contain a layout.Border.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Nest",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string to set only the title or a config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "loadOnce",
],
"desc" : "Represents an individual item (tab plus body) in a TabPanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TabItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The {@link Roo.TabPanel} this TabPanelItem belongs to",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of this TabPanelItem",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab of this TabPanelItem",
+ "isOptional" : false
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True to allow this TabPanelItem to be closable (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A lightweight tab container.\n<br><br>\nUsage:\n<pre><code>\n// basic tabs 1, built from existing content\nvar tabs = new Roo.TabPanel(\"tabs1\");\ntabs.addTab(\"script\", \"View Script\");\ntabs.addTab(\"markup\", \"View Markup\");\ntabs.activate(\"script\");\n\n// more advanced tabs, built from javascript\nvar jtabs = new Roo.TabPanel(\"jtabs\");\njtabs.addTab(\"jtabs-1\", \"Normal Tab\", \"My content was added during construction.\");\n\n// set up the UpdateManager\nvar tab2 = jtabs.addTab(\"jtabs-2\", \"Ajax Tab 1\");\nvar updater = tab2.getUpdateManager();\nupdater.setDefaultUrl(\"ajax1.htm\");\ntab2.on('activate', updater.refresh, updater, true);\n\n// Use setUrl for Ajax loading\nvar tab3 = jtabs.addTab(\"jtabs-3\", \"Ajax Tab 2\");\ntab3.setUrl(\"ajax2.htm\", null, true);\n\n// Disabled tab\nvar tab4 = jtabs.addTab(\"tabs1-5\", \"Disabled Tab\", \"Can't see me cause I'm disabled\");\ntab4.disable();\n\njtabs.activate(\"jtabs-1\");\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Tabs",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The id, DOM element or Roo.Element container where this TabPanel is to be rendered.",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object/Boolean",
+ "desc" : "Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.bootstrap.panel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Data reader class to create an Array of Roo.data.Record objects from an Array.\nEach element of that Array represents a row of data fields. The\nfields are pulled into a Record object using as a subscript, the <em>mapping</em> property\nof the field definition if it exists, or the field's ordinal position in the definition.<br>\n<p>\nExample code:.\n<pre><code>\nvar RecordDef = Roo.data.Record.create([\n {name: 'name', mapping: 1}, // \"mapping\" only needed if an \"id\" field is present which\n {name: 'occupation', mapping: 2} // precludes using the ordinal position as the index.\n]);\nvar myReader = new Roo.data.ArrayReader({\n id: 0 // The subscript within row Array that provides an ID for the Record (optional)\n}, RecordDef);\n</code></pre>\n<p>\nThis would consume an Array like this:\n<pre><code>\n[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]\n </code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ArrayReader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "Metadata configuration options.",
+ "isOptional" : false
+ },
+ {
+ "name" : "recordType",
+ "type" : "Object|Array",
+ "desc" : "Either an Array of field definition objects",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
"memberOf" : "Roo.data.ArrayReader",
"values" : [
]
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "(optional) The subscript within row Array that provides an ID for the Record",
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
"memberOf" : "Roo.data.ArrayReader",
"values" : [
]
{
"name" : "",
"type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
}
]
},
"augments" : [
"Roo.util.Observable"
],
- "desc" : "The class encapsulates a connection to the page's originating domain, allowing requests to be made\neither to a configured URL, or to a URL specified at request time.<br><br>\n<p>\nRequests made by this class are asynchronous, and will return immediately. No data from\nthe server will be available to the statement immediately following the {@link #request} call.\nTo process returned data, use a callback in the request options object, or an event listener.</p><br>\n<p>\nNote: If you are doing a file upload, you will not get a normal response object sent back to\nyour callback or event handler. Since the upload is handled via in IFRAME, there is no XMLHttpRequest.\nThe response object is created using the innerHTML of the IFRAME's document as the responseText\nproperty and, if present, the IFRAME's XML document as the responseXML property.</p><br>\nThis means that a valid XML or HTML document must be returned. If JSON data is required, it is suggested\nthat it be placed either inside a <textarea> in an HTML document and retrieved from the responseText\nusing a regex, or inside a CDATA section in an XML document and retrieved from the responseXML using\nstandard DOM methods.",
+ "desc" : "The class encapsulates a connection to the page's originating domain, allowing requests to be made\neither to a configured URL, or to a URL specified at request time. \n\nRequests made by this class are asynchronous, and will return immediately. No data from\nthe server will be available to the statement immediately following the {@link #request} call.\nTo process returned data, use a callback in the request options object, or an event listener.\n\nNote: If you are doing a file upload, you will not get a normal response object sent back to\nyour callback or event handler. Since the upload is handled via in IFRAME, there is no XMLHttpRequest.\nThe response object is created using the innerHTML of the IFRAME's document as the responseText\nproperty and, if present, the IFRAME's XML document as the responseXML property.\n\nThis means that a valid XML or HTML document must be returned. If JSON data is required, it is suggested\nthat it be placed either inside a <textarea> in an HTML document and retrieved from the responseText\nusing a regex, or inside a CDATA section in an XML document and retrieved from the responseXML using\nstandard DOM methods.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Connection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "a configuration object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class is an abstract base class for implementations which provide retrieval of\nunformatted data objects.<br>\n<p>\nDataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader\n(of the appropriate type which knows how to parse the data object) to provide a block of\n{@link Roo.data.Records} to an {@link Roo.data.Store}.<br>\n<p>\nCustom implementations must implement the load method as described in\n{@link Roo.data.HttpProxy#load}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Base class for reading structured data from a data source. This class is intended to be\nextended (see {Roo.data.ArrayReader}, {Roo.data.JsonReader} and {Roo.data.XmlReader}) and should not be created directly.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DataReader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "An implementation of {@link Roo.data.DataProxy} that reads a data object from an {@link Roo.data.Connection} object\nconfigured to reference a certain URL.<br><br>\n<p>\n<em>Note that this class cannot be used to retrieve data from a domain other than the domain\nfrom which the running page was served.<br><br>\n<p>\nFor cross-domain access to remote data, use an {@link Roo.data.ScriptTagProxy}.</em><br><br>\n<p>\nBe aware that to enable the browser to parse an XML document, the server must set\nthe Content-Type header in the HTTP response to \"text/xml\".",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "HttpProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "conn",
+ "type" : "Object",
+ "desc" : "Connection config options to add to each request (e.g. {url: 'foo.php'} or\nan {@link Roo.data.Connection} object. If a Connection config is passed, the singleton {@link Roo.Ajax} object\nwill be used to make the request.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "method",
],
"desc" : "Data reader class to create an Array of Roo.data.Record objects from a JSON response\nbased on mappings in a provided Roo.data.Record constructor.\n\nThe default behaviour of a store is to send ?_requestMeta=1, unless the class has recieved 'metaData' property\nin the reply previously. \n\n<p>\nExample code:\n<pre><code>\nvar RecordDef = Roo.data.Record.create([\n {name: 'name', mapping: 'name'}, // \"mapping\" property not needed if it's the same as \"name\"\n {name: 'occupation'} // This field will use \"occupation\" as the mapping.\n]);\nvar myReader = new Roo.data.JsonReader({\n totalProperty: \"results\", // The property which contains the total dataset size (optional)\n root: \"rows\", // The property which contains an Array of row objects\n id: \"id\" // The property within each row object that provides an ID for the record (optional)\n}, RecordDef);\n</code></pre>\n<p>\nThis would consume a JSON file like this:\n<pre><code>\n{ 'results': 2, 'rows': [\n { 'id': 1, 'name': 'Bill', occupation: 'Gardener' },\n { 'id': 2, 'name': 'Ben', occupation: 'Horticulturalist' } ]\n}\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "JsonReader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "Metadata configuration options",
+ "isOptional" : false
+ },
+ {
+ "name" : "recordType",
+ "type" : "Object",
+ "desc" : "Either an Array of field definition objects,\nor an {@link Roo.data.Record} object created using {@link Roo.data.Record#create}.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "id",
],
"desc" : "/**",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "JsonStore",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "An implementation of Roo.data.DataProxy that simply passes the data specified in its constructor\nto the Reader when its load method is called.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MemoryProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Node",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "attributes",
+ "type" : "Object",
+ "desc" : "The attributes/config for the node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Instances of this class encapsulate both record <em>definition</em> information, and record\n<em>value</em> information for use in {@link Roo.data.Store} objects, or any code which needs\nto access Records cached in an {@link Roo.data.Store} object.<br>\n<p>\nConstructors for this class are generated by passing an Array of field definition objects to {@link #create}.\nInstances are usually only created by {@link Roo.data.Reader} implementations when processing unformatted data\nobjects.<br>\n<p>\nRecord objects generated by this constructor inherit all the methods of Roo.data.Record listed below.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Record",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "An associative Array of data values keyed by the field name.",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "Object",
+ "desc" : "(Optional) The id of the record. This id should be unique, and is used by the\n{@link Roo.data.Store} object which owns the Record to index its collection of Records. If\nnot specified an integer id is generated.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "An implementation of Roo.data.DataProxy that reads a data object from a URL which may be in a domain\nother than the originating domain of the running page.<br><br>\n<p>\n<em>Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain\nof the running page, you must use this class, rather than DataProxy.</em><br><br>\n<p>\nThe content passed back from a server resource requested by a ScriptTagProxy is executable JavaScript\nsource code that is used as the source inside a <script> tag.<br><br>\n<p>\nIn order for the browser to process the returned data, the server must wrap the data object\nwith a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy.\nBelow is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy\ndepending on whether the callback name was passed:\n<p>\n<pre><code>\nboolean scriptTag = false;\nString cb = request.getParameter(\"callback\");\nif (cb != null) {\n scriptTag = true;\n response.setContentType(\"text/javascript\");\n} else {\n response.setContentType(\"application/x-json\");\n}\nWriter out = response.getWriter();\nif (scriptTag) {\n out.write(cb + \"(\");\n}\nout.print(dataBlock.toJsonString());\nif (scriptTag) {\n out.write(\");\");\n}\n</pre></code>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ScriptTagProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A configuration object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "timeout",
],
"desc" : "Small helper class to make creating Stores from Array data easier.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SimpleStore",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Defines the default sorting (casting?) comparison functions used when sorting data.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "SortTypes",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "The Store class encapsulates a client side cache of {@link Roo.data.Record} objects which provide input data\nfor widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.<br>\n<p>\nA Store object uses an implementation of {@link Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object\nhas no knowledge of the format of the data returned by the Proxy.<br>\n<p>\nA Store object uses its configured implementation of {@link Roo.data.DataReader} to create {@link Roo.data.Record}\ninstances from the data object. These records are cached and made available through accessor functions.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A config object containing the objects needed for the Store to access data,\nand read the data into Records.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Represents a tree data structure and bubbles all the events for its nodes. The nodes\nin the tree have most standard DOM functionality.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Tree",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "root",
+ "type" : "Node",
+ "desc" : "(optional) The root node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Data reader class to create an Array of {@link Roo.data.Record} objects from an XML document\nbased on mappings in a provided Roo.data.Record constructor.<br><br>\n<p>\n<em>Note that in order for the browser to parse a returned XML document, the Content-Type\nheader in the HTTP response must be set to \"text/xml\".</em>\n<p>\nExample code:\n<pre><code>\nvar RecordDef = Roo.data.Record.create([\n {name: 'name', mapping: 'name'}, // \"mapping\" property not needed if it's the same as \"name\"\n {name: 'occupation'} // This field will use \"occupation\" as the mapping.\n]);\nvar myReader = new Roo.data.XmlReader({\n totalRecords: \"results\", // The element which contains the total dataset size (optional)\n record: \"row\", // The repeated element which contains row information\n id: \"id\" // The element within the row that provides an ID for the record (optional)\n}, RecordDef);\n</code></pre>\n<p>\nThis would consume an XML file like this:\n<pre><code>\n<?xml?>\n<dataset>\n <results>2</results>\n <row>\n <id>1</id>\n <name>Bill</name>\n <occupation>Gardener</occupation>\n </row>\n <row>\n <id>2</id>\n <name>Ben</name>\n <occupation>Horticulturalist</occupation>\n </row>\n</dataset>\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "XmlReader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "Metadata configuration options",
+ "isOptional" : false
+ },
+ {
+ "name" : "recordType",
+ "type" : "Mixed",
+ "desc" : "The definition of the data record type to produce. This can be either a valid\nRecord subclass created with {@link Roo.data.Record#create}, or an array of objects with which to call\nRoo.data.Record.create. See the {@link Roo.data.Record} class for more details.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "id",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.data",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A DragDrop implementation where the linked element follows the\nmouse cursor during a drag.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DD",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related DragDrop items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "an object containing configurable attributes\n Valid properties for DD:\n scroll",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A DragDrop implementation that inserts an empty, bordered div into\nthe document that follows the cursor during drag operations. At the time of\nthe click, the frame div is resized to the dimensions of the linked html\nelement, and moved to the exact location of the linked element.\n\nReferences to the \"frame\" element refer to the single proxy element that\nwas created to be dragged in place of all DDProxy elements on the\npage.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DDProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "the id of the linked html element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related DragDrop objects",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "an object containing configurable attributes\n Valid properties for DDProxy in addition to those in DragDrop:\n resizeFrame, centerFrame, dragElId",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A DragDrop implementation that does not move, but can be a drop\ntarget. You would get the same result by simply omitting implementation\nfor the event callbacks, but this way we reduce the processing cost of the\nevent listener and the callbacks.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DDTarget",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "the id of the element that is a drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related DragDrop objects",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "an object containing configurable attributes\n Valid properties for DDTarget in addition to those in\n DragDrop:\n none",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Defines the interface and base operation of items that that can be\ndragged or can be drop targets. It was designed to be extended, overriding\nthe event handlers for startDrag, onDrag, onDragOver and onDragOut.\nUp to three html elements can be associated with a DragDrop instance:\n<ul>\n<li>linked element: the element that is passed into the constructor.\nThis is the element which defines the boundaries for interaction with\nother DragDrop objects.</li>\n<li>handle element(s): The drag operation only occurs if the element that\nwas clicked matches a handle element. By default this is the linked\nelement, but there are times that you will want only a portion of the\nlinked element to initiate the drag operation, and the setHandleElId()\nmethod provides a way to define this.</li>\n<li>drag element: this represents the element that would be moved along\nwith the cursor during a drag operation. By default, this is the linked\nelement itself as in {@link Roo.dd.DD}. setDragElId() lets you define\na separate element that would be moved, as in {@link Roo.dd.DDProxy}.\n</li>\n</ul>\nThis class should not be instantiated until the onload event to ensure that\nthe associated elements are available.\nThe following would define a DragDrop obj that would interact with any\nother DragDrop obj in the \"group1\" group:\n<pre>\n dd = new Roo.dd.DragDrop(\"div1\", \"group1\");\n</pre>\nSince none of the event handlers have been implemented, nothing would\nactually happen if you were to run the code above. Normally you would\noverride this class or one of the default implementations, but you can\nalso override the methods you want on an instance of the class...\n<pre>\n dd.onDragDrop = function(e, id) {\n alert(\"dd was dropped on \" + id);\n }\n</pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DragDrop",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "of the element that is linked to this instance",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related DragDrop objects",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "an object containing configurable attributes\n Valid properties for DragDrop:\n padding, isTarget, maintainOffset, primaryButtonOnly",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "DragDropMgr is a singleton that tracks the element interaction for\nall DragDrop items in the window. Generally, you will not call\nthis class directly, but it does have helper methods that could\nbe useful in your DragDrop implementations.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DragDropMgr",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A simple class that provides the basic implementation needed to make any element draggable.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DragSource",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container element",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class provides a container DD instance that proxies for multiple child node sources.<br />\nBy default, this class requires that draggable child nodes are registered with {@link Roo.dd.Registry}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DragZone",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container element",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A simple class that provides the basic implementation needed to make any element a drop target that can have\ndraggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DropTarget",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container element",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class provides a container DD instance that proxies for multiple child node targets.<br />\nBy default, this class requires that child nodes accepting drop are registered with {@link Roo.dd.Registry}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DropZone",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container element",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either\ndirectly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Registry",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Provides automatic scrolling of overflow regions in the page during drag operations.<br><br>\n<b>Note: This class uses \"Point Mode\" and is untested in \"Intersect Mode\".</b>",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ScrollManager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A specialized drag proxy that supports a drop status icon, {@link Roo.Layer} styles and auto-repair. This is the\ndefault drag proxy used by all Roo.dd components.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "StatusProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "dropNotAllowed",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.dd",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Internal Class used to handle form actions",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Action",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "Roo.form.BasicForm",
+ "desc" : "The form element or its id",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Supplies the functionality to do \"actions\" on forms and initialize Roo.form.Field types on existing markup.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BasicForm",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The form element or its id",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Checkbox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "Creates a column container for layout and rendering of fields in an {@link Roo.form.Form}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Column",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "A combobox control with support for autocomplete, remote-loading, paging and many other features.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "A selected item in the list\n Fred [x] Brian [x] [Pick another |v]",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A facebook style adder... for lists of email / people / countries etc...\npick multiple items from a combo box, and shows each one.\n\n Fred [x] Brian [x] [Pick another |v]\n\n\n For this to work: it needs various extra information\n - normal combo problay has\n name, hiddenName\n + displayField, valueField\n\n For our purpose...\n\n\n If we change from 'extends' to wrapping...",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ComboBoxArray",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "hideMode",
],
"desc" : "A combobox for multiple select items.\n\nFIXME - could do with a reset button..",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ComboCheck",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DateField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "A Day picker show [M] [T] [W] ....",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DayPicker",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "A generic Field to display non-editable data.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DisplayField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "Wrapper around the FCKEditor http://www.fckeditor.net",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "FCKeditor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "hideMode",
],
"desc" : "Base class for form fields that provides default event handling, sizing, value handling and other functionality.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "Creates a fieldset container for layout and rendering of fields in an {@link Roo.form.Form}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "FieldSet",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Form",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "Embed a grid (or editable grid into a form)\nSTATUS ALPHA\n\nThis embeds a grid in a form, the value of the field should be the json encoded array of rows\nit needs \nxgrid.store = Roo.data.Store\nxgrid.store.proxy = Roo.data.MemoryProxy (data = [] )\nxgrid.store.reader = Roo.data.JsonReader",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "GridField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "Simple Hidden element used on forms \n\nusage: form.add(new Roo.form.HiddenField({ 'name' : 'test1' }));",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Hidden",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "hideMode",
],
"desc" : "Context Toolbar\n\nUsage:\n\n new Roo.form.HtmlEditor({\n ....\n toolbars : [\n { xtype: 'ToolbarStandard', styles : {} }\n { xtype: 'ToolbarContext', disable : {} }\n ]\n})",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ToolbarContext",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "disable",
],
"desc" : "Basic Toolbar\n\nUsage:\n\n new Roo.form.HtmlEditor({\n ....\n toolbars : [\n new Roo.form.HtmlEditorToolbar1({\n disable : { fonts: 1 , format: 1, ..., ... , ...],\n btns : [ .... ]\n })\n }",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ToolbarStandard",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "createLinkText",
],
"desc" : "Provides a lightweight HTML Editor component.\n\nThis has been tested on Fireforx / Chrome.. IE may not be so great..\n\n<br><br><b>Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT\nsupported by this editor.</b><br/><br/>\nAn Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within\nany element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "HtmlEditor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "whitelist",
],
"desc" : "Creates a container for layout and rendering of fields in an {@link Roo.form.Form}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Layout",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MonthField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "Numeric text field that provides automatic keystroke filtering and numeric validation.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "NumberField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "hideMode",
],
"desc" : "Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type.\nRadio grouping is handled automatically by the browser if you give each radio in a group the same name.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Radio",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "Creates a row container for layout and rendering of fields in an {@link Roo.form.Form}.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Row",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "labelAlign",
],
"desc" : "A combobox control with support for autocomplete, remote-loading, paging and many other features.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Select",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "Signature field.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Signature",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "inputType",
],
"desc" : "Multiline text field. Can be used as a direct replacement for traditional textarea fields, plus adds\nsupport for auto-sizing.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TextArea",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "hideMode",
],
"desc" : "Basic text field. Can be used as a direct replacement for traditional text inputs, or as the base\nclass for more sophisticated input controls (like {@link Roo.form.TextArea} and {@link Roo.form.ComboBox}).",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "hideMode",
],
"desc" : "Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).\nThe trigger has no default action, so you must assign a function to implement the trigger click handler by\noverriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox\nfor which you can provide a custom implementation. For example:\n<pre><code>\nvar trigger = new Roo.form.TriggerField();\ntrigger.onTriggerClick = myTriggerFn;\ntrigger.applyTo('my-field');\n</code></pre>\n\nHowever, in general you will most likely want to use TriggerField as the base class for a reusable component.\n{@link Roo.form.DateField} and {@link Roo.form.ComboBox} are perfect examples of this.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TriggerField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options (valid {@Roo.form.TextField} config options will also be applied\nto the base TextField)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "triggerClass",
],
"desc" : "Overridable validation definitions. The validations provided are basic and intended to be easily customizable and extended.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "VTypes",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.form",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.grid.AbstractGridView",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Abstract base class for grid SelectionModels. It provides the interface that should be\nimplemented by descendant classes. This class should not be directly instantiated.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "AbstractSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class extends the Grid to provide a calendar widget\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.Calendar(\"my-container-id\", {\n ds: myDataStore,\n cm: myColModel,\n selModel: mySelectionModel,\n autoSizeColumns: true,\n monitorWindowResize: false,\n trackMouseOver: true\n eventstore : real data store..\n });\n // set any options\n grid.render();",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Calendar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element into which this grid will be rendered -\nThe container MUST have some type of size defined for the grid to fill. The container will be\nautomatically set to position relative if it isn't already.",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A config object that sets properties on this grid.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "eventStore",
],
"desc" : "This class provides the basic implementation for cell selection in a grid.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CellSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The object containing the configuration of this model.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"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" : true,
+ "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",
],
"desc" : "Class for creating and editable grid.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "EditorGrid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element into which this grid will be rendered - \nThe container MUST have some type of size defined for the grid to fill. The container will be \nautomatically set to position relative if it isn't already.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dataSource",
+ "type" : "Object",
+ "desc" : "The data model to bind to",
+ "isOptional" : false
+ },
+ {
+ "name" : "colModel",
+ "type" : "Object",
+ "desc" : "The column model with info about this grid's columns",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "This class represents the primary interface of a component based grid control.\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.Grid(\"my-container-id\", {\n ds: myDataStore,\n cm: myColModel,\n selModel: mySelectionModel,\n autoSizeColumns: true,\n monitorWindowResize: false,\n trackMouseOver: true\n });\n // set any options\n grid.render();\n</code></pre>\n<b>Common Problems:</b><br/>\n- Grid does not resize properly when going smaller: Setting overflow hidden on the container\nelement will correct this<br/>\n- If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element\ndimensions. The grid adapts to your container's size, if your container has no size defined then the results\nare unpredictable.<br/>\n- Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the\ngrid to calculate dimensions/offsets.<br/>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element into which this grid will be rendered -\nThe container MUST have some type of size defined for the grid to fill. The container will be\nautomatically set to position relative if it isn't already.",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A config object that sets properties on this grid.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "autoSizeColumns",
],
"desc" : "Class for creating and editable grid elements.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "GridEditor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "any settings (must include field)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "GridView",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"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" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "PropertyGrid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element into which this grid will be rendered -\nThe container MUST have some type of size defined for the grid to fill. The container will be\nautomatically set to position relative if it isn't already.",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A config object that sets properties on this grid.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "The default SelectionModel used by {@link Roo.grid.Grid}.\nIt supports multiple selections and keyboard selection/navigation.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "RowSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Roo core utilities and functions.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Roo",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "removeMask",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Ajax",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Dom utils (from YIU afaik)",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Dom",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.lib",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu.\nIt provides basic rendering, activation management and enable/disable logic required to work in menus.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Adapter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "The base class for all items that render into menus. BaseItem provides default rendering, activated state\nmanagement and base configuration options shared by all menu components.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Adds a menu item that contains a checkbox by default, but can also be part of a radio group.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CheckItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A menu item that wraps the {@link Roo.ColorPalette} component.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ColorItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A menu containing a {@link Roo.menu.ColorItem} component (which provides a basic color picker).",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ColorMenu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A menu item that wraps the {@link Roo.DatPicker} component.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DateItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A menu containing a {@link Roo.menu.DateItem} component (which provides a date picker).",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DateMenu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A base class for all menu items that require menu-related functionality (like sub-menus) and are not static\ndisplay items. Item extends the base functionality of {@link Roo.menu.BaseItem} by adding menu-specific\nactivation and click handling.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class\nwhen you want a specialzed menu based off of another component (like {@link Roo.menu.DateMenu} for example).",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Provides a common registry of all menu items on a page so that they can be easily accessed by id.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MenuMgr",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will\nadd one of these by using \"-\" in you call to add() or in your items config rather than creating one directly.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Separator",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Adds a static text string to a menu, usually used as either a heading or group separator.\nNote: old style constructor with text is still supported.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TextItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Configuration",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "The default Provider implementation which saves state via cookies.\n<br />Usage:\n <pre><code>\n var cp = new Roo.state.CookieProvider({\n path: \"/cgi-bin/\",\n expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days\n domain: \"roojs.com\"\n })\n Roo.state.Manager.setProvider(cp);\n </code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CookieProvider",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The configuration object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "path",
],
"desc" : "This is the global state manager. By default all components that are \"state aware\" check this class\nfor state information if you don't pass them a custom state provider. In order for this class\nto be useful, it must be initialized with a provider when your application initializes.\n <pre><code>\n// in your initialization function\ninit : function(){\n Roo.state.Manager.setProvider(new Roo.state.CookieProvider());\n ...\n // supposed you have a {@link Roo.BorderLayout}\n var layout = new Roo.BorderLayout(...);\n layout.restoreState();\n // or a {Roo.BasicDialog}\n var dialog = new Roo.BasicDialog(...);\n dialog.restoreState();\n </code></pre>",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Manager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Abstract base class for state provider implementations. This class provides methods\nfor encoding and decoding <b>typed</b> variables including dates and defines the \nProvider interface.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Provider",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.state",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "AsyncTreeNode",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "attributes",
+ "type" : "Object/String",
+ "desc" : "The attributes/config for the node or just a string with the text for the node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ColumnTree",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container element",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "columns",
],
"desc" : "The default single selection for a TreePanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DefaultSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Configuration",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Multi selection for a TreePanel.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MultiSelectionModel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Configuration",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Provides editor functionality for inline tree node editing. Any valid {@link Roo.form.Field} can be used\nas the editor field.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreeEditor",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "(used to be the tree panel.)",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldconfig",
+ "type" : "Object",
+ "desc" : "DEPRECIATED Either a prebuilt {@link Roo.form.Field} instance or a Field config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreeFilter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "tree",
+ "type" : "TreePanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A TreeLoader provides for lazy loading of an {@link Roo.tree.TreeNode}'s child\nnodes from a specified URL. The response must be a javascript Array definition\nwho's elements are node definition objects. eg:\n<pre><code>\n{ success : true,\n data : [\n \n { 'id': 1, 'text': 'A folder Node', 'leaf': false },\n { 'id': 2, 'text': 'A leaf Node', 'leaf': true }\n ]\n}\n\n\n</code></pre>\n<br><br>\nThe old style respose with just an array is still supported, but not recommended.\n<br><br>\n\nA server request is sent, and child nodes are loaded only when a node is expanded.\nThe loading node's id is passed to the server under the parameter name \"node\" to\nenable the server to produce the correct child nodes.\n<br><br>\nTo pass extra parameters, an event handler may be attached to the \"beforeload\"\nevent, and the parameters specified in the TreeLoader's baseParams property:\n<pre><code>\n myTreeLoader.on(\"beforeload\", function(treeLoader, node) {\n this.baseParams.category = node.attributes.category;\n }, this);\n</code></pre><\nThis would pass an HTTP parameter called \"category\" to the server containing\nthe value of the Node's \"category\" attribute.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreeLoader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A config object containing config properties.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "is to use the cls or iconCls attributes and add the icon via a CSS background image.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreeNode",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "attributes",
+ "type" : "Object/String",
+ "desc" : "The attributes/config for the node or just a string with the text for the node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "The TreeNode UI implementation is separate from the\ntree implementation. Unless you are customizing the tree UI,\nyou should never have to use this directly.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreeNodeUI",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Object",
+ "desc" : "The node to render",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreePanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The container element",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "editor",
],
"desc" : "Provides sorting of nodes in a TreePanel",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TreeSorter",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "tree",
+ "type" : "TreePanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "folderSort",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.tree",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Utility class for manipulating CSS rules",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "CSS",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A wrapper class which can be applied to any element. Fires a \"click\" event while the\nmouse is pressed. The interval between firings may be specified in the config but\ndefaults to 10 milliseconds.\n\nOptionally, a CSS class may be applied to the element during the time it is pressed.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "ClickRepeater",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to listen on",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "stopDefault",
],
"desc" : "Provides a convenient method of performing setTimeout where a new\ntimeout cancels the old timeout. An example would be performing validation on a keypress.\nYou can use this class to buffer\nthe keypress events for a certain number of milliseconds, and perform only if they stop\nfor that amount of time.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "DelayedTask",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The default function to timeout",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The default scope of that timeout",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The default Array of arguments",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Reusable data formatting functions",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Format",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Modified version of Douglas Crockford\"s json.js that doesn\"t\nmess with the Object prototype \nhttp://www.json.org/js.html",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "JSON",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "A Collection class that maintains both numeric indexes and keys and exposes events.",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "allowFunctions",
+ "type" : "Boolean",
+ "desc" : "True if the addAll function should add function references to the\ncollection (defaults to false)",
+ "isOptional" : false
+ },
+ {
+ "name" : "keyFn",
+ "type" : "Function",
+ "desc" : "A function that can accept an item of the type(s) stored in this MixedCollection\nand return the key value for that item. This is used when available to look up the key on items that\nwere passed without an explicit key parameter to a MixedCollection method. Passing this parameter is\nequivalent to providing an implementation for the {@link #getKey} method.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "Base class that provides a common interface for publishing events. Subclasses are expected to\nto have a property \"events\" with all the events defined.<br>\nFor example:\n<pre><code>\n Employee = function(name){\n this.name = name;\n this.addEvents({\n \"fired\" : true,\n \"quit\" : true\n });\n }\n Roo.extend(Employee, Roo.util.Observable);\n</code></pre>",
"isSingleton" : false,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "properties to use (incuding events / listeners)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
"config" : [
{
"name" : "listeners",
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.util.TextMetrics.Instance",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "Provides precise pixel measurements for blocks of text so that you can determine exactly how high and\nwide, in pixels, a given block of text will be.",
"isSingleton" : true,
- "isStatic" : true,
+ "isStatic" : false,
"isBuiltin" : false,
+ "memberOf" : "TextMetrics",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "Roo.util",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : true,
+ "memberOf" : "String",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : true,
+ "memberOf" : "_global_",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
],
"desc" : "",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "memberOf" : "this",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ],
"config" : [
],
"methods" : [
projects / roojs1 / commitdiff