Event.EventCustom Class

Extends Event

Module: cc

The Custom event

Index

Properties

• detail Object A reference to the detailed data of the event
• keyCode Number The keyCode read-only property represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key. </br> This is usually the decimal ASCII (RFC 20) or Windows 1252 code corresponding to the key.</br> If the key can't be identified, this value is 0.</br>
• type String The name of the event (case-sensitive), e.g. "click", "fire", or "submit".
• bubbles Boolean Indicate whether the event bubbles up through the tree or not.
• target Object A reference to the target to which the event was originally dispatched.
• currentTarget Object A reference to the currently registered target for the event.
• eventPhase Number Indicates which phase of the event flow is currently being evaluated. Returns an integer value represented by 4 constants:
  • Event.NONE = 0
  • Event.CAPTURING_PHASE = 1
  • Event.AT_TARGET = 2
  • Event.BUBBLING_PHASE = 3 The phases are explained in the [section 3.1, Event dispatch and DOM event flow] (http://www.w3.org/TR/DOM-Level-3-Events/#event-flow), of the DOM Level 3 Events specification.

Methods

• constructor
• setUserData Sets user data
• getUserData Gets user data
• getEventName Gets event name
• unuse Reset the event for being stored in the object pool.
• reuse Reuse the event for being used again by the object pool.
• stopPropagation Stops propagation for current event.
• stopPropagationImmediate Stops propagation for current event immediately, the event won't even be dispatched to the listeners attached in the current target.
• isStopped Checks whether the event has been stopped.
• getCurrentTarget

  Gets current target of the event
  note: It only be available when the event listener is associated with node.
  

   It returns 0 when the listener is associated with fixed priority.
  

  </p>

• getType Gets the event type.

Details

Properties

detail

A reference to the detailed data of the event

keyCode

The keyCode read-only property represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key. </br> This is usually the decimal ASCII (RFC 20) or Windows 1252 code corresponding to the key.</br> If the key can't be identified, this value is 0.</br>

type

The name of the event (case-sensitive), e.g. "click", "fire", or "submit".

bubbles

Indicate whether the event bubbles up through the tree or not.

target

A reference to the target to which the event was originally dispatched.

currentTarget

A reference to the currently registered target for the event.

eventPhase

Indicates which phase of the event flow is currently being evaluated. Returns an integer value represented by 4 constants:

• Event.NONE = 0
• Event.CAPTURING_PHASE = 1
• Event.AT_TARGET = 2
• Event.BUBBLING_PHASE = 3 The phases are explained in the [section 3.1, Event dispatch and DOM event flow] (http://www.w3.org/TR/DOM-Level-3-Events/#event-flow), of the DOM Level 3 Events specification.

Methods

constructor

Parameters

• type String The name of the event (case-sensitive), e.g. "click", "fire", or "submit"
• bubbles Boolean A boolean indicating whether the event bubbles up through the tree or not

setUserData

Sets user data

Parameters

• data Any

getUserData

Gets user data

getEventName

Gets event name

unuse

Reset the event for being stored in the object pool.

reuse

Reuse the event for being used again by the object pool.

stopPropagation

Stops propagation for current event.

stopPropagationImmediate

Stops propagation for current event immediately, the event won't even be dispatched to the listeners attached in the current target.

isStopped

Checks whether the event has been stopped.

getCurrentTarget

Gets current target of the event
note: It only be available when the event listener is associated with node.
It returns 0 when the listener is associated with fixed priority.

getType

Gets the event type.