"Roo.bootstrap.layout.Basic",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "This class represents a region in a layout manager.",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "Region",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "cmargins",
"type" : "Object",
"desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "alwaysShowTabs",
"type" : "Boolean",
"desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "overflow",
"type" : "String",
"desc" : "e) if you have menus in the region, then you need to set this to visible.",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : [
- "hidden",
- "visible"
- ]
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"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" : "margins",
"type" : "Object",
"desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "preferredTabWidth",
"type" : "Number",
"desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "disableTabTips",
"type" : "Boolean",
"desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "skipConfig",
"type" : "bool",
"desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "region",
"type" : "string",
"desc" : "the region that it inhabits..",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "hideWhenEmpty",
"type" : "Boolean",
"desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "mgr",
"type" : "Roo.bootstrap.layout.Manager",
"desc" : "The manager",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "cls",
"type" : "string",
"desc" : "Extra CSS classes to add to region",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "hideTabs",
"type" : "Boolean",
"desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "resizeTabs",
"type" : "Boolean",
"desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "tabPosition",
"type" : "String",
"desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : [
- "top",
- "bottom"
- ]
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "width",
"type" : "Number",
"desc" : "For East/West panels",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "minTabWidth",
"type" : "Number",
"desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "split",
"type" : "Boolean",
"desc" : "To show the splitter",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "titlebar",
"type" : "Boolean",
"desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "preservePanels",
"type" : "Boolean",
"desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "closeOnTab",
"type" : "Boolean",
"desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "height",
"type" : "Number",
"desc" : "For North/South panels",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "autoHide",
"type" : "Boolean",
"desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.bootstrap.layout.Region",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.layout.Region"
}
],
"methods" : [
{
"name" : "unhidePanel",
+ "type" : "function",
"desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panel",
},
{
"name" : "showPanel",
+ "type" : "function",
"desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panelId",
},
{
"name" : "add",
+ "type" : "function",
"desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panel",
},
{
"name" : "animateCollapse",
+ "type" : "function",
"desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "skipAnim",
},
{
"name" : "animateExpand",
+ "type" : "function",
"desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "e",
},
{
"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.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panel",
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Hides this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Shows this region if it was previously hidden.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getBox",
+ "type" : "function",
"desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "title",
},
{
"name" : "hidePanel",
+ "type" : "function",
"desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panel",
},
{
"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.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"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.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "getTabs",
+ "type" : "function",
"desc" : "Returns the TabPanel component used by this region",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"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.bootstrap.layout.Region",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "getPanel",
+ "type" : "function",
"desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panel",
},
{
"name" : "hasPanel",
+ "type" : "function",
"desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "panel",
},
{
"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" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "newSize",
},
{
"name" : "getPosition",
+ "type" : "function",
"desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
"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",
projects / roojs1 / blobdiff