打印版式

Class Ext.ReaderLayout

Package:Ext
Class:ReaderLayout
Extends:BorderLayout
Defined In:ReaderLayout.js
This is a pre-built layout that represents a classic, 5-pane application. It consists of a header, a primary center region containing two nested regions (a top one for a list view and one for item preview below), and regions on either side that can be used for navigation, application commands, informational displays, etc. The setup and configuration work exactly the same as it does for a Ext.BorderLayout - this class simply expedites the setup of the overall layout and regions for this common application style. Example:
var reader = new Ext.ReaderLayout();
var CP = Ext.ContentPanel;  // shortcut for adding

reader.beginUpdate();
reader.add("north", new CP("north", "North"));
reader.add("west", new CP("west", {title: "West"}));
reader.add("east", new CP("east", {title: "East"}));

reader.regions.listView.add(new CP("listView", "List"));
reader.regions.preview.add(new CP("preview", "Preview"));
reader.endUpdate();

属性   -  方法   -  事件

公共属性

属性 定义对象
  monitorWindowResize : Boolean LayoutManager
false to disable window resize monitoring

公共方法

方法 定义对象
  ReaderLayout(Object config, [String/HTMLElement/Element container]) ReaderLayout
Create a new ReaderLayout
  add(String target, Ext.ContentPanel panel) : Ext.ContentPanel BorderLayout
Adds a ContentPanel (or subclass) to this layout.
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  addRegion(String target, Object config) : BorderLayoutRegion BorderLayout
Creates and adds a new region if it doesn't already exist.
  beginUpdate() : void LayoutManager
Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls
  endUpdate(Boolean noLayout) : void LayoutManager
Restore auto-layouts and optionally disable the manager from performing a layout
  findPanel(String panelId) : Ext.ContentPanel BorderLayout
Searches all regions for a panel with the specified id
  fireEvent(String eventName, Object... args) : Boolean Observable
触发指定的事件, 并将参数传入(至少要有事件名称)。
  getEl() : Ext.Element LayoutManager
Returns the element this layout is bound to.
  getRegion(String target) : Ext.LayoutRegion LayoutManager
Returns the specified region.
  getViewSize() : Object LayoutManager
Returns the size of the current view, This method normalizes document.body and element embedded layouts and performs ...
  hasListener(String eventName) : Boolean Observable
检查该对象是否拥有指定事件的侦听器
  isUpdating() : Boolean LayoutManager
Returns true if this layout is currently being updated
  layout() : void BorderLayout
Performs a layout update.
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  remove(String target, Number/String/Ext.ContentPanel panel) : Ext.ContentPanel BorderLayout
Remove a ContentPanel (or subclass) to this layout.
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  restoreState([Ext.state.Provider provider]) : void BorderLayout
Restores this layouts state using Ext.state.Manager or the state provided by the passed provider.
  showPanel(String/ContentPanel panelId) : Ext.ContentPanel BorderLayout
Searches all regions for a panel with the specified id and activates (shows) it.
  un(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器, removeListener 的简写方式

公共事件

事件 定义对象
  layout : (Ext.LayoutManager this) LayoutManager
Fires when a layout is performed.
  regioncollapsed : (Ext.LayoutRegion region) LayoutManager
Fires when a region is collapsed.
  regionexpanded : (Ext.LayoutRegion region) LayoutManager
Fires when a region is expanded.
  regionresized : (Ext.LayoutRegion region, Number newSize) LayoutManager
Fires when the user resizes a region.

属性详情

monitorWindowResize

public Boolean monitorWindowResize
false to disable window resize monitoring
This property is defined by LayoutManager.

构造函数

ReaderLayout

public function ReaderLayout(Object config, [String/HTMLElement/Element container])
Create a new ReaderLayout
参数:
  • config : Object
    Configuration options
  • container : String/HTMLElement/Element
    (可选) The container this layout is bound to (defaults to document.body if omitted)

方法详情

add

public function add(String target, Ext.ContentPanel panel)
Adds a ContentPanel (or subclass) to this layout.
参数:
  • target : String
    The target region key (north, south, east, west or center).
  • panel : Ext.ContentPanel
    The panel to add
返回:
  • Ext.ContentPanel
    The added panel
This method is defined by BorderLayout.

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.

addRegion

public function addRegion(String target, Object config)
Creates and adds a new region if it doesn't already exist.
参数:
  • target : String
    The target region key (north, south, east, west or center).
  • config : Object
    The regions config object
返回:
  • BorderLayoutRegion
    The new region
This method is defined by BorderLayout.

beginUpdate

public function beginUpdate()
Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls
参数:
  • 无。
返回:
  • void
This method is defined by LayoutManager.

endUpdate

public function endUpdate(Boolean noLayout)
Restore auto-layouts and optionally disable the manager from performing a layout
参数:
  • noLayout : Boolean
    true to disable a layout update
返回:
  • void
This method is defined by LayoutManager.

findPanel

public function findPanel(String panelId)
Searches all regions for a panel with the specified id
参数:
  • panelId : String
返回:
  • Ext.ContentPanel
    The panel or null if it wasn't found
This method is defined by BorderLayout.

fireEvent

public function fireEvent(String eventName, Object... args)
触发指定的事件并给出参数(至少要有事件名称)。
参数:
  • eventName : String
  • args : Object...
    传入处理函数的参数
返回:
  • Boolean
    如果任何处理函数返回 false 则返回值为 false, 否则返回 true。
This method is defined by Observable.

getEl

public function getEl()
Returns the element this layout is bound to.
参数:
  • 无。
返回:
  • Ext.Element
This method is defined by LayoutManager.

getRegion

public function getRegion(String target)
Returns the specified region.
参数:
  • target : String
    The region key
返回:
  • Ext.LayoutRegion
This method is defined by LayoutManager.

getViewSize

public function getViewSize()
Returns the size of the current view, This method normalizes document.body and element embedded layouts and performs box-model adjustments.
参数:
  • 无。
返回:
  • Object
    The size as an object {width: (the width), height: (the height)}
This method is defined by LayoutManager.

hasListener

public function hasListener(String eventName)
检查该对象是否拥有指定事件的侦听器
参数:
  • eventName : String
    查询事件之名称
返回:
  • Boolean
    值为 True 值表示事件监听器存在, 否则值为 false。
This method is defined by Observable.

isUpdating

public function isUpdating()
Returns true if this layout is currently being updated
参数:
  • 无。
返回:
  • Boolean
This method is defined by LayoutManager.

layout

public function layout()
Performs a layout update.
参数:
  • 无。
返回:
  • void
This method is defined by BorderLayout.

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(String target, Number/String/Ext.ContentPanel panel)
Remove a ContentPanel (or subclass) to this layout.
参数:
  • target : String
    The target region key (north, south, east, west or center).
  • panel : Number/String/Ext.ContentPanel
    The index, id or panel to remove
返回:
  • Ext.ContentPanel
    The removed panel
This method is defined by BorderLayout.

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.

restoreState

public function restoreState([Ext.state.Provider provider])
Restores this layouts state using Ext.state.Manager or the state provided by the passed provider.
参数:
  • provider : Ext.state.Provider
    (可选) An alternate state provider
返回:
  • void
This method is defined by BorderLayout.

showPanel

public function showPanel(String/ContentPanel panelId)
Searches all regions for a panel with the specified id and activates (shows) it.
参数:
  • panelId : String/ContentPanel
    The panels id or the panel itself
返回:
  • Ext.ContentPanel
    The shown panel or null
This method is defined by BorderLayout.

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.

事件详情

layout

public event layout
Fires when a layout is performed.
Subscribers will be called with the following parameters:
  • this : Ext.LayoutManager
This event is defined by LayoutManager.

regioncollapsed

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

regionexpanded

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

regionresized

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

Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.