Interface EventDispatcherInterface

The EventDispatcherInterface interface is the 3djuump Infinite API implementation of the observer pattern, very similar to the DOM event system of javascript.

Objects implementing this interface can install/remove listeners to be notified when some events fire with the use of the addEventListener and removeEventListener functions.

/** 
 * Sample to illustrate how to use the 3djuump Infinite signal system.
 */
import { FilterItemInterface, FilterItemInterfaceSignal } from 'generated_files/documentation/appinfiniteapi';

// filter has been created previously
let lFilter : FilterItemInterface;

// we want to be notified when events occur
const lCallbackId : string = lFilter.addEventListener(FilterItemInterfaceSignal.FilterChanged, (_event: any, _pObject: Object | undefined) =>
{
    // output a fancy message when filter changes
    console.log('filter has changed');
    // and remove the listener
    lFilter.removeEventListenerById(lCallbackId);
});

The syntax is very close to the DOM addEventlistener functions.
Events

interface EventDispatcherInterface {
    addEventListener(pType, pListener, pObject): string;
    addEventListener(pType, pListener): string;
    areSignalsBlocked(): boolean;
    blockSignals(pBlock): void;
    hasEventListener(pType, pListener): boolean;
    hasEventListenerById(pId): boolean;
    removeAllEventListeners(): boolean;
    removeEventListener(pType, pListener, pObject): boolean;
    removeEventListener(pType, pListener): boolean;
    removeEventListenerById(pId): boolean;
}

Hierarchy (view full)

Methods

addEventListener areSignalsBlocked blockSignals hasEventListener hasEventListenerById removeAllEventListeners removeEventListener removeEventListenerById

Methods

addEventListener

  • addEventListener(pType, pListener, pObject): string

  • Adds a listener to an event type.

    When an event of the type pType fires, the callback pListener will be called. This function returns a unique string id that may be used in removeEventListenerById to allow simple listener removal. It is possible to add an object that will be included in the callback to avoid creating too many closures. Calling twice addEventListener with the same parameters results in the second call to be ignored, only unique pairs callback / object are allowed, in order to avoid calling multiple times the same thing.

    Parameters

    • pType: string
      in
      The type of the event pListener will be called upon.
    • pListener: tListenerCallback
      in
      The listener function that fires when the given event type occurs.
    • pObject: Object
      in
      The optional object the callback will be called with when the given event fires.

    Returns string

    The id of the inserted callback (actually an UUID).

  • addEventListener(pType, pListener): string

  • Adds a listener to an event type.

    When an event of the type pType fires, the callback pListener will be called. This function returns a unique string id that may be used in removeEventListenerById to allow simple listener removal.

    Parameters

    • pType: string
      in
      The type of the event pListener will be called upon.
    • pListener: tListenerCallback
      in
      The listener function that fires when the given event type occurs.

    Returns string

    The id of the inserted callback (actually an UUID).

areSignalsBlocked

  • areSignalsBlocked(): boolean

  • Tells if signals sent by the object are blocked or not.

    If signals are blocked, no signal will be emitted nor buffered, such signal will be lost.

    Returns boolean

    true if signals are blocked.

blockSignals

  • blockSignals(pBlock): void

  • Blocks / Unblocks all signals sent by the object.

    If signals are blocked, no signal will be emitted nor buffered, such signal will be lost.

    Parameters

    • pBlock: boolean
      in
      If set to true, all further signals will be silently discarded.

    Returns void

hasEventListener

  • hasEventListener(pType, pListener): boolean

  • Tells if the EventDispatcher has such a callback registered for the given event type.

    Parameters

    • pType: string
      in
      The type of the event to test.
    • pListener: tListenerCallback
      in
      The listener function that gets tested.

    Returns boolean

    true if such a listener is installed for the given type of event.

hasEventListenerById

  • hasEventListenerById(pId): boolean

  • Tells if the EventDispatcher has such a callback registered for the given callback id.

    Parameters

    • pId: string
      in
      The id of the callback to test.

    Returns boolean

    true if such a listener is installed for the given callback id.

removeAllEventListeners

  • removeAllEventListeners(): boolean

  • Removes all the event listeners.

    Returns boolean

    true if all the callbacks were removed else false.

removeEventListener

  • removeEventListener(pType, pListener, pObject): boolean

  • Removes a listener from an event type.

    If no such listener is found, then the function returns false and does nothing. You must use the exact parameters that were used in addEventListener to actually remove the listener.

    Parameters

    • pType: string
      in
      The type of the listener that gets removed.
    • pListener: tListenerCallback

      The listener function that gets removed.

    • pObject: Object

      The listener object that was used when addEventListener was called.

    Returns boolean

    true if the callback was removed else false.

  • removeEventListener(pType, pListener): boolean

  • Removes a listener from an event type.

    If no such listener is found, then the function returns false and does nothing. You must use the exact parameters that were used in addEventListener to actually remove the listener.

    Parameters

    • pType: string
      in
      The type of the listener that gets removed.
    • pListener: tListenerCallback

      The listener function that gets removed.

    Returns boolean

    true if the callback was removed else false.

removeEventListenerById

  • removeEventListenerById(pId): boolean

  • Removes a listener by its id.

    If no such listener is found, then the function returns false and does nothing. You must use the return value of addEventListener to actually remove the listener.

    Parameters

    • pId: string
      in
      The id returned by the call to addEventListener that you want to remove.

    Returns boolean

    true if the callback was removed else false.

Settings

Member Visibility

Theme

On This Page

addEventListenerareSignalsBlockedblockSignalshasEventListenerhasEventListenerByIdremoveAllEventListenersremoveEventListenerremoveEventListenerById