Class Ext.util.ClickRepeater

Package:	Ext.util
Class:	ClickRepeater
Extends:	Observable
Defined In:	ClickRepeater.js

A wrapper class which can be applied to any element. Fires a "click" event while the mouse is pressed. The interval between firings may be specified in the config but defaults to 10 milliseconds. Optionally, a CSS class may be applied to the element during the time it is pressed.

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

公共属性

此类没有公共属性。

公共方法

方法		定义对象
	ClickRepeater(`String/HTMLElement/Element el`, `Object config`)	ClickRepeater
		ClickRepeater
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件, 并将参数传入（至少要有事件名称）。	Observable
	hasListener(`String eventName`) : Boolean	Observable
	检查该对象是否拥有指定事件的侦听器	Observable
	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
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable

公共事件

事件		定义对象
	click : (`Ext.util.ClickRepeater this`)	ClickRepeater
	Fires on a specified interval during the time the element is pressed.	ClickRepeater
	mousedown : (`Ext.util.ClickRepeater this`)	ClickRepeater
	Fires when the mouse button is depressed.	ClickRepeater
	mouseup : (`Ext.util.ClickRepeater this`)	ClickRepeater
	Fires when the mouse key is released.	ClickRepeater

设置选项

设置选项		定义对象
	accelerate : Boolean	ClickRepeater
	True if autorepeating should start slowly and accelerate. "interval" and "delay" are ignored. "immediate" is honored.	ClickRepeater
	delay : Number	ClickRepeater
	The initial delay before the repeating event begins firing. Similar to an autorepeat key delay.	ClickRepeater
	el : String/HTMLElement/Element	ClickRepeater
	The element to act as a button.	ClickRepeater
	interval : Number	ClickRepeater
	The interval between firings of the "click" event. Default 10 ms.	ClickRepeater
	pressClass : String	ClickRepeater
	A CSS class name to be applied to the element while pressed.	ClickRepeater
	preventDefault : Boolean	ClickRepeater
	True to prevent the default click event	ClickRepeater
	stopDefault : Boolean	ClickRepeater
	True to stop the default click event	ClickRepeater

构造函数

ClickRepeater

public function ClickRepeater(String/HTMLElement/Element el, Object config)

参数：

el : String/HTMLElement/Element
The element to listen on
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.

fireEvent

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

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

参数：

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

返回：

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

This method is defined by Observable.

hasListener

public function hasListener(String eventName)

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

参数：

eventName : String
查询事件之名称

返回：

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

This method is defined by Observable.

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.

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 on a specified interval during the time the element is pressed.

Subscribers will be called with the following parameters:

this : Ext.util.ClickRepeater

This event is defined by ClickRepeater.

mousedown

public event mousedown

Fires when the mouse button is depressed.

Subscribers will be called with the following parameters:

this : Ext.util.ClickRepeater

This event is defined by ClickRepeater.

mouseup

public event mouseup

Fires when the mouse key is released.

Subscribers will be called with the following parameters:

this : Ext.util.ClickRepeater

This event is defined by ClickRepeater.

设置详情

accelerate

accelerate : Boolean

True if autorepeating should start slowly and accelerate. "interval" and "delay" are ignored. "immediate" is honored.

This config option is defined by ClickRepeater.

delay

delay : Number

The initial delay before the repeating event begins firing. Similar to an autorepeat key delay.

This config option is defined by ClickRepeater.

el

el : String/HTMLElement/Element

The element to act as a button.

This config option is defined by ClickRepeater.

interval

interval : Number

The interval between firings of the "click" event. Default 10 ms.

This config option is defined by ClickRepeater.

pressClass

pressClass : String

A CSS class name to be applied to the element while pressed.

This config option is defined by ClickRepeater.

preventDefault

preventDefault : Boolean

True to prevent the default click event

This config option is defined by ClickRepeater.

stopDefault

stopDefault : Boolean

True to stop the default click event

This config option is defined by ClickRepeater.