moxie.core.EventTarget

Important! This page is auto-generated from the comments in the source files. All changes will be overwritten! If you are looking to contribute, modify the comment in the corresponding source file instead.

Module: moxie.core.EventTarget

Table of Contents

• Constructor
• Properties
  • uid
• Methods
  • init()
  • addEventListener(type, fn, [priority=0], [scope=this])
  • hasEventListener([type])
  • removeEventListener(type, [fn])
  • removeAllEventListeners()
  • dispatchEvent(Type, [...])
  • bindOnce(type, fn, [priority=0], [scope=this])

Constructor

EventTarget()

Parent object for all event dispatching components and objects

Properties

uid

Unique id of the event dispatcher, usually overriden by children

Methods

init()

Can be called from within a child in order to acquire uniqie id in automated manner

addEventListener(type, fn, [priority=0], [scope=this])

Register a handler to a specific event dispatched by the object

Arguments

• type String
  Type or basically a name of the event to subscribe to
• fn Function
  Callback function that will be called when event happens
• [priority=0] Number
  Priority of the event handler - handlers with higher priorities will be called first
• [scope=this] Object
  A scope to invoke event handler in

hasEventListener([type])

Check if any handlers were registered to the specified event

Arguments

• [type] String
  Type or basically a name of the event to check

removeEventListener(type, [fn])

Unregister the handler from the event, or if former was not specified - unregister all handlers

Arguments

• type String
  Type or basically a name of the event
• [fn] Function
  Handler to unregister

removeAllEventListeners()

Remove all event handlers from the object

dispatchEvent(Type, [...])

Dispatch the event

Arguments

• Type String/Object
  of event or event object to dispatch
• [...] Mixed
  Variable number of arguments to be passed to a handlers

bindOnce(type, fn, [priority=0], [scope=this])

Register a handler to the event type that will run only once

Arguments

• type String
  Type or basically a name of the event to subscribe to
• fn Function
  Callback function that will be called when event happens
• [priority=0] Number
  Priority of the event handler - handlers with higher priorities will be called first
• [scope=this] Object
  A scope to invoke event handler in