API Documentation for: 1.0.1
Show:

Event Class

Namespace: Canteen\Events

Event is the base class for classes containing event data. This class contains no event data. It is used by events that do not pass state information to an event handler when an event is raised. You can call the method stopPropagation() to abort the execution of further listeners in your event listener.

Constructor

Event

(
  • type
)

Parameters:

  • type String

    The type of this event being dispatched

Methods

isPropagationStopped

() Boolean

Returns whether further event listeners should be triggered.

Returns:

Boolean:

Whether propagation was already stopped for this event.

stopPropagation

()

Stops the propagation of the event to further event listeners.

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

Properties

propagationStopped

Boolean private

Whether no further event listeners should be triggered

type

String

This event's type