| Defined In: | ProgressBar.js |
| Class: | Ext.ProgressBar |
| Extends: | Ext.BoxComponent |
可更新进度条的组件。进度条支持两种不同的模式:手动的和自动的。
手动模式下,进度条的显示、更新(通过#updateProgress)和清除这些任务便需要你代码的去完成。 此方法最适用于可实现预测点的操作显示进度条。
自动模式下,你只需要调用#wait并让进度条不停地运行下去,然后直到操作完成后停止进度条。另外一种用法是你让进度条显示一定的时间(wait方法),wait一定时间后停止显示进度。 自动模式最适用于已知时间的操作或不需要标识实际进度的异步操作。
@cf| 配置项 | 定义者 | |
|---|---|---|
|
value
: Float
0到1区间的浮点数(例如:.5,默认为0)
0到1区间的浮点数(例如:.5,默认为0)
|
ProgressBar | |
|
textEl
: Mixed
负责进度条渲染的那个元素(默认为进度条内部文本元素)
负责进度条渲染的那个元素(默认为进度条内部文本元素)
|
ProgressBar | |
|
baseCls
: String
进度条外层元素所使用的CSS样式类基类(默认为'x-progress')
进度条外层元素所使用的CSS样式类基类(默认为'x-progress')
|
ProgressBar | |
|
height
: Number
此组件的高度(单位象素)(缺省为auto)。
此组件的高度(单位象素)(缺省为auto)。
|
BoxComponent | |
|
width
: Number
此组件的宽度(单位象素)(缺省为auto)。
此组件的宽度(单位象素)(缺省为auto)。
|
BoxComponent | |
|
autoHeight
: Boolean
True表示为使用height:'auto',false表示为使用固定...
True表示为使用height:'auto',false表示为使用固定高度(缺省为false)。
|
BoxComponent | |
|
autoWidth
: Boolean
True表示为使用width:'auto',false表示为使用固定宽...
True表示为使用width:'auto',false表示为使用固定宽度(缺省为false)。
|
BoxComponent | |
|
deferHeight
: Boolean
True表示为根据外置的组件延时计算高度,false表示允许该组件自行...
True表示为根据外置的组件延时计算高度,false表示允许该组件自行设置高度(缺省为false)。
|
BoxComponent | |
|
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 | |
| 方法 | 定义者 | |
|---|---|---|
updateProgress
(
[Float value],
[String text]
)
: Ext.ProgressBar
更新进度条的刻度值,也可以更新提示文本。如果文本的参数没传入,那么...
更新进度条的刻度值,也可以更新提示文本。如果文本的参数没传入,那么当前的文本将不会有变化。
要取消当前文本,传入''。注意即使进度条的值溢出(大于1),也不会自动复位,这样你就要确定进度是何时完成然后调用#reset停止或隐藏控件。
参数项:
|
ProgressBar | |
wait
(
[Object config]
)
: Ext.ProgressBar
初始化一个自动更新的进度条。
如果有duration的参数传入,...
初始化一个自动更新的进度条。
如果有duration的参数传入,那么代表进度条会运行到一定的时间后停止(自动调用reset方法),并若然有指定一个回调函数,也会执行。
如果duration的参数不传入,那么进度条将会不停地运行下去,这样你就要调用#reset的方法停止他。wait方法可接受以下属性的配置对象:
属性 类型 内容 ---------- ------------ ---------------------------------------------------------------------- duration Number 进度条运作时间的长度,单位是毫秒,跑完后执行自身的复位方法(默认为undefined,即不断地运行除非执行reset方法结束) interval Number 每次更新的间隔周期(默认为1000毫秒) increment Number 进度条每次更新的幅度大小(默认为10)。如果进度条达到最后,那么它会回到原点。 fn Function 当进度条完成自动更新后执行的回调函数。该函数没有参数。如不指定duration该项自动忽略,这样进度条只能写代码结束更新 scope Object 回调函数的作用域(只当duration与fn两项都传入时有效)用法举例:
参数项:
|
ProgressBar | |
|
isWaiting
(
)
: Boolean
返回进度条当前是否在{@link #wait}的操作中。
返回进度条当前是否在{@link #wait}的操作中。
参数项:
|
ProgressBar | |
updateText
(
[String text]
)
: Ext.ProgressBar
更新进度条的提示文本。 如传入text参数,textEl会更新其...
更新进度条的提示文本。 如传入text参数,textEl会更新其内容,否则进度条本身会显示已更新的文本。
参数项:
|
ProgressBar | |
setSize
(
Number/Object width,
Number height
)
: Ext.BoxComponent
设置组件的宽度和高度。
此方法会触发resize事件。
此方法...
设置组件的宽度和高度。
此方法会触发resize事件。
此方法既可接受单独的数字类型的参数,也可以传入一个size的对象,如 {width:10, height:20}。
参数项:
|
BoxComponent | |
reset
(
[Boolean hide]
)
: Ext.ProgressBar
将进度条的刻度复位为零并将提示文本设置为空白字符串。如果hide=...
将进度条的刻度复位为零并将提示文本设置为空白字符串。如果hide=true,那么进度条会被隐藏(根据在内部的#hideMode属性)。
参数项:
|
ProgressBar | |
BoxComponent
(
Ext.Element/String/Object config
)
: Ext.BoxComponent
构造器
构造器
参数项:
|
BoxComponent | |
setWidth
(
Number height
)
: Ext.BoxComponent
设置组件的宽度。此方法会触发resize事件。
设置组件的宽度。此方法会触发resize事件。
参数项:
|
BoxComponent | |
setHeight
(
Number height
)
: Ext.BoxComponent
设置组件的高度。此方法会触发resize事件。
设置组件的高度。此方法会触发resize事件。
参数项:
|
BoxComponent | |
|
getSize
(
)
: Object} 包含元素大小的对象,格式为{width: (元素宽度), height:(元素高度)
返回当前组件所属元素的大小。
返回当前组件所属元素的大小。
参数项:
|
BoxComponent | |
getPosition
(
[Boolean local]
)
: Array
对组件所在元素当前的XY位置
对组件所在元素当前的XY位置
参数项:
|
BoxComponent | |
getBox
(
[Boolean local]
)
: Object
返回对组件所在元素的测量矩形大小。
返回对组件所在元素的测量矩形大小。
参数项:
|
BoxComponent | |
updateBox
(
Object box
)
: Ext.BoxComponent
对组件所在元素的测量矩形大小,然后根据此值设置组件的大小。
对组件所在元素的测量矩形大小,然后根据此值设置组件的大小。
参数项:
|
BoxComponent | |
setPosition
(
Number left,
Number top
)
: Ext.BoxComponent
设置组件的left和top值。要设置基于页面的XY位置,可使用#s...
设置组件的left和top值。要设置基于页面的XY位置,可使用#setPagePosition。
此方法触发move事件。
参数项:
|
BoxComponent | |
setPagePosition
(
Number x,
Number y
)
: Ext.BoxComponent
设置组件页面上的left和top值。
要设置left、top的位...
设置组件页面上的left和top值。
要设置left、top的位置,可使用{@link #setPosition}。
此方法触发move事件。
参数项:
|
BoxComponent | |
|
syncSize
(
)
: Ext.BoxComponent
强制重新计算组件的大小尺寸,这个尺寸是基于所属元素当前的高度和宽度。
强制重新计算组件的大小尺寸,这个尺寸是基于所属元素当前的高度和宽度。
参数项:
|
BoxComponent | |
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 | |
| 事件 | 定义者 | |
|---|---|---|
update
(
Ext.ProgressBar this,
Number value,
String text
)
每一次更新就触发该事件
每一次更新就触发该事件
参数项:
|
ProgressBar | |
resize
(
Ext.Component this,
Number adjWidth,
Number adjHeight,
Number rawWidth,
Number rawHeight
)
当组件调节过大小后触发。
当组件调节过大小后触发。
参数项:
|
BoxComponent | |
move
(
Ext.Component this,
Number x,
Number y
)
当组件被移动过之后触发。
当组件被移动过之后触发。
参数项:
|
BoxComponent | |
disable
(
Ext.Component this
)
当组件禁用后触发。
当组件禁用后触发。
参数项:
|
Component | |
enable
(
Ext.Component this
)
当组件启用后触发。
当组件启用后触发。
参数项:
|
Component | |
beforeshow
(
Ext.Component this
)
当组件显示出来之前触发。如返回false则阻止显示。
当组件显示出来之前触发。如返回false则阻止显示。
参数项:
|
Component | |
show
(
Ext.Component this
)
当组件显示后触发。
当组件显示后触发。
参数项:
|
Component | |
beforehide
(
Ext.Component this
)
当组件将要隐藏的时候触发。如返回false则阻止隐藏。
当组件将要隐藏的时候触发。如返回false则阻止隐藏。
参数项:
|
Component | |
hide
(
Ext.Component this
)
当组件隐藏后触发。
当组件隐藏后触发。
参数项:
|
Component | |
beforerender
(
Ext.Component this
)
当组件渲染之前触发。如返回false则阻止渲染。
当组件渲染之前触发。如返回false则阻止渲染。
参数项:
|
Component | |
render
(
Ext.Component this
)
组件渲染之后触发。
组件渲染之后触发。
参数项:
|
Component | |
beforedestroy
(
Ext.Component this
)
组件销毁之前触发。如返回false则停止销毁。
组件销毁之前触发。如返回false则停止销毁。
参数项:
|
Component | |
destroy
(
Ext.Component this
)
组件销毁之后触发。
组件销毁之后触发。
参数项:
|
Component | |
beforestaterestore
(
Ext.Component this,
Object state
)
当组件的状态复原之前触发。如返回false则停止复原状态。
当组件的状态复原之前触发。如返回false则停止复原状态。
参数项:
|
Component | |
staterestore
(
Ext.Component this,
Object state
)
当组件的状态复原后触发。
当组件的状态复原后触发。
参数项:
|
Component | |
beforestatesave
(
Ext.Component this,
Object state
)
当组件的状态被保存到state provider之前触发。如返回f...
当组件的状态被保存到state provider之前触发。如返回false则停止保存。
参数项:
|
Component | |
statesave
(
Ext.Component this,
Object state
)
当组件的状态被保存到state provider后触发。
当组件的状态被保存到state provider后触发。
参数项:
|
Component | |