"Roo.ContentPanel",
"Roo.util.Observable"
],
- "desc" : "Create a new TreePanel. - defaults to fit/scoll contents.",
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
+ "desc" : "Treepanel component",
"isSingleton" : false,
- "isStatic" : false,
+ "isStatic" : true,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "TreePanel",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ],
+ "returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "values" : [
- ]
+ "memberOf" : "Roo.util.Observable"
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "toolbar",
- "type" : "Toolbar",
+ "type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "region",
"type" : "String",
- "desc" : "which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- "(center",
- "north",
- "south",
- "east",
- "west)"
- ]
+ "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "popup menu",
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "Extra style to add to the content panel",
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
+ "type" : "Boolean|Object",
"desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "params",
- "type" : "String/Object",
+ "type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
- },
- {
- "name" : "tree",
- "type" : "Roo.tree.TreePanel",
- "desc" : "The tree TreePanel, with config etc.",
- "memberOf" : "Roo",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "adjustments",
"type" : "Array",
"desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
+ "type" : "String|HTMLElement|Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.ContentPanel",
- "values" : [
- ]
+ "memberOf" : "Roo.ContentPanel"
}
],
"methods" : [
{
"name" : "load",
+ "type" : "function",
"desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "url",
},
{
"name" : "getUpdateManager",
+ "type" : "function",
"desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "isClosable",
+ "type" : "function",
"desc" : "Returns true is this panel was configured to be closable",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Destroys this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "getEl",
+ "type" : "function",
"desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "setContent",
+ "type" : "function",
"desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "content",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "getId",
+ "type" : "function",
"desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "addxtype",
+ "type" : "function",
"desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "cfg",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "refresh",
+ "type" : "function",
"desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "getTitle",
+ "type" : "function",
"desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "setTitle",
+ "type" : "function",
"desc" : "Set this panel's title",
+ "sig" : "(title)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "title",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "getToolbar",
+ "type" : "function",
"desc" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
},
{
"name" : "setUrl",
+ "type" : "function",
"desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "url",
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
+ "type" : "function",
"desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "un",
+ "type" : "function",
"desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addEvents",
+ "type" : "function",
"desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "releaseCapture",
+ "type" : "function",
"desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
+ "type" : "function",
"desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "hasListener",
+ "type" : "function",
"desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "capture",
+ "type" : "function",
"desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addListener",
+ "type" : "function",
"desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
],
"events" : [
{
"name" : "deactivate",
+ "type" : "function",
"desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "resize",
+ "type" : "function",
"desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "activate",
+ "type" : "function",
"desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
]
}
\ No newline at end of file