Class Ext.Button

Package:	Ext
Class:	Button
Extends:	Observable
Subclasses:	MenuButton, Toolbar.Button
Defined In:	Button.js

Simple Button class

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

公共属性

属性		定义对象
	disabled : Boolean	Button
	Read-only. True if this button is disabled	Button
	hidden : Boolean	Button
	Read-only. True if this button is hidden	Button
	pressed : Boolean	Button
	Read-only. True if this button is pressed (only if enableToggle = true)	Button

公共方法

方法		定义对象
	Button(`String/HTMLElement/Element renderTo`, `Object config`)	Button
	Create a new button	Button
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	destroy() : void	Button
	Destroys this Button and removes any listeners.	Button
	disable() : void	Button
	Disable this button	Button
	enable() : void	Button
	Enable this button	Button
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件, 并将参数传入（至少要有事件名称）。	Observable
	focus() : void	Button
	Focus the button	Button
	getEl() : Ext.Element	Button
	Returns the button's underlying element	Button
	getText() : String	Button
	Gets the text for this button	Button
	hasListener(`String eventName`) : Boolean	Observable
	检查该对象是否拥有指定事件的侦听器	Observable
	hide() : void	Button
	Hide this button	Button
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为该组件加入事件处理器函数, addListener 的简写方式	Observable
	purgeListeners() : void	Observable
	从对象身上移除所有的侦听器	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器	Observable
	setDisabled(`Boolean enabled`) : void	Button
	Convenience function for boolean enable/disable	Button
	setHandler(`Function handler`, [`Object scope`]) : void	Button
	Assigns this button's click handler	Button
	setText(`String text`) : void	Button
	Sets this button's text	Button
	setVisible(`Boolean visible`) : void	Button
	Convenience function for boolean show/hide	Button
	show() : void	Button
	Show this button	Button
	toggle([`Boolean state`]) : void	Button
	If a state it passed, it becomes the pressed state otherwise the current state is toggled.	Button
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable

公共事件

事件		定义对象
	click : (`Button this`, `EventObject e`)	Button
	Fires when this button is clicked	Button
	mouseout : (`Button this`, `Event e`)	Button
	Fires when the mouse exits the button	Button
	mouseover : (`Button this`, `Event e`)	Button
	Fires when the mouse hovers over the button	Button
	toggle : (`Button this`, `Boolean pressed`)	Button
	Fires when the "pressed" state of this button changes (only if enableToggle = true)	Button

设置选项

设置选项		定义对象
	disabled : Boolean	Button
	True to start disabled (defaults to false)	Button
	enableToggle : Boolean	Button
	True to enable pressed/not pressed toggling (defaults to false)	Button
	handler : Function	Button
	A function called when the button is clicked (can be used instead of click event)	Button
	hidden : Boolean	Button
	True to start hidden (defaults to false)	Button
	icon : String	Button
	The path to an image to display in the button (the image will be set as the background-image CSS property of the butt...	Button
	menu : Mixed	Button
	Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob	Button
	menuAlign : String	Button
	The position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?').	Button
	minWidth : Number	Button
	The minimum width for this button (used to give a set of buttons a common width)	Button
	pressed : Boolean	Button
	True to start pressed (only if enableToggle = true)	Button
	repeat : Boolean/Object	Button
	True to repeat fire the click event while the mouse is down. This can also be an Ext.util.ClickRepeater config object...	Button
	scope : Object	Button
	The scope of the handler	Button
	text : String	Button
	The button text	Button
	toggleGroup : String	Button
	The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)	Button
	tooltip : String/Object	Button
	The tooltip for the button - can be a string or QuickTips config object	Button
	tooltipType : String	Button
	The type of tooltip to use. Either "qtip" for QuickTips or "title" for title attribute.	Button

属性详情

disabled

public Boolean disabled

Read-only. True if this button is disabled

This property is defined by Button.

hidden

public Boolean hidden

Read-only. True if this button is hidden

This property is defined by Button.

pressed

public Boolean pressed

Read-only. True if this button is pressed (only if enableToggle = true)

This property is defined by Button.

构造函数

Button

public function Button(String/HTMLElement/Element renderTo, Object config)

Create a new button

参数：

renderTo : String/HTMLElement/Element
The element to append the button to
config : Object
The 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 Button and removes any listeners.

参数：

无。

返回：

void

This method is defined by Button.

disable

public function disable()

Disable this button

参数：

无。

返回：

void

This method is defined by Button.

enable

public function enable()

Enable this button

参数：

无。

返回：

void

This method is defined by Button.

fireEvent

public function fireEvent(String eventName, Object... args)

触发指定的事件并给出参数（至少要有事件名称）。

参数：

eventName : String
args : Object...
传入处理函数的参数

返回：

Boolean
如果任何处理函数返回 false 则返回值为 false, 否则返回 true。

This method is defined by Observable.

focus

public function focus()

Focus the button

参数：

无。

返回：

void

This method is defined by Button.

getEl

public function getEl()

Returns the button's underlying element

参数：

无。

返回：

Ext.Element
The element

This method is defined by Button.

getText

public function getText()

Gets the text for this button

参数：

无。

返回：

String
The button text

This method is defined by Button.

hasListener

public function hasListener(String eventName)

检查该对象是否拥有指定事件的侦听器

参数：

eventName : String
查询事件之名称

返回：

Boolean
值为 True 值表示事件监听器存在, 否则值为 false。

This method is defined by Observable.

hide

public function hide()

Hide this button

参数：

无。

返回：

void

This method is defined by Button.

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.

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.

setDisabled

public function setDisabled(Boolean enabled)

Convenience function for boolean enable/disable

参数：

enabled : Boolean
True to enable, false to disable

返回：

void

This method is defined by Button.

setHandler

public function setHandler(Function handler, [Object scope])

Assigns this button's click handler

参数：

handler : Function
The function to call when the button is clicked
scope : Object
（可选） Scope for the function passed in

返回：

void

This method is defined by Button.

setText

public function setText(String text)

Sets this button's text

参数：

text : String
The button text

返回：

void

This method is defined by Button.

setVisible

public function setVisible(Boolean visible)

Convenience function for boolean show/hide

参数：

visible : Boolean
True to show, false to hide

返回：

void

This method is defined by Button.

show

public function show()

Show this button

参数：

无。

返回：

void

This method is defined by Button.

toggle

public function toggle([Boolean state])

If a state it passed, it becomes the pressed state otherwise the current state is toggled.

参数：

state : Boolean
（可选） Force a particular state

返回：

void

This method is defined by Button.

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.

事件详情

click

public event click

Fires when this button is clicked

Subscribers will be called with the following parameters:

this : Button
e : EventObject
The click event

This event is defined by Button.

mouseout

public event mouseout

Fires when the mouse exits the button

Subscribers will be called with the following parameters:

this : Button
e : Event
The event object

This event is defined by Button.

mouseover

public event mouseover

Fires when the mouse hovers over the button

Subscribers will be called with the following parameters:

this : Button
e : Event
The event object

This event is defined by Button.

toggle

public event toggle

Fires when the "pressed" state of this button changes (only if enableToggle = true)

Subscribers will be called with the following parameters:

this : Button
pressed : Boolean

This event is defined by Button.