Home Reference Source
import CustomEvent from 'gs-events/src/CustomEvent.js'
public class | since 1.0.9 | source

CustomEvent

Extends:

Event → CustomEvent

定义携带自定义数据的事件对象。

See:

Constructor Summary

Public Constructor
public

constructor(type: String | Symbol, data: any, bubbles: Boolean, cancelable: Boolean)

创建一个支持自定义数据的事件对象。

since 1.0.9

Member Summary

Public Members
public get

data: any

获取事件对象的自定义数据。

since 1.0.9

Method Summary

Public Methods
public

reset(type: String | Symbol, data: any, bubbles: Boolean, cancelable: Boolean): this

重置事件状态(允许外部复用事件对象)。

since 1.0.11

Inherited Summary

From class Event
public get

指示该事件是否参与冒泡行为。

since 1.0.0
public get

指示该事件是否可以取消默认行为。

since 1.0.0
public get

获取事件的当前对象。

since 1.0.0
public get

指示该事件是否已经取消了默认行为。

since 1.0.0
public get

获取事件的当前阶段。

since 1.0.0
public get

获取事件的目标对象。

since 1.0.0
public get

获取事件类型。

since 1.0.0
public

如果事件可以取消(cancelable == true)默认行为,则取消该事件的默认行为。

since 1.0.0
public

reset(type: String | Symbol, bubbles: Boolean, cancelable: Boolean): this

重置事件状态(允许外部复用事件对象)。

since 1.0.11
public

立即停止事件冒泡,当前节点以及后续所有节点的侦听器都将不会收到该事件通知。

since 1.0.0
public

停止事件冒泡,后续所有节点的侦听器都将不会收到该事件通知。

since 1.0.0

Public Constructors

public constructor(type: String | Symbol, data: any, bubbles: Boolean, cancelable: Boolean) since 1.0.9 source

创建一个支持自定义数据的事件对象。

Override:

Event#constructor

Params:

NameTypeAttributeDescription
type String | Symbol

事件类型。

data any
  • optional
  • default: null

指定附加到事件对象的数据。

bubbles Boolean
  • optional
  • default: false

指示该事件是否参与冒泡行为。

cancelable Boolean
  • optional
  • default: true

指示该事件是否可以取消默认行为。

Public Members

public get data: any since 1.0.9 source

获取事件对象的自定义数据。

Public Methods

public reset(type: String | Symbol, data: any, bubbles: Boolean, cancelable: Boolean): this since 1.0.11 source

重置事件状态(允许外部复用事件对象)。

Override:

Event#reset

Params:

NameTypeAttributeDescription
type String | Symbol

事件类型。

data any
  • optional
  • default: null

指定附加到事件对象的数据。

bubbles Boolean
  • optional
  • default: false

指示该事件是否参与冒泡行为。

cancelable Boolean
  • optional
  • default: true

指示该事件是否可以取消默认行为。

Return:

this