major doc changes

[roojs1] / docs / symbols / Roo.BasicLayoutRegion.json

diff --git a/docs/symbols/Roo.BasicLayoutRegion.json b/docs/symbols/Roo.BasicLayoutRegion.json
index 40fd7fb..ec54534 100644 (file)
--- a/docs/symbols/Roo.BasicLayoutRegion.json
+++ b/docs/symbols/Roo.BasicLayoutRegion.json
@@ -3,10 +3,23 @@
   "augments" : [
     "Roo.util.Observable"
   ],
+  "childClasses" : {
+    "Roo.LayoutRegion" : [
+      "Roo.SplitLayoutRegion",
+      "Roo.bootstrap.layout.Split"
+    ],
+    "Roo.BasicLayoutRegion" : [
+      "Roo.LayoutRegion"
+    ]
+  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "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" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
   "memberOf" : "BasicLayoutRegion",
   "example" : "",
   "deprecated" : "",
@@ -14,27 +27,33 @@
   "see" : "",
   "params" : [],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [
     {
       "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"
     }
   ],
   "methods" : [
     {
       "name" : "isVisible",
+      "type" : "function",
       "desc" : "Returns true if this region is currently visible.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -46,15 +65,20 @@
     },
     {
       "name" : "getEl",
+      "type" : "function",
       "desc" : "Returns the container element for this region.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -66,15 +90,20 @@
     },
     {
       "name" : "hasPanel",
+      "type" : "function",
       "desc" : "Returns true if the panel is in this region.",
+      "sig" : "(panel)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "panel",
@@ -93,15 +122,20 @@
     },
     {
       "name" : "getActivePanel",
+      "type" : "function",
       "desc" : "Get the active panel for this region.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -113,15 +147,20 @@
     },
     {
       "name" : "resizeTo",
+      "type" : "function",
       "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+      "sig" : "(newSize)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "newSize",
@@ -134,15 +173,20 @@
     },
     {
       "name" : "showPanel",
+      "type" : "function",
       "desc" : "Show the specified panel.",
+      "sig" : "(panelId)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "panelId",
@@ -161,15 +205,20 @@
     },
     {
       "name" : "getPosition",
+      "type" : "function",
       "desc" : "Returns this regions position (north/south/east/west/center).",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -181,15 +230,20 @@
     },
     {
       "name" : "add",
+      "type" : "function",
       "desc" : "Add the passed ContentPanel(s)",
+      "sig" : "(panel)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "panel",
@@ -208,15 +262,20 @@
     },
     {
       "name" : "remove",
+      "type" : "function",
       "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+      "sig" : "(panel, preservePanel)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "panel",
@@ -241,15 +300,20 @@
     },
     {
       "name" : "getPanel",
+      "type" : "function",
       "desc" : "Returns the panel specified or null if it's not in this region.",
+      "sig" : "(panel)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.BasicLayoutRegion",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "panel",
@@ -268,29 +332,39 @@
     },
     {
       "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",
@@ -321,15 +395,20 @@
     },
     {
       "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",
@@ -354,15 +433,20 @@
     },
     {
       "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",
@@ -375,15 +459,20 @@
     },
     {
       "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",
@@ -396,15 +485,20 @@
     },
     {
       "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",
@@ -429,15 +523,20 @@
     },
     {
       "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",
@@ -462,15 +561,20 @@
     },
     {
       "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",
@@ -489,15 +593,20 @@
     },
     {
       "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",
@@ -522,15 +631,20 @@
     },
     {
       "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",
@@ -563,8 +677,10 @@
   "events" : [
     {
       "name" : "paneladded",
+      "type" : "function",
       "desc" : "Fires when a panel is added.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self, panel)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -587,8 +703,10 @@
     },
     {
       "name" : "invalidated",
+      "type" : "function",
       "desc" : "Fires when the layout for this region is changed.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -605,8 +723,10 @@
     },
     {
       "name" : "expanded",
+      "type" : "function",
       "desc" : "Fires when this region is expanded.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -623,8 +743,10 @@
     },
     {
       "name" : "beforeremove",
+      "type" : "function",
       "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self, panel, e)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -653,8 +775,10 @@
     },
     {
       "name" : "collapsed",
+      "type" : "function",
       "desc" : "Fires when this region is collapsed.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -671,8 +795,10 @@
     },
     {
       "name" : "panelremoved",
+      "type" : "function",
       "desc" : "Fires when a panel is removed.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self, panel)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -695,8 +821,10 @@
     },
     {
       "name" : "beforecollapse",
+      "type" : "function",
       "desc" : "Fires when this region before collapse.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -713,8 +841,10 @@
     },
     {
       "name" : "slidehide",
+      "type" : "function",
       "desc" : "Fires when this region slides out of view.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -731,8 +861,10 @@
     },
     {
       "name" : "visibilitychange",
+      "type" : "function",
       "desc" : "Fires when this region is shown or hidden",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self, visibility)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -755,8 +887,10 @@
     },
     {
       "name" : "slideshow",
+      "type" : "function",
       "desc" : "Fires when this region is slid into view.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -773,8 +907,10 @@
     },
     {
       "name" : "panelactivated",
+      "type" : "function",
       "desc" : "Fires when a panel is activated.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self, panel)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",
@@ -797,8 +933,10 @@
     },
     {
       "name" : "resized",
+      "type" : "function",
       "desc" : "Fires when the user resizes this region.",
-      "memberOf" : "Roo.BasicLayoutRegion",
+      "sig" : "function (_self, newSize)\n{\n\n}",
+      "memberOf" : "",
       "example" : "",
       "deprecated" : "",
       "since" : "",