Roo.util.Observable
Roo.Component
Roo.bootstrap.Component
Roo.bootstrap.layout.Manager
Roo.bootstrap.layout.Border

Class Roo.bootstrap.layout.Border

Package:	Roo.bootstrap.layout
Defined In:	Roo/bootstrap/layout/Border.js.
Class:	Border
Extends:	Roo.bootstrap.layout.Manager

This class represents a common layout manager used in desktop applications. For screenshots and more details,
please see: examples/bootstrap/nested.html

The container the layout is rendered into can be either the body element or any other element.
If it is not the body element, the container needs to either be an absolute positioned element,
or you will need to add "position:relative" to the css of the container. You will also need to specify
the container size if it is not the body element.

Class Comments / Notes => [Add Your comment/notes about this class]

Config Options (Usually are also Properties)
Options		Defined By
	actionMode : String which property holds the element that used for hide() / show() / disable() / enable() default is 'el' which property holds the element that used for hide() / show() / disable() / enable() default is 'el'	Roo.Component
	allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). Whether the component can move the Dom node when rendering (defaults to true).	Roo.Component
	can_build_overlaid : Boolean True if element can be rebuild from a HTML page True if element can be rebuild from a HTML page	Roo.bootstrap.Component
	cls : String css class css class	Roo.bootstrap.Component
	container_method : string method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer) method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)	Roo.bootstrap.Component
	dataId : string cutomer id cutomer id	Roo.bootstrap.Component
	disableClass : String CSS class added to the component when it is disabled (defaults to "x-item-disabled"). CSS class added to the component when it is disabled (defaults to "x-item-disabled").	Roo.Component
	hideMode : String How this component should hidden. How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". Possible Values: display, visibility	Roo.Component
	listeners : Object list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... }`	Roo.util.Observable
	name : string Specifies name attribute Specifies name attribute	Roo.bootstrap.Component
	style : String any extra css any extra css	Roo.bootstrap.Component
	tooltip : string Text for the tooltip Text for the tooltip	Roo.bootstrap.Component
	visibilityEl : string\|object What element to use for visibility (see getVisibilityEl()) What element to use for visibility (see getVisibilityEl()) Possible Values: el, parent	Roo.bootstrap.Component
	xattr : Object extra attributes to add to 'element' (used by builder to store stuff. extra attributes to add to 'element' (used by builder to store stuff.)	Roo.bootstrap.Component

Public Methods
Method		Defined By
	new Roo.bootstrap.layout.Border (Object *config) Create a new Roo.bootstrap.layout.Border Create a new Roo.bootstrap.layout.Border Parameters: Object config* Configuration options
	add (String *target, Roo.ContentPanel panel) : Roo.ContentPanel Adds a ContentPanel (or subclass) to this layout. Adds a ContentPanel (or subclass) to this layout. Parameters: String target* The target region key (north, south, east, west or center). Roo.ContentPanel panel The panel to add Returns: Roo.ContentPanel The added panel	Roo.bootstrap.layout.Border
	addEvents (Object *object) Used to define events on this Observable Used to define events on this Observable Parameters: Object object* The object with the events defined	Roo.util.Observable
	addListener (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this component Appends an event handler to this component Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires. single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `el.on({ 'click': { fn: this.onClick, scope: this, delay: 100 }, 'mouseover': { fn: this.onMouseOver, scope: this }, 'mouseout': { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax which passes the same scope object to all handlers: `el.on({ 'click': this.onClick, 'mouseover': this.onMouseOver, 'mouseout': this.onMouseOut, scope: this });`	Roo.util.Observable
	addRegion (String *target, Object config) : BorderLayoutRegion Creates and adds a new region if it doesn't already exist. Creates and adds a new region if it doesn't already exist. Parameters: String target* The target region key (north, south, east, west or center). Object config The regions config object Returns: BorderLayoutRegion The new region	Roo.bootstrap.layout.Border
	addxtype (Object *cfg) Adds a xtype elements to the layout. Adds a xtype elements to the layout. `layout.addxtype({ xtype : 'ContentPanel', region: 'west', items: [ .... ] } ); layout.addxtype({ xtype : 'NestedLayoutPanel', region: 'west', layout: { center: { }, west: { } }, items : [ ... list of content panels or nested layout panels.. ] } );` Parameters: Object cfg* Xtype definition of item to add.	Roo.bootstrap.layout.Border
	beginUpdate () Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls	Roo.bootstrap.layout.Manager
	destroy () Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}. Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}.	Roo.Component
	disable () : Roo.Component Disable this component. Disable this component. Returns: Roo.Component this	Roo.Component
	enable () : Roo.Component Enable this component. Enable this component. Returns: Roo.Component this	Roo.Component
	endUpdate (Boolean *noLayout) Restore auto-layouts and optionally disable the manager from performing a layout Restore auto-layouts and optionally disable the manager from performing a layout Parameters: Boolean noLayout* true to disable a layout update	Roo.bootstrap.layout.Manager
	findPanel (String *panelId) : Roo.ContentPanel Searches all regions for a panel with the specified id Searches all regions for a panel with the specified id Parameters: String panelId* Returns: Roo.ContentPanel The panel or null if it wasn't found	Roo.bootstrap.layout.Border
	fireEvent (String *eventName, Object... args) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: String eventName* Object... args Variable number of parameters are passed to handlers Returns: Boolean returns false if any of the handlers return false otherwise it returns true	Roo.util.Observable
	focus (Boolean *selectText) : Roo.Component Try to focus this component. Try to focus this component. Parameters: Boolean selectText* True to also select the text in this component (if applicable) Returns: Roo.Component this	Roo.Component
	getChildContainer () : Roo.Element Fetch the element to add children to Fetch the element to add children to Returns: Roo.Element defaults to this.el	Roo.bootstrap.Component
	getEl () : Roo.Element Returns the Element this layout is bound to. Returns the Element this layout is bound to. Returns: Roo.Element	Roo.bootstrap.layout.Manager
	getId () : String Returns the id of this component. Returns the id of this component. Returns: String	Roo.Component
	getRegion (String *target) : Roo.LayoutRegion Returns the specified region. Returns the specified region. Parameters: String target* The region key ('center', 'north', 'south', 'east' or 'west') Returns: Roo.LayoutRegion	Roo.bootstrap.layout.Manager
	getViewSize () : Object Returns the size of the current view. Returns the size of the current view. This method normalizes document.body and element embedded layouts and performs box-model adjustments. Returns: Object The size as an object {width: (the width), height: (the height)}	Roo.bootstrap.layout.Manager
	getVisibilityEl () Get the element that will be used to show or hide Get the element that will be used to show or hide	Roo.bootstrap.Component
	hasListener (String *eventName) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: String eventName* The name of the event to check for Returns: Boolean True if the event is being listened for, else false	Roo.util.Observable
	hide () Hide a component - adds 'hidden' class Hide a component - adds 'hidden' class	Roo.bootstrap.Component
	initEvents () Initialize Events for the element Initialize Events for the element	Roo.bootstrap.Component
	isUpdating () : Boolean Returns true if this layout is currently being updated Returns true if this layout is currently being updated Returns: Boolean	Roo.bootstrap.layout.Manager
	isVisible () Returns true if this component is visible. Returns true if this component is visible.	Roo.Component
	layout () Performs a layout update. Performs a layout update.	Roo.bootstrap.layout.Border
	on (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional)	Roo.util.Observable
	purgeListeners () Removes all listeners for this object Removes all listeners for this object	Roo.util.Observable
	remove (String *target, Number/String/Roo.ContentPanel panel) : Roo.ContentPanel Remove a ContentPanel (or subclass) to this layout. Remove a ContentPanel (or subclass) to this layout. Parameters: String target* The target region key (north, south, east, west or center). Number/String/Roo.ContentPanel panel The index, id or panel to remove Returns: Roo.ContentPanel The removed panel	Roo.bootstrap.layout.Border
	removeListener (String *eventName, Function handler, Object scope) Removes a listener Removes a listener Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	render (String/HTMLElement/Element *container) If this is a lazy rendering component, render it to its container element. If this is a lazy rendering component, render it to its container element. Parameters: String/HTMLElement/Element container* (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.	Roo.Component
	setDisabled (Boolean *disabled) Convenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters: Boolean disabled*	Roo.Component
	setVisible (Boolean *visible) : Roo.Component Convenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters: Boolean visible* True to show, false to hide Returns: Roo.Component this	Roo.Component
	show () Show a component - removes 'hidden' class Show a component - removes 'hidden' class	Roo.bootstrap.Component
	showPanel (String/ContentPanel *panelId) : Roo.ContentPanel Searches all regions for a panel with the specified id and activates (shows) it. Searches all regions for a panel with the specified id and activates (shows) it. Parameters: String/ContentPanel panelId* The panels id or the panel itself Returns: Roo.ContentPanel The shown panel or null	Roo.bootstrap.layout.Border
	tooltipEl () : Roo.Element Fetch the element to display the tooltip on. Fetch the element to display the tooltip on. Returns: Roo.Element defaults to this.el	Roo.bootstrap.Component
	un (String *eventName, Function handler, Object scope) Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable

Events
Event		Defined By
	beforedestroy (Roo.Component *this) Fires before the component is destroyed. Fires before the component is destroyed. Return false to stop the destroy. Parameters: Roo.Component this*	Roo.Component
	beforehide (Roo.Component *this) Fires before the component is hidden. Fires before the component is hidden. Return false to stop the hide. Parameters: Roo.Component this*	Roo.Component
	beforerender (Roo.Component *this) Fires before the component is rendered. Fires before the component is rendered. Return false to stop the render. Parameters: Roo.Component this*	Roo.Component
	beforeshow (Roo.Component *this) Fires before the component is shown. Fires before the component is shown. Return false to stop the show. Parameters: Roo.Component this*	Roo.Component
	childrenrendered (Roo.bootstrap.Component *this) Fires when the children have been rendered. Fires when the children have been rendered.. Parameters: Roo.bootstrap.Component this*	Roo.bootstrap.Component
	destroy (Roo.Component *this) Fires after the component is destroyed. Fires after the component is destroyed. Parameters: Roo.Component this*	Roo.Component
	disable (Roo.Component *this) Fires after the component is disabled. Fires after the component is disabled. Parameters: Roo.Component this*	Roo.Component
	enable (Roo.Component *this) Fires after the component is enabled. Fires after the component is enabled. Parameters: Roo.Component this*	Roo.Component
	hide (Roo.Component *this) Fires after the component is hidden. Fires after the component is hidden. Parameters: Roo.Component this*	Roo.Component
	layout (Roo.LayoutManager *this) Fires when a layout is performed. Fires when a layout is performed. Parameters: Roo.LayoutManager this*	Roo.bootstrap.layout.Manager
	regioncollapsed (Roo.LayoutRegion *region) Fires when a region is collapsed. Fires when a region is collapsed. Parameters: Roo.LayoutRegion region* The collapsed region	Roo.bootstrap.layout.Manager
	regionexpanded (Roo.LayoutRegion *region) Fires when a region is expanded. Fires when a region is expanded. Parameters: Roo.LayoutRegion region* The expanded region	Roo.bootstrap.layout.Manager
	regionresized (Roo.LayoutRegion *region, Number newSize) Fires when the user resizes a region. Fires when the user resizes a region. Parameters: Roo.LayoutRegion region* The resized region Number newSize The new size (width for east/west, height for north/south)	Roo.bootstrap.layout.Manager
	render (Roo.Component *this) Fires after the component is rendered. Fires after the component is rendered. Parameters: Roo.Component this*	Roo.Component
	show (Roo.Component *this) Fires after the component is shown. Fires after the component is shown. Parameters: Roo.Component this*	Roo.Component

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT) Based on JsDoc Toolkit