| Defined In: | Component.js |
| Class: | Ext.Component |
| Extends: | Ext.util.Observable |
Base class for all Ext components. 全体Ext组件的基类。 Component下所有的子类均按照统一的Ext组件生命周期(lifeycle)执行运作,即创建、渲染和销毁(creation,rendering和destruction)。 并具有隐藏/显示和启用/禁用的基本行为特性。
Component下的子类可被延时渲染(lazy-rendered)成为Ext.Container的一种,同时自动登记到Ext.ComponentMgr, 这样便可在后面的代码使用Ext#getCmp获取组件的引用。 当需要以盒子模型(box model)的方式管理这些可视的器件(widgets), 器件就必须从Component(或Ext.BoxComponent)继承,渲染为一种布局。每种component都有特定的类型,是Ext自身设置的类型。对xtype检查的相关方法如#getXType和#isXType。 这里是所有有效的xtypes列表:
xtype 类Class ------------- ------------------ box Ext.BoxComponent button Ext.Button colorpalette Ext.ColorPalette component Ext.Component container Ext.Container cycle Ext.CycleButton dataview Ext.DataView datepicker Ext.DatePicker editor Ext.Editor editorgrid Ext.grid.EditorGridPanel grid Ext.grid.GridPanel paging Ext.PagingToolbar panel Ext.Panel progress Ext.ProgressBar splitbutton Ext.SplitButton tabpanel Ext.TabPanel treepanel Ext.tree.TreePanel viewport Ext.ViewPort window Ext.Window Toolbar components 工具条组件 --------------------------------------- toolbar Ext.Toolbar tbbutton Ext.Toolbar.Button tbfill Ext.Toolbar.Fill tbitem Ext.Toolbar.Item tbseparator Ext.Toolbar.Separator tbspacer Ext.Toolbar.Spacer tbsplit Ext.Toolbar.SplitButton tbtext Ext.Toolbar.TextItem Form components 表单组件 --------------------------------------- form Ext.FormPanel checkbox Ext.form.Checkbox combo Ext.form.ComboBox datefield Ext.form.DateField field Ext.form.Field fieldset Ext.form.FieldSet hidden Ext.form.Hidden htmleditor Ext.form.HtmlEditor numberfield Ext.form.NumberField radio Ext.form.Radio textarea Ext.form.TextArea textfield Ext.form.TextField timefield Ext.form.TimeField trigger Ext.form.TriggerField
| 配置项 | 定义者 | |
|---|---|---|
|
id
: String
唯一的组件id(默认为自动分配的id)。
唯一的组件id(默认为自动分配的id)。
|
Component | |
|
xtype
: String
The registered xtype to create. 用于...
The registered xtype to create. 用于登记一个xtype。 This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create.
The predefined xtypes are listed {@link Ext.Component here}. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr#registerType in order to be able to take advantage of lazy instantiation and rendering. |
Component | |
|
cls
: String
一个可选添加的CSS样式类,加入到组件的容器上(默认为'')。 这为容...
一个可选添加的CSS样式类,加入到组件的容器上(默认为'')。 这为容器或容器的子节点加入标准CSS规则提供了方便。
|
Component | |
|
style
: String
作用在组件元素上特定的样式。该值的有效格式应如Ext.Element#...
作用在组件元素上特定的样式。该值的有效格式应如Ext.Element#applyStyles。
|
Component | |
|
plugins
: Object/Array
针对该组件自定义的功能,是对象或这些对象组成的数组。 一个有效的插件须...
针对该组件自定义的功能,是对象或这些对象组成的数组。 一个有效的插件须保证带有一个init的方法以便接收属于Ext.Component类型的引用。 当一个组件被创建后,若发现由插件可用,组件会调用每个插件上的init方法,传入一个应用到插件本身。 这样,插件便能按照组件所提供的功能,调用到组件的方法或响应事件。
|
Component | |
|
applyTo
: Mixed
节点的id,或是DOM节点,又或者是与DIV相当的现有元素,这些都是文...
节点的id,或是DOM节点,又或者是与DIV相当的现有元素,这些都是文档中已经存在的元素 当使用applyTo后,主元素所指定的id或CSS样式类将会作用于组件构成的部分, 而被创建的组件将会尝试着根据这些markup构建它的子组件。 使用了这项配置后,不需要执行render()的方法。 若指定了applyTo,那么任何由#renderTo传入的值将会被忽略并使用目标元素的父级元素作为组件的容器。
|
Component | |
|
renderTo
: Mixed
容器渲染的那个节点的id,或是DOM节点,又或者是与DIV相当的现有元...
容器渲染的那个节点的id,或是DOM节点,又或者是与DIV相当的现有元素。 使用了这项配置后,不需要执行render()的方法。
|
Component | |
|
disabledClass
: String
当组件被禁用时作用的CSS样式类(默认为"x-item-disable...
当组件被禁用时作用的CSS样式类(默认为"x-item-disabled")。
|
Component | |
|
allowDomMove
: Boolean
当渲染进行时能否移动Dom节点上的组件(默认为true)。
当渲染进行时能否移动Dom节点上的组件(默认为true)。
|
Component | |
|
autoShow
: Boolean
True表示为在渲染的时候先检测一下有否关于隐藏的样式类(如:'x-h...
True表示为在渲染的时候先检测一下有否关于隐藏的样式类(如:'x-hidden'或'x-hide-display'),有就移除隐藏的样式类。 (缺省为false)
|
Component | |
|
hideMode
: String
这个组件是怎么隐藏的。可支持的值有"visibility" (css中...
这个组件是怎么隐藏的。可支持的值有"visibility" (css中的visibility), "offsets"(负偏移位置)和 "display"(css中的display)-默认为“display”。
|
Component | |
|
hideParent
: Boolean
True表示为当隐藏/显示组件时对组件的容器亦一同隐藏/显示,fals...
True表示为当隐藏/显示组件时对组件的容器亦一同隐藏/显示,false就只会隐藏/显示组件本身(默认为false)。 例如,可设置一个hide:true的隐藏按钮在window,如果按下就通知其父容器一起隐藏,这样做起来比较快捷省事。
|
Component | |
|
listeners
: Object
一个配置项对象,可方便在该对象初始化时便加入多个事件处理函数。 这应该...
一个配置项对象,可方便在该对象初始化时便加入多个事件处理函数。 这应该是一个如#addListener有效的配置项对象,即可一次过加入多个事件处理函数。
|
Observable | |
| 属性 | 定义者 | |
|---|---|---|
|
initialConfig: initialConfig
组件初始化配置项。只读的
组件初始化配置项。只读的
|
Component | |
|
ownerCt: ownerCt
组件自身的Ext.Container(默认是undefined,只有...
组件自身的Ext.Container(默认是undefined,只有在组件加入到容器时才会自动设置该属性)只读的。
|
Component | |
|
*/: */
True表示为该组件已经渲染好了。只读的。
True表示为该组件已经渲染好了。只读的。
|
Component | |
| 方法 | 定义者 | |
|---|---|---|
Component
(
Ext.Element/String/Object config
)
: Ext.Component
构造器
构造器
参数项:
|
Component | |
render
(
[Mixed container],
[String/Number position]
)
如果这是延时加载的组件,就要执行这个渲染的方法到其容器的元素。
...
如果这是延时加载的组件,就要执行这个渲染的方法到其容器的元素。
这个组件插入到容器的之前位置,可以是元素的ID或是DOM节点的索引(缺省是插入到容器的尾部)
参数项:
|
Component | |
applyToMarkup
(
String/HTMLElement el
)
把这个组件应用到当前有效的markup。执行该函数后,无须调用ren...
把这个组件应用到当前有效的markup。执行该函数后,无须调用render()
参数项:
|
Component | |
addClass
(
string cls
)
加入CSS样式类到组件所在的元素。
加入CSS样式类到组件所在的元素。
参数项:
|
Component | |
removeClass
(
string cls
)
移除CSS样式类到组件所属的元素。
移除CSS样式类到组件所属的元素。
参数项:
|
Component | |
|
destroy
(
)
清除任何的事件的句柄,在DOM中移除组件的元素,从容器Ext.Con...
清除任何的事件的句柄,在DOM中移除组件的元素,从容器Ext.Container中移除本身(如果适合的话)和在Ext.ComponentMgr注销 销毁的方法一般由框架自动执行,通常不需要直接执行。
参数项:
|
Component | |
|
getEl
(
)
: Ext.Element
返回所属的{@link Ext.Element}.
返回所属的{@link Ext.Element}.
参数项:
|
Component | |
|
getId
(
)
: String
返回该组件的id
返回该组件的id
参数项:
|
Component | |
|
getItemId
(
)
: String
返回该组件的item id。
返回该组件的item id。
参数项:
|
Component | |
focus
(
[Boolean selectText],
[Boolean/Number delay]
)
: Ext.Component
试着将焦点放到此项。
试着将焦点放到此项。
参数项:
|
Component | |
|
disable
(
)
: Ext.Component
禁止该组件。
禁止该组件。
参数项:
|
Component | |
|
enable
(
)
: Ext.Component
启用该组件。
启用该组件。
参数项:
|
Component | |
setDisabled
(
Boolean disabled
)
方便的函数用来控制组件禁用/可用。
方便的函数用来控制组件禁用/可用。
参数项:
|
Component | |
|
show
(
)
: Ext.Component
显示该组件。
显示该组件。
参数项:
|
Component | |
|
hide
(
)
: Ext.Component
隐藏该组件。
隐藏该组件。
参数项:
|
Component | |
setVisible
(
Boolean visible
)
: Ext.Component
方便的函数用来控制组件显示/隐藏。
方便的函数用来控制组件显示/隐藏。
参数项:
|
Component | |
|
isVisible
(
)
该组件可见时返回true。
该组件可见时返回true。
参数项:
|
Component | |
|
cloneConfig
(
)
: Ext.Component
根据原始传入到该实例的配置项值,克隆一份组件。
根据原始传入到该实例的配置项值,克隆一份组件。
参数项:
|
Component | |
|
getXType
(
)
: String
获取Ext.ComponentMgr在已登记组件的xtypes。 ...
获取Ext.ComponentMgr在已登记组件的xtypes。 全部可用的xtypes列表,可参考Ext.Component开头,用法举例:
参数项:
|
Component | |
isXType
(
String xtype,
[Boolean shallow]
)
测试这个组件是否属于某个指定的xtype。 这个方法既可测试该组件是...
测试这个组件是否属于某个指定的xtype。 这个方法既可测试该组件是否为某个xtype的子类,或直接是这个xtype的实例(shallow = true) 全部可用的xtypes列表,可参考Ext.Component开头,用法举例:
true就表示为测试该组件是否这个xtype本身的实例
参数项:
|
Component | |
|
getXTypes
(
)
: String
返回以斜杠分割的字符串,表示组件的xtype层次。 全部可用的xty...
返回以斜杠分割的字符串,表示组件的xtype层次。 全部可用的xtypes列表,可参考{@link Ext.Component}开头,用法举例:
参数项:
|
Component | |
fireEvent
(
String eventName,
Object... args
)
: Boolean
触发指定的事件,并将欲执行的处理函数的参数传入。(应该至少要有事件的...
触发指定的事件,并将欲执行的处理函数的参数传入。(应该至少要有事件的名称)
参数项:
|
Observable | |
addListener
(
String eventName,
Function handler,
[Object scope],
[Object options]
)
为该组件加入事件处理函数(event handler)
sc...
为该组件加入事件处理函数(event handler)
处理函数执行时所在的作用域。处理函数“this”的上下文。 触发事件后开始执行处理函数的延时时间(invocation:the act of making a particular function start),单位:毫秒 true代表为下次事件触发加入一个要处理的处理函数,然后再移除本身。 不同配搭方式的选项 一次调用加入上多个处理函数(handlers) 或者是以简写的方式书写,前提是只允许同一个的作用域对象传入到所有的处理函数中:
参数项:
|
Observable | |
removeListener
(
String eventName,
Function handler,
[Object scope]
)
移除侦听器
移除侦听器
参数项:
|
Observable | |
|
purgeListeners
(
)
从这个对象身上移除所有的侦听器
从这个对象身上移除所有的侦听器
参数项:
|
Observable | |
addEvents
(
Object object
)
定义观察者的事件。
定义观察者的事件。
参数项:
|
Observable | |
hasListener
(
String eventName
)
: Boolean
查询该对象是否有指定事件的侦听器
查询该对象是否有指定事件的侦听器
参数项:
|
Observable | |
|
suspendEvents
(
)
暂停触发所有的事件(参阅#resumeEvents)
暂停触发所有的事件(参阅#resumeEvents)
参数项:
|
Observable | |
|
resumeEvents
(
)
重新触发事件(参阅{@link #suspendEvents})
重新触发事件(参阅{@link #suspendEvents})
参数项:
|
Observable | |
on
(
String eventName,
[Object scope],
Function handler,
[Object options]
)
为该元素添加事件处理函数(event handler),addLis...
为该元素添加事件处理函数(event handler),addListener的简写方式 @param {String} eventName 侦听事件的类型 @param {Object} scope (可选的) 执行处理函数的作用域 @param {Function} handler 事件涉及的方法 @param {Object} options (可选的)
参数项:
|
Observable | |
un
(
String eventName,
Function handler,
[Object scope]
)
移除侦听器 @param {String} eventName ...
移除侦听器 @param {String} eventName 侦听事件的类型 @param {Function} handler 事件涉及的方法 @param {Object} scope (可选的)处理函数的作用域
参数项:
|
Observable | |
capture
(
Observable o,
Function fn,
[Object scope]
)
开始捕捉特定的观察者。 在事件触发之前,所有的事件会以“事件名称+标...
开始捕捉特定的观察者。 在事件触发之前,所有的事件会以“事件名称+标准签名”的形式传入到函数(传入的参数是function类型)。 如果传入的函数执行后返回false,则接下的事件将不会触发。 @param {Observable} o 要捕捉的观察者 @param {Function} fn 要调用的函数 @param {Object} scope (可选的)函数作用域
参数项:
|
Observable | |
releaseCapture
(
Observable o
)
从Observable身上移除所有已加入的捕捉captures。 @...
从Observable身上移除所有已加入的捕捉captures。 @param {Observable} o 要释放的观察者
参数项:
|
Observable | |