打印版式

Class Ext.LayoutRegion

Package:Ext
Class:LayoutRegion
Extends:BasicLayoutRegion
Subclasses:SplitLayoutRegion
Defined In:LayoutRegion.js
This class represents a region in a layout manager.

属性   -  方法   -  事件   -  设置选项

公共属性

属性 定义对象
  bodyEl : Ext.Element LayoutRegion
This regions body element
  collapsedEl : Ext.Element LayoutRegion
This region's collapsed element
  el : Ext.Element LayoutRegion
This regions container element
  panels : Ext.util.MixedCollection BasicLayoutRegion
A collection of panels in this region.
  titleTextEl : HTMLElement LayoutRegion
This regions title text element

公共方法

方法 定义对象
  add(ContentPanel... panel) : Ext.ContentPanel LayoutRegion
Add the passed ContentPanel(s)
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  collapse([Boolean skipAnim]) : void LayoutRegion
Collapses this region.
  expand(Ext.EventObject e, [Boolean skipAnim]) : void LayoutRegion
Expand this region if it was previously collapsed.
  fireEvent(String eventName, Object... args) : Boolean Observable
触发指定的事件, 并将参数传入（至少要有事件名称）。
  getActivePanel() : Ext.ContentPanel LayoutRegion
Get the active panel for this region.
  getEl() : Ext.Element LayoutRegion
Returns the container element for this region.
  getPanel(Number/String/ContentPanel panel) : Ext.ContentPanel BasicLayoutRegion
Returns the panel specified or null if it's not in this region.
  getPosition() : String BasicLayoutRegion
Returns this regions position (north/south/east/west/center).
  getTabs() : Ext.TabPanel LayoutRegion
Returns the TabPanel component used by this region
  hasListener(String eventName) : Boolean Observable
检查该对象是否拥有指定事件的侦听器
  hasPanel(Number/String/ContentPanel panel) : Boolean BasicLayoutRegion
Returns true if the panel is in this region.
  hide() : void LayoutRegion
Hides this region.
  hidePanel(Number/String/ContentPanel panel) : void LayoutRegion
Hides the tab for the specified panel.
  isVisible() : Boolean LayoutRegion
Returns true if this region is currently visible.
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  remove(Number/String/ContentPanel panel, Boolean preservePanel) : Ext.ContentPanel LayoutRegion
Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  resizeTo(Number newSize) : void BasicLayoutRegion
Resizes the region to the specified size. For vertical regions (west, east) this adjusts the width, for horizontal (...
  setCollapsedTitle() : void LayoutRegion
Updates the collapsed text for north/south regions (used with collapsedTitle config option)
  show() : void LayoutRegion
Shows this region if it was previously hidden.
  showPanel(Number/String/ContentPanel panelId) : Ext.ContentPanel LayoutRegion
Show the specified panel.
  un(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器, removeListener 的简写方式
  unhidePanel(Number/String/ContentPanel panel) : void LayoutRegion
Unhides the tab for a previously hidden panel.

公共事件

事件 定义对象
  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.
  collapsed : (Ext.LayoutRegion this) BasicLayoutRegion
Fires when this region is collapsed.
  expanded : (Ext.LayoutRegion this) BasicLayoutRegion
Fires when this region is expanded.
  invalidated : (Ext.LayoutRegion this) BasicLayoutRegion
Fires when the layout for this region is changed.
  panelactivated : (Ext.LayoutRegion this, Ext.ContentPanel panel) BasicLayoutRegion
Fires when a panel is activated.
  paneladded : (Ext.LayoutRegion this, Ext.ContentPanel panel) BasicLayoutRegion
Fires when a panel is added.
  panelremoved : (Ext.LayoutRegion this, Ext.ContentPanel panel) BasicLayoutRegion
Fires when a panel is removed.
  resized : (Ext.LayoutRegion this, Number newSize) BasicLayoutRegion
Fires when the user resizes this region.
  slidehide : (Ext.LayoutRegion this) BasicLayoutRegion
Fires when this region slides out of view.
  slideshow : (Ext.LayoutRegion this) BasicLayoutRegion
Fires when this region is slid into view.
  visibilitychange : (Ext.LayoutRegion this, Boolean visibility) BasicLayoutRegion
Fires when this region is shown or hidden

设置选项

设置选项 定义对象
  alwaysShowTabs : Boolean LayoutRegion
True to always display tabs even when only 1 panel (defaults to false)
  animate : Boolean LayoutRegion
True to animate expand/collapse (defaults to false)
  autoHide : Boolean LayoutRegion
False to disable autoHide when the mouse leaves the "floated" region (defaults to true)
  autoScroll : Boolean LayoutRegion
True to enable overflow scrolling (defaults to false)
  closeOnTab : Boolean LayoutRegion
True to place the close icon on the tabs instead of the region titlebar (defaults to false)
  cmargins : Object LayoutRegion
Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {...
  collapsed : Boolean LayoutRegion
True to set the initial display to collapsed (defaults to false)
  collapsedTitle : String LayoutRegion
Optional string message to display in the collapsed block of a north or south region
  collapsible : Boolean LayoutRegion
False to disable collapsing (defaults to true)
  disableTabTips : Boolean LayoutRegion
True to disable tab tooltips
  floatable : Boolean LayoutRegion
False to disable floating (defaults to true)
  hidden : Boolean LayoutRegion
True to start the region hidden
  hideTabs : Boolean LayoutRegion
True to hide the tab strip (defaults to false)
  hideWhenEmpty : Boolean LayoutRegion
True to hide the region when it has no panels
  margins : Object LayoutRegion
Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})
  minTabWidth : Number LayoutRegion
The minimum tab width (defaults to 40)
  preferredTabWidth : Number LayoutRegion
The preferred tab width (defaults to 150)
  preservePanels : Boolean LayoutRegion
True to preserve removed panels so they can be readded later (defaults to false)
  resizeTabs : Boolean LayoutRegion
True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within the spa...
  showPin : Boolean LayoutRegion
True to show a pin button
  tabPosition : String LayoutRegion
"top" or "bottom" (defaults to "bottom")
  title : String LayoutRegion
The title for the region (overrides panel titles)
  titlebar : Boolean LayoutRegion
True to display a title bar (defaults to true)

属性详情

bodyEl

public Ext.Element bodyEl
This regions body element
This property is defined by LayoutRegion.

collapsedEl

public Ext.Element collapsedEl
This region's collapsed element
This property is defined by LayoutRegion.

el

public Ext.Element el
This regions container element
This property is defined by LayoutRegion.

panels

public Ext.util.MixedCollection panels
A collection of panels in this region.
This property is defined by BasicLayoutRegion.

titleTextEl

public HTMLElement titleTextEl
This regions title text element
This property is defined by LayoutRegion.

方法详情

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 LayoutRegion.

addEvents

public function addEvents(Object object)
将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。
参数：
  • object : Object
    要复制事件的源对象
返回：
  • 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.

collapse

public function collapse([Boolean skipAnim])
Collapses this region.
参数：
  • skipAnim : Boolean
    （可选） true to collapse the element without animation (if animate is true)
返回：
  • void
This method is defined by LayoutRegion.

expand

public function expand(Ext.EventObject e, [Boolean skipAnim])
Expand this region if it was previously collapsed.
参数：
  • e : Ext.EventObject
    The event that triggered the expand (or null if calling manually)
  • skipAnim : Boolean
    （可选） true to expand the element without animation (if animate is true)
返回：
  • void
This method is defined by LayoutRegion.

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 LayoutRegion.

getEl

public function getEl()
Returns the container element for this region.
参数：
  • 无。
返回：
  • Ext.Element
This method is defined by LayoutRegion.

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.

getTabs

public function getTabs()
Returns the TabPanel component used by this region
参数：
  • 无。
返回：
  • Ext.TabPanel
This method is defined by LayoutRegion.

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.

hide

public function hide()
Hides this region.
参数：
  • 无。
返回：
  • void
This method is defined by LayoutRegion.

hidePanel

public function hidePanel(Number/String/ContentPanel panel)
Hides the tab for the specified panel.
参数：
  • panel : Number/String/ContentPanel
    The panels index, id or the panel itself
返回：
  • void
This method is defined by LayoutRegion.

isVisible

public function isVisible()
Returns true if this region is currently visible.
参数：
  • 无。
返回：
  • Boolean
This method is defined by LayoutRegion.

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 LayoutRegion.

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.

setCollapsedTitle

public function setCollapsedTitle()
Updates the collapsed text for north/south regions (used with collapsedTitle config option)
参数：
  • 无。
返回：
  • void
This method is defined by LayoutRegion.

show

public function show()
Shows this region if it was previously hidden.
参数：
  • 无。
返回：
  • void
This method is defined by LayoutRegion.

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 LayoutRegion.

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.

unhidePanel

public function unhidePanel(Number/String/ContentPanel panel)
Unhides the tab for a previously hidden panel.
参数：
  • panel : Number/String/ContentPanel
    The panels index, id or the panel itself
返回：
  • void
This method is defined by LayoutRegion.

事件详情

beforeremove

public event beforeremove
Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
  • panel : Ext.ContentPanel
    The panel
  • e : Object
    The cancel event object
This event is defined by BasicLayoutRegion.

collapsed

public event collapsed
Fires when this region is collapsed.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
This event is defined by BasicLayoutRegion.

expanded

public event expanded
Fires when this region is expanded.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
This event is defined by BasicLayoutRegion.

invalidated

public event invalidated
Fires when the layout for this region is changed.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
This event is defined by BasicLayoutRegion.

panelactivated

public event panelactivated
Fires when a panel is activated.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
  • panel : Ext.ContentPanel
    The activated panel
This event is defined by BasicLayoutRegion.

paneladded

public event paneladded
Fires when a panel is added.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
  • panel : Ext.ContentPanel
    The panel
This event is defined by BasicLayoutRegion.

panelremoved

public event panelremoved
Fires when a panel is removed.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
  • panel : Ext.ContentPanel
    The panel
This event is defined by BasicLayoutRegion.

resized

public event resized
Fires when the user resizes this region.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
  • newSize : Number
    The new size (width for east/west, height for north/south)
This event is defined by BasicLayoutRegion.

slidehide

public event slidehide
Fires when this region slides out of view.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
This event is defined by BasicLayoutRegion.

slideshow

public event slideshow
Fires when this region is slid into view.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
This event is defined by BasicLayoutRegion.

visibilitychange

public event visibilitychange
Fires when this region is shown or hidden
Subscribers will be called with the following parameters:
  • this : Ext.LayoutRegion
  • visibility : Boolean
    true or false
This event is defined by BasicLayoutRegion.

设置详情

alwaysShowTabs

alwaysShowTabs : Boolean
True to always display tabs even when only 1 panel (defaults to false)
This config option is defined by LayoutRegion.

animate

animate : Boolean
True to animate expand/collapse (defaults to false)
This config option is defined by LayoutRegion.

autoHide

autoHide : Boolean
False to disable autoHide when the mouse leaves the "floated" region (defaults to true)
This config option is defined by LayoutRegion.

autoScroll

autoScroll : Boolean
True to enable overflow scrolling (defaults to false)
This config option is defined by LayoutRegion.

closeOnTab

closeOnTab : Boolean
True to place the close icon on the tabs instead of the region titlebar (defaults to false)
This config option is defined by LayoutRegion.

cmargins

cmargins : Object
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})
This config option is defined by LayoutRegion.

collapsed

collapsed : Boolean
True to set the initial display to collapsed (defaults to false)
This config option is defined by LayoutRegion.

collapsedTitle

collapsedTitle : String
Optional string message to display in the collapsed block of a north or south region
This config option is defined by LayoutRegion.

collapsible

collapsible : Boolean
False to disable collapsing (defaults to true)
This config option is defined by LayoutRegion.

disableTabTips

disableTabTips : Boolean
True to disable tab tooltips
This config option is defined by LayoutRegion.

floatable

floatable : Boolean
False to disable floating (defaults to true)
This config option is defined by LayoutRegion.

hidden

hidden : Boolean
True to start the region hidden
This config option is defined by LayoutRegion.

hideTabs

hideTabs : Boolean
True to hide the tab strip (defaults to false)
This config option is defined by LayoutRegion.

hideWhenEmpty

hideWhenEmpty : Boolean
True to hide the region when it has no panels
This config option is defined by LayoutRegion.

margins

margins : Object
Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})
This config option is defined by LayoutRegion.

minTabWidth

minTabWidth : Number
The minimum tab width (defaults to 40)
This config option is defined by LayoutRegion.

preferredTabWidth

preferredTabWidth : Number
The preferred tab width (defaults to 150)
This config option is defined by LayoutRegion.

preservePanels

preservePanels : Boolean
True to preserve removed panels so they can be readded later (defaults to false)
This config option is defined by LayoutRegion.

resizeTabs

resizeTabs : Boolean
True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within the space available, similar to FireFox 1.5 tabs (defaults to false)
This config option is defined by LayoutRegion.

showPin

showPin : Boolean
True to show a pin button
This config option is defined by LayoutRegion.

tabPosition

tabPosition : String
"top" or "bottom" (defaults to "bottom")
This config option is defined by LayoutRegion.

title

title : String
The title for the region (overrides panel titles)
This config option is defined by LayoutRegion.

titlebar

titlebar : Boolean
True to display a title bar (defaults to true)
This config option is defined by LayoutRegion.
Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.