Class: EventManager

olympe.ui.events. EventManager

Super class for event managers


new EventManager(uiProxy)

Creates an instance of EventManager.

Parameters:
Name Type Description
uiProxy olympe.uiapi.UIElement

Extends

  • olympe.ui.UIElement

Methods


<protected> offEvent(id, callbackList)

Removes a specific callback from a callback list.

Parameters:
Name Type Description
id string | olympe.df.Proxy.<string>

ID of the callback to remove

callbackList olympe.ui.events.EventCallbackList

callback list


<protected> onEvent(callback, id, priority, callbackList, offFunction)

Creates an EventCallback and add to a list of callbacks, inserting it according to its priority.

Parameters:
Name Type Description
callback function

the function to associate to the callback

id string | undefined

ID for this new callback

priority number | undefined

Priority for the new callback.

callbackList olympe.ui.events.EventCallbackList

the list to add this callback to

offFunction function

Function to execute when the context is destroyed

Returns:

Id ID of the created callback

Type
string

<protected> registerOnEvent(event, eventsList)

Registers a list of callbacks to an Event.

Parameters:
Name Type Description
event olympe.df.Proxy.<olympe.ui.events.Event> | olympe.ui.events.Event
eventsList olympe.ui.events.EventCallbackList