打印版式

Class Ext.GridPanel

Package:Ext
Class:GridPanel
Extends:ContentPanel
Defined In:ContentPanels.js

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

公共属性

此类没有公共属性。

公共方法

方法 定义对象
  GridPanel(Ext.grid.Grid grid, String/Object config) GridPanel
Create a new GridPanel.
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  destroy() : void ContentPanel
Destroys this panel
  fireEvent(String eventName, Object... args) : Boolean Observable
触发指定的事件, 并将参数传入(至少要有事件名称)。
  getEl() : Ext.Element ContentPanel
Returns this panel's element
  getGrid() : Ext.grid.Grid GridPanel
Returns the grid for this panel
  getId() : String ContentPanel
Returns this panel's id
  getTitle() : String ContentPanel
Returns this panel's title
  getToolbar() : Ext.Toolbar ContentPanel
Returns the toolbar for this Panel if one was configured.
  getUpdateManager() : Ext.UpdateManager ContentPanel
Get the Ext.UpdateManager for this panel. Enables you to perform Ajax updates.
  hasListener(String eventName) : Boolean Observable
检查该对象是否拥有指定事件的侦听器
  isClosable() : Boolean ContentPanel
Returns true is this panel was configured to be closable
  load(Object/String/Function url, [String/Object params], [Function callback], [Boolean discardUrl]) : Ext.ContentPanel ContentPanel
Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use ...
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  refresh() : void ContentPanel
Force a content refresh from the URL specified in the setUrl() method. Will fail silently if the setUrl method has no...
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  setContent(String content, [Boolean loadScripts]) : void ContentPanel
Updates this panel's element
  setTitle(String title) : void ContentPanel
Set this panel's title
  setUrl(String/Function url, [String/Object params], [Boolean loadOnce]) : Ext.UpdateManager ContentPanel
Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded fro...
  un(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器, removeListener 的简写方式

公共事件

事件 定义对象
  activate : (Ext.ContentPanel this) ContentPanel
Fires when this panel is activated.
  deactivate : (Ext.ContentPanel this) ContentPanel
Fires when this panel is activated.
  resize : (Ext.ContentPanel this, Number width, Number height) ContentPanel
Fires when this panel is resized if fitToFrame is true.

设置选项

设置选项 定义对象
  adjustments : Array ContentPanel
Values to add to the width/height when doing a fitToFrame (default is [0, 0])
  autoCreate : Boolean/Object ContentPanel
True to auto generate the DOM element for this panel, or a DomHelper config of the element to create
  autoScroll : Boolean ContentPanel
True to scroll overflow in this panel (use with fitToFrame)
  background : Boolean ContentPanel
True if the panel should not be activated when it is added (defaults to false)
  closable : Boolean ContentPanel
True if the panel can be closed/removed
  fitContainer : Boolean ContentPanel
When using fitToFrame and resizeEl, you can also fit the parent container (defaults to false)
  fitToFrame : Boolean ContentPanel
True for this panel to adjust its size to fit when the region resizes (defaults to false)
  loadOnce : Boolean ContentPanel
Calls When used with "url", calls setUrl() with this value
  params : String/Object ContentPanel
When used with "url", calls setUrl() with this value
  resizeEl : String/HTMLElement/Element ContentPanel
An element to resize if fitToFrame is true (instead of this panel's element)
  title : String ContentPanel
The title for this panel
  toolbar : Toolbar ContentPanel
A toolbar for this panel
  url : String ContentPanel
Calls setUrl() with this value

构造函数

GridPanel

public function GridPanel(Ext.grid.Grid grid, String/Object config)
Create a new GridPanel.
参数:
  • grid : Ext.grid.Grid
    The grid for this panel
  • config : String/Object
    A string to set only the title or a config object

方法详情

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.

destroy

public function destroy()
Destroys this panel
参数:
  • 无。
返回:
  • void
This method is defined by ContentPanel.

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 this panel's element
参数:
  • 无。
返回:
  • Ext.Element
This method is defined by ContentPanel.

getGrid

public function getGrid()
Returns the grid for this panel
参数:
  • 无。
返回:
  • Ext.grid.Grid
This method is defined by GridPanel.

getId

public function getId()
Returns this panel's id
参数:
  • 无。
返回:
  • String
This method is defined by ContentPanel.

getTitle

public function getTitle()
Returns this panel's title
参数:
  • 无。
返回:
  • String
This method is defined by ContentPanel.

getToolbar

public function getToolbar()
Returns the toolbar for this Panel if one was configured.
参数:
  • 无。
返回:
  • Ext.Toolbar
This method is defined by ContentPanel.

getUpdateManager

public function getUpdateManager()
Get the Ext.UpdateManager for this panel. Enables you to perform Ajax updates.
参数:
  • 无。
返回:
  • Ext.UpdateManager
    The UpdateManager
This method is defined by ContentPanel.

hasListener

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

isClosable

public function isClosable()
Returns true is this panel was configured to be closable
参数:
  • 无。
返回:
  • Boolean
This method is defined by ContentPanel.

load

public function load(Object/String/Function url, [String/Object params], [Function callback], [Boolean discardUrl])
Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use setUrl.
参数:
  • url : Object/String/Function
    The url for this request or a function to call to get the url or a config object containing any of the following options:
     panel.load({
    url: "your-url.php",
    params: {param1: "foo", param2: "bar"}, // or a URL encoded string
    callback: yourFunction,
    scope: yourObject, //(optional scope)
    discardUrl: false,
    nocache: false,
    text: "Loading...",
    timeout: 30,
    scripts: false
    });
    The only required property is url. The optional properties nocache, text and scripts are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.
  • params : String/Object
    (可选) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}
  • callback : Function
    (可选) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)
  • discardUrl : Boolean
    (可选) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.
返回:
  • Ext.ContentPanel
    this
This method is defined by ContentPanel.

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.

refresh

public function refresh()
Force a content refresh from the URL specified in the setUrl() method. Will fail silently if the setUrl method has not been called. This does not activate the panel, just updates its content.
参数:
  • 无。
返回:
  • void
This method is defined by ContentPanel.

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.

setContent

public function setContent(String content, [Boolean loadScripts])
Updates this panel's element
参数:
  • content : String
    The new content
  • loadScripts : Boolean
    (可选) true to look for and process scripts
返回:
  • void
This method is defined by ContentPanel.

setTitle

public function setTitle(String title)
Set this panel's title
参数:
  • title : String
返回:
  • void
This method is defined by ContentPanel.

setUrl

public function setUrl(String/Function url, [String/Object params], [Boolean loadOnce])
Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.
参数:
  • url : String/Function
    The url to load the content from or a function to call to get the url
  • params : String/Object
    (可选) The string params for the update call or an object of the params. See Ext.UpdateManager.update for more details. (Defaults to null)
  • loadOnce : Boolean
    (可选) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)
返回:
  • Ext.UpdateManager
    The UpdateManager
This method is defined by ContentPanel.

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.

事件详情

activate

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

deactivate

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

resize

public event resize
Fires when this panel is resized if fitToFrame is true.
Subscribers will be called with the following parameters:
  • this : Ext.ContentPanel
  • width : Number
    The width after any component adjustments
  • height : Number
    The height after any component adjustments
This event is defined by ContentPanel.

设置详情

adjustments

adjustments : Array
Values to add to the width/height when doing a fitToFrame (default is [0, 0])
This config option is defined by ContentPanel.

autoCreate

autoCreate : Boolean/Object
True to auto generate the DOM element for this panel, or a DomHelper config of the element to create
This config option is defined by ContentPanel.

autoScroll

autoScroll : Boolean
True to scroll overflow in this panel (use with fitToFrame)
This config option is defined by ContentPanel.

background

background : Boolean
True if the panel should not be activated when it is added (defaults to false)
This config option is defined by ContentPanel.

closable

closable : Boolean
True if the panel can be closed/removed
This config option is defined by ContentPanel.

fitContainer

fitContainer : Boolean
When using fitToFrame and resizeEl, you can also fit the parent container (defaults to false)
This config option is defined by ContentPanel.

fitToFrame

fitToFrame : Boolean
True for this panel to adjust its size to fit when the region resizes (defaults to false)
This config option is defined by ContentPanel.

loadOnce

loadOnce : Boolean
Calls When used with "url", calls setUrl() with this value
This config option is defined by ContentPanel.

params

params : String/Object
When used with "url", calls setUrl() with this value
This config option is defined by ContentPanel.

resizeEl

resizeEl : String/HTMLElement/Element
An element to resize if fitToFrame is true (instead of this panel's element)
This config option is defined by ContentPanel.

title

title : String
The title for this panel
This config option is defined by ContentPanel.

toolbar

toolbar : Toolbar
A toolbar for this panel
This config option is defined by ContentPanel.

url

url : String
Calls setUrl() with this value
This config option is defined by ContentPanel.

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