Package | laya.events |
Class | public class EventDispatcher |
Inheritance | EventDispatcher Object |
Subclasses | Accelerator, AnimationPlayer, AnimationTransform3D, BaseRender, Component3D, GeometryFilter, Gyroscope, HttpRequest, Loader, LoaderManager, Node, Shake, Socket, Sound, SoundChannel, Texture, TimeLine, Transform3D, TransformUV |
EventDispatcher
类是可调度事件的所有类的基类。
Method | Defined By | ||
---|---|---|---|
event(type:String, data:* = null):Boolean
派发事件。
| EventDispatcher | ||
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
| EventDispatcher | ||
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
| EventDispatcher | ||
off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
| EventDispatcher | ||
offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
| EventDispatcher | ||
on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知。
| EventDispatcher | ||
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知,此侦听事件响应一次后自动移除。
| EventDispatcher |
event | () | method |
public function event(type:String, data:* = null):Boolean
派发事件。
Parameters
type:String — 事件类型。
| |
data:* (default = null ) — (可选)回调数据。注意:如果是需要传递多个参数 p1,p2,p3,...可以使用数组结构如:[p1,p2,p3,...] ;如果需要回调单个参数 p ,且 p 是一个数组,则需要使用结构如:[p],其他的单个参数 p ,可以直接传入参数 p。
|
Boolean — 此事件类型是否有侦听者,如果有侦听者则值为 true,否则值为 false。
|
hasListener | () | method |
public function hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
Parameters
type:String — 事件的类型。
|
Boolean — 如果指定类型的侦听器已注册,则值为 true;否则,值为 false。
|
isMouseEvent | () | method |
public function isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
Parameters
type:String — 事件的类型。
|
Boolean — 如果是鼠标事件,则值为 true;否则,值为 false。
|
off | () | method |
public function off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
Parameters
type:String — 事件的类型。
| |
caller:* — 事件侦听函数的执行域。
| |
listener:Function — 事件侦听函数。
| |
onceOnly:Boolean (default = false ) — (可选)如果值为 true ,则只移除通过 once 方法添加的侦听器。
|
EventDispatcher — 此 EventDispatcher 对象。
|
offAll | () | method |
public function offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
Parameters
type:String (default = null ) — (可选)事件类型,如果值为 null,则移除本对象所有类型的侦听器。
|
EventDispatcher — 此 EventDispatcher 对象。
|
on | () | method |
public function on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知。
Parameters
type:String — 事件的类型。
| |
caller:* — 事件侦听函数的执行域。
| |
listener:Function — 事件侦听函数。
| |
args:Array (default = null ) — (可选)事件侦听函数的回调参数。
|
EventDispatcher — 此 EventDispatcher 对象。
|
once | () | method |
public function once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知,此侦听事件响应一次后自动移除。
Parameters
type:String — 事件的类型。
| |
caller:* — 事件侦听函数的执行域。
| |
listener:Function — 事件侦听函数。
| |
args:Array (default = null ) — (可选)事件侦听函数的回调参数。
|
EventDispatcher — 此 EventDispatcher 对象。
|