major doc changes
[roojs1] / docs / symbols / Roo.bootstrap.panel.Nest.json
index 792a469..21d9af8 100644 (file)
@@ -4,22 +4,21 @@
     "Roo.bootstrap.panel.Content",
     "Roo.util.Observable"
   ],
+  "childClasses" : {  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "desc" : "Create a new Panel, that can contain a layout.Border.",
   "isSingleton" : false,
   "isStatic" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : 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",
     }
   ],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [
-    {
-      "name" : "loadOnce",
-      "type" : "Boolean",
-      "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
-    },
     {
       "name" : "listeners",
       "type" : "Object",
       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
-      "memberOf" : "Roo.util.Observable",
-      "optvals" : []
+      "memberOf" : "Roo.util.Observable"
+    },
+    {
+      "name" : "loadOnce",
+      "type" : "Boolean",
+      "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "badges",
       "type" : "Boolean",
       "desc" : "render the badges",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "autoScroll",
       "type" : "Boolean",
       "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "fitToFrame",
       "type" : "Boolean",
       "desc" : "True for this panel to adjust its size to fit when the region resizes  (defaults to false)",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "background",
       "type" : "Boolean",
       "desc" : "True if the panel should not be activated when it is added (defaults to false)",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "toolbar",
       "type" : "Toolbar",
       "desc" : "A toolbar for this panel",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "region",
       "type" : "String",
-      "desc" : "t) which region to put this panel on (when used with xtype constructors)",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : [
-        "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.bootstrap.panel.Content"
     },
     {
       "name" : "content",
       "type" : "String",
       "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "title",
       "type" : "String",
       "desc" : "The title for this panel",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "iframe",
       "type" : "Boolean",
       "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "cls",
       "type" : "String",
       "desc" : "extra classes to use",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "autoCreate",
       "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.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "fitContainer",
       "type" : "Boolean",
       "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container  (defaults to false)",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "closable",
       "type" : "Boolean",
       "desc" : "True if the panel can be closed/removed",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "params",
       "type" : "String/Object",
       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
+    },
+    {
+      "name" : "layout",
+      "type" : "Roo.BorderLayout",
+      "desc" : "The layout for this panel",
+      "memberOf" : "Roo.bootstrap.panel.Nest"
     },
     {
       "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.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "url",
       "type" : "String",
       "desc" : "Calls {@link #setUrl} with this value",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     },
     {
       "name" : "resizeEl",
       "type" : "String/HTMLElement/Element",
       "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
-      "memberOf" : "Roo.bootstrap.panel.Content",
-      "optvals" : []
+      "memberOf" : "Roo.bootstrap.panel.Content"
     }
   ],
   "methods" : [
     {
       "name" : "getLayout",
+      "type" : "function",
       "desc" : "Returns the nested BorderLayout for this panel",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Nest",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "addxtype",
+      "type" : "function",
       "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.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" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Nest",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "cfg",
     },
     {
       "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.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "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.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "getChildContainer",
+      "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.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "cfg",
     },
     {
       "name" : "getToolbar",
+      "type" : "function",
       "desc" : "Returns the toolbar for this Panel if one was configured.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "setTitle",
+      "type" : "function",
       "desc" : "Set this panel's title",
+      "sig" : "(title)",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "title",
     },
     {
       "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.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "url",
     },
     {
       "name" : "getEl",
+      "type" : "function",
       "desc" : "Returns this panel's element - used by regiosn to add.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "destroy",
+      "type" : "function",
       "desc" : "Destroys this panel",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "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}.\nDoes not work with IFRAME contents",
+      "sig" : "(url, params, callback, discardUrl)",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "url",
     },
     {
       "name" : "getTitle",
+      "type" : "function",
       "desc" : "Returns this panel's title",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "isClosable",
+      "type" : "function",
       "desc" : "Returns true is this panel was configured to be closable",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "getId",
+      "type" : "function",
       "desc" : "Returns this panel's id",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "setContent",
+      "type" : "function",
       "desc" : "Updates this panel's element (not for iframe)",
+      "sig" : "(content, loadScripts)",
+      "static" : false,
+      "memberOf" : "Roo.bootstrap.panel.Content",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "content",
     },
     {
       "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" : "activate",
+      "type" : "function",
       "desc" : "Fires when this panel is activated.",
+      "sig" : "function (_self)\n{\n\n}",
       "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
     },
     {
       "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.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
     },
     {
       "name" : "deactivate",
+      "type" : "function",
       "desc" : "Fires when this panel is activated.",
+      "sig" : "function (_self)\n{\n\n}",
       "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
     },
     {
       "name" : "render",
+      "type" : "function",
       "desc" : "Fires when this tab is created",
+      "sig" : "function (_self)\n{\n\n}",
       "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",
     },
     {
       "name" : "scroll",
+      "type" : "function",
       "desc" : "Fires when this content is scrolled",
+      "sig" : "function (_self, scrollEvent)\n{\n\n}",
       "memberOf" : "Roo.bootstrap.panel.Content",
       "example" : "",
       "deprecated" : "",