Class Ext.BasicLayoutRegion

Package:	Ext
Class:	BasicLayoutRegion
Extends:	Observable
Subclasses:	LayoutRegion
Defined In:	BasicLayoutRegion.js

此类仅仅是在区域理器中再现一个轻量级区域。该区域既不会移动 DOM 节点，也没有 titlebar、tabs 或任何其他特性。它能使用的特性仅为尺寸和位置面板。要创建一个 BasicLayoutRegion 对象，只需在创建的设置中添加 lightweight:true 或 basic:true 属性即可。

属性 - 方法 - 事件

公共属性

属性		定义对象
	panels : Ext.util.MixedCollection	BasicLayoutRegion
	该区域中 panel 对象的集合。	BasicLayoutRegion

公共方法

方法		定义对象
	add(`ContentPanel... panel`) : Ext.ContentPanel	BasicLayoutRegion
	将给出的 ContentPanel 对象添加到区域中。	BasicLayoutRegion
	addEvents(`Object object`) : void	Observable
	将区域对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为组件添加一个事件监听器。	Observable
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件并给出参数（至少要有事件名称）。	Observable
	getActivePanel() : Ext.ContentPanel	BasicLayoutRegion
	为区域取得活动的面板对象。	BasicLayoutRegion
	getEl() : Ext.Element	BasicLayoutRegion
	返回区域对象的容器元素。	BasicLayoutRegion
	getPanel(`Number/String/ContentPanel panel`) : Ext.ContentPanel	BasicLayoutRegion
	返回指定的面板对象，如果该对象不存在于该区域则返回“null”。	BasicLayoutRegion
	getPosition() : String	BasicLayoutRegion
	返回该区域的位置（有效值为：“north/south/east/west/center”）。	BasicLayoutRegion
	hasListener(`String eventName`) : Boolean	Observable
	检查对象是否拥有指定事件的监听器。。	Observable
	hasPanel(`Number/String/ContentPanel panel`) : Boolean	BasicLayoutRegion
	如果该区域中包含指定面板对象则返回“true”。	BasicLayoutRegion
	isVisible() : Boolean	BasicLayoutRegion
	如果该区域当前可见则返回“true”。	BasicLayoutRegion
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为组件添加一个事件监听器（addListener 的缩写）。	Observable
	purgeListeners() : void	Observable
	删除该对象所有的监听器。	Observable
	remove(`Number/String/ContentPanel panel`, `Boolean preservePanel`) : Ext.ContentPanel	BasicLayoutRegion
	删除指定的面板对象。	BasicLayoutRegion
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	删除一个监听器。	Observable
	resizeTo(`Number newSize`) : void	BasicLayoutRegion
	将区域对象调整为指定大小。	BasicLayoutRegion
	showPanel(`Number/String/ContentPanel panelId`) : Ext.ContentPanel	BasicLayoutRegion
	显示指定面板对象。	BasicLayoutRegion
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	删除一个监听器（removeListener 的缩写）。	Observable

公共事件

事件		定义对象
	beforeremove : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`, `Object e`)	BasicLayoutRegion
	Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.	BasicLayoutRegion
	collapsed : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region is collapsed.	BasicLayoutRegion
	expanded : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region is expanded.	BasicLayoutRegion
	invalidated : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when the layout for this region is changed.	BasicLayoutRegion
	panelactivated : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`)	BasicLayoutRegion
	Fires when a panel is activated.	BasicLayoutRegion
	paneladded : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`)	BasicLayoutRegion
	Fires when a panel is added.	BasicLayoutRegion
	panelremoved : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`)	BasicLayoutRegion
	Fires when a panel is removed.	BasicLayoutRegion
	resized : (`Ext.LayoutRegion this`, `Number newSize`)	BasicLayoutRegion
	Fires when the user resizes this region.	BasicLayoutRegion
	slidehide : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region slides out of view.	BasicLayoutRegion
	slideshow : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region is slid into view.	BasicLayoutRegion
	visibilitychange : (`Ext.LayoutRegion this`, `Boolean visibility`)	BasicLayoutRegion
	Fires when this region is shown or hidden	BasicLayoutRegion

属性详情

panels

public Ext.util.MixedCollection panels

A collection of panels in this region.

This property is defined by BasicLayoutRegion.

方法详情

add

public function add(ContentPanel... panel)

Add the passed ContentPanel(s)

参数：

panel : ContentPanel...
The ContentPanel(s) to add (you can pass more than one)

返回：

Ext.ContentPanel
The panel added (if only one was added)

This method is defined by BasicLayoutRegion.

addEvents

public function addEvents(Object object)

将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。

参数：

object : Object
The object from which to copy events

返回：

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [Object options])

为组件添加一个事件监听器

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
scope : Object
（可选）处理函数执行的作用域。处理函数 "this" 的内容。
options : Object
（可选）一个包含处理设置属性的对象。可以包含下列的属性：
- scope {Object} 处理函数执行的作用域。处理函数 "this" 的内容。
- delegate {String} 一个简单的选择器用来过滤目标或查找目标的子节点。
- stopEvent {Boolean} 值为 True 时用来中止事件。那样将中止传播，并防止缺省动作。
- preventDefault {Boolean} 值为 True 时用来防止缺省动作。
- stopPropagation {Boolean} 值为 True 时用来中止事件传播。
- normalized {Boolean} 值为 False 时向处理函数传递浏览器事件用以代替 Ext.EventObject 对象。
- delay {Number} 当事件触发后启用处理函数的延迟微秒数。
- single {Boolean} 值为 True 时将添加一个处理函数用来处理下个触发的事件，并在处理完后移除。
- buffer {Number} 使处理函数计划在由 Ext.util.DelayedTask 指定的微秒数后执行。如果事件在延迟期间再次触发，原来的处理函数将不再启动，而是由新的计划代替。
组合选项
使用选项参数可以组合不同类型的监听器：

下面是一个标准的、延迟执行的、一次性的监听器，将会自动停止事件并传递一个自定义的参数(forumId)
代码：
```
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
```
这个方法也允许传递的单个参数是一个包含多个指定处理函数的设置对象。

一次调用多个处理函数
代码：
```
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
```
或者简写为：
代码：
```
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

返回：

void

This method is defined by Observable.

fireEvent

public function fireEvent(String eventName, Object... args)

触发指定的事件并给出参数（至少要有事件名称）。

参数：

eventName : String
args : Object...
传入处理函数的参数

返回：

Boolean
如果任何处理函数返回 false 则返回值为 false, 否则返回 true。

This method is defined by Observable.

getActivePanel

public function getActivePanel()

Get the active panel for this region.

参数：

无。

返回：

Ext.ContentPanel
The active panel or null

This method is defined by BasicLayoutRegion.

getEl

public function getEl()

Returns the container element for this region.

参数：

无。

返回：

Ext.Element

This method is defined by BasicLayoutRegion.

getPanel

public function getPanel(Number/String/ContentPanel panel)

Returns the panel specified or null if it's not in this region.

参数：

panel : Number/String/ContentPanel
The panels index, id or the panel itself

返回：

Ext.ContentPanel

This method is defined by BasicLayoutRegion.

getPosition

public function getPosition()

Returns this regions position (north/south/east/west/center).

参数：

无。

返回：

String

This method is defined by BasicLayoutRegion.

hasListener

public function hasListener(String eventName)

检查该对象是否拥有指定事件的侦听器

参数：

eventName : String
查询事件之名称

返回：

Boolean
值为 True 值表示事件监听器存在, 否则值为 false。

This method is defined by Observable.

hasPanel

public function hasPanel(Number/String/ContentPanel panel)

Returns true if the panel is in this region.

参数：

panel : Number/String/ContentPanel
The panels index, id or the panel itself

返回：

Boolean

This method is defined by BasicLayoutRegion.

isVisible

public function isVisible()

Returns true if this region is currently visible.

参数：

无。

返回：

Boolean

This method is defined by BasicLayoutRegion.

on

public function on(String eventName, Function handler, [Object options])

为该组件加入事件处理器函数, addListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
options : Object
（可选）

返回：

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

从对象身上移除所有的侦听器

参数：

无。

返回：

void

This method is defined by Observable.

remove

public function remove(Number/String/ContentPanel panel, Boolean preservePanel)

Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.

参数：

panel : Number/String/ContentPanel
The panels index, id or the panel itself
preservePanel : Boolean
Overrides the config preservePanel option

返回：

Ext.ContentPanel
The panel that was removed

This method is defined by BasicLayoutRegion.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

移除侦听器

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.

resizeTo

public function resizeTo(Number newSize)

Resizes the region to the specified size. For vertical regions (west, east) this adjusts the width, for horizontal (north, south) the height.

参数：

newSize : Number
新宽度 or height

返回：

void

This method is defined by BasicLayoutRegion.

showPanel

public function showPanel(Number/String/ContentPanel panelId)

Show the specified panel.

参数：

panelId : Number/String/ContentPanel
The panels index, id or the panel itself

返回：

Ext.ContentPanel
The shown panel or null

This method is defined by BasicLayoutRegion.

un

public function un(String eventName, Function handler, [Object scope])

移除侦听器, removeListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.

事件详情

beforeremove

public event beforeremove

Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.