"Roo.LayoutManager",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
"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" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "ReaderLayout",
"example" : "",
"deprecated" : "",
}
],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
+ {
+ "name" : "center",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "memberOf" : "Roo.BorderLayout"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "optvals" : []
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "east",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "memberOf" : "Roo.BorderLayout"
+ },
+ {
+ "name" : "west",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "memberOf" : "Roo.BorderLayout"
+ },
+ {
+ "name" : "north",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "memberOf" : "Roo.BorderLayout"
+ },
+ {
+ "name" : "south",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "memberOf" : "Roo.BorderLayout"
}
],
"methods" : [
{
"name" : "create",
+ "type" : "function",
"desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n<pre><code>\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n north: {\n initialSize: 25,\n titlebar: false,\n panels: [new CP(\"north\", \"North\")]\n },\n west: {\n split:true,\n initialSize: 200,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"west\", {title: \"West\"})]\n },\n east: {\n split:true,\n initialSize: 202,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n },\n south: {\n split:true,\n initialSize: 100,\n minSize: 100,\n maxSize: 200,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"south\", {title: \"South\", closable: true})]\n },\n center: {\n titlebar: true,\n autoScroll:true,\n resizeTabs: true,\n minTabWidth: 50,\n preferredTabWidth: 150,\n panels: [\n new CP(\"center1\", {title: \"Close Me\", closable: true}),\n new CP(\"center2\", {title: \"Center Panel\", closable: false})\n ]\n }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n</code></pre>",
+ "sig" : "(config, targetEl)",
+ "static" : true,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "config",
},
{
"name" : "restoreState",
+ "type" : "function",
"desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.",
+ "sig" : "(provider)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "provider",
},
{
"name" : "addRegion",
+ "type" : "function",
"desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "target",
},
{
"name" : "showPanel",
+ "type" : "function",
"desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panelId",
},
{
"name" : "batchAdd",
+ "type" : "function",
"desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n<pre><code>\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n west: {\n split:true,\n minSize: 175,\n titlebar: true\n },\n center: {\n title:'Components'\n }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n west: {\n id: 'source-files',\n autoCreate:true,\n title:'Ext Source Files',\n autoScroll:true,\n fitToFrame:true\n },\n center : {\n el: cview,\n autoScroll:true,\n fitToFrame:true,\n toolbar: tb,\n resizeEl:'cbody'\n }\n});\n</code></pre>",
+ "sig" : "(regions)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "regions",
},
{
"name" : "remove",
+ "type" : "function",
"desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "target",
},
{
"name" : "findPanel",
+ "type" : "function",
"desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panelId",
},
{
"name" : "layout",
+ "type" : "function",
"desc" : "Performs a layout update.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "addxtype",
+ "type" : "function",
"desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "cfg",
},
{
"name" : "add",
+ "type" : "function",
"desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "Roo.BorderLayout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.BorderLayout",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "target",
},
{
"name" : "getRegion",
+ "type" : "function",
"desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutManager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "target",
},
{
"name" : "beginUpdate",
+ "type" : "function",
"desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.LayoutManager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "isUpdating",
+ "type" : "function",
"desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.LayoutManager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "getViewSize",
+ "type" : "function",
"desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.LayoutManager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "endUpdate",
+ "type" : "function",
"desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutManager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "noLayout",
},
{
"name" : "getEl",
+ "type" : "function",
"desc" : "Returns the Element this layout is bound to.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.LayoutManager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"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" : "",
+ "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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
"events" : [
{
"name" : "layout",
+ "type" : "function",
"desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
},
{
"name" : "regionexpanded",
+ "type" : "function",
"desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
},
{
"name" : "regionresized",
+ "type" : "function",
"desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
"memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
},
{
"name" : "regioncollapsed",
+ "type" : "function",
"desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "Roo.LayoutManager",
"example" : "",
"deprecated" : "",
projects / roojs1 / blobdiff