Constructor Detail

• AbstractEventEmitter

  AbstractEventEmitter()

Method Detail

• getListeners

   final Map<EventType, List<Function<Object>>> getListeners()

• on

   AbstractEventEmitter<EventType> on(EventType event, Function0<Object> handler)

  Bind an event listener to fire when an event occurs.

  Parameters:

  event -

  • the event type you'd like to listen to. Can be a string or symbol.

  handler -

  • the function to be called when the event occurs.

• on

   <T extends Any> AbstractEventEmitter<EventType> on(EventType event, Function1<T, Object> handler)

  Bind an event listener to fire when an event occurs.

  Parameters:

  event -

  • the event type you'd like to listen to. Can be a string or symbol.

  handler -

  • the function to be called when the event occurs.

• on

   <T extends Any, T2 extends Any> AbstractEventEmitter<EventType> on(EventType event, Function2<T, T2, Object> handler)

  Bind an event listener to fire when an event occurs.

  Parameters:

  event -

  • the event type you'd like to listen to. Can be a string or symbol.

  handler -

  • the function to be called when the event occurs.

• on

   <T extends Any, T2 extends Any, T3 extends Any> AbstractEventEmitter<EventType> on(EventType event, Function3<T, T2, T3, Object> handler)

  Bind an event listener to fire when an event occurs.

  Parameters:

  event -

  • the event type you'd like to listen to. Can be a string or symbol.

  handler -

  • the function to be called when the event occurs.

• on1

   AbstractEventEmitter<EventType> on1(EventType event, SuspendFunction0<Object> handler)

• on1

   <T extends Any> AbstractEventEmitter<EventType> on1(EventType event, SuspendFunction1<T, Object> handler)

• on1

   <T extends Any, T2 extends Any> AbstractEventEmitter<EventType> on1(EventType event, SuspendFunction2<T, T2, Object> handler)

• on1

   <T extends Any, T2 extends Any, T3 extends Any> AbstractEventEmitter<EventType> on1(EventType event, SuspendFunction3<T, T2, T3, Object> handler)

• emit

   List<Object> emit(EventType event)

  Emit an event and call any associated listeners.

  Parameters:

  event -

  • the event you'd like to emit

• emit

   <T extends Any> List<Object> emit(EventType event, T param)

  Emit an event and call any associated listeners.

  Parameters:

  event -

  • the event you'd like to emit

  param -

  • any data you'd like to emit with the event

• emit

   <T extends Any, T2 extends Any> List<Object> emit(EventType event, T param, T2 param2)

  Emit an event and call any associated listeners.

  Parameters:

  event -

  • the event you'd like to emit

  param -

  • any data you'd like to emit with the event

• emit

   <T extends Any, T2 extends Any, T3 extends Any> List<Object> emit(EventType event, T param, T2 param2, T3 param3)

  Emit an event and call any associated listeners.

  Parameters:

  event -

  • the event you'd like to emit

  param -

  • any data you'd like to emit with the event

• emit1

   List<Object> emit1(EventType event)

  TODO: easy to misuse, especially when we emit a non-suspend event in a suspend function

  In the following example, emit1 is misused, should be emit suspend fun navigateTo(entry: NavigateEntry) { browser.emit1(BrowserEvents.willNavigate, entry) navigateHistory.add(entry) }

• emit1

   <T extends Any> List<Object> emit1(EventType event, T param)

• emit1

   <T extends Any, T2 extends Any> List<Object> emit1(EventType event, T param, T2 param2)

• emit1

   <T extends Any, T2 extends Any, T3 extends Any> List<Object> emit1(EventType event, T param, T2 param2, T3 param3)

• off

   AbstractEventEmitter<EventType> off(EventType event)

  Removes all listeners. If given an event argument, it will remove only listeners for that event.

  Parameters:

  event -

  • the event to remove listeners for.

• off

   <T extends Any> AbstractEventEmitter<EventType> off(EventType event, Function0<Object> handler)

  Remove an event listener from firing.

  Parameters:

  event -

  • the event type you'd like to stop listening to.

  handler -

  • the function that should be removed.

• off

   <T extends Any> AbstractEventEmitter<EventType> off(EventType event, Function1<T, Object> handler)

  Remove an event listener from firing.

  Parameters:

  event -

  • the event type you'd like to stop listening to.

  handler -

  • the function that should be removed.

• off

   <T extends Any, T2 extends Any> AbstractEventEmitter<EventType> off(EventType event, Function2<T, T2, Object> handler)

  Remove an event listener from firing.

  Parameters:

  event -

  • the event type you'd like to stop listening to.

  handler -

  • the function that should be removed.

• off

   <T extends Any, T2 extends Any, T3 extends Any> AbstractEventEmitter<EventType> off(EventType event, Function3<T, T2, T3, Object> handler)

  Remove an event listener from firing.

  Parameters:

  event -

  • the event type you'd like to stop listening to.

  handler -

  • the function that should be removed.

• off1

   AbstractEventEmitter<EventType> off1(EventType event)

• off1

   <T extends Any> AbstractEventEmitter<EventType> off1(EventType event, SuspendFunction0<Object> handler)

• off1

   <T extends Any> AbstractEventEmitter<EventType> off1(EventType event, SuspendFunction1<T, Object> handler)

• off1

   <T extends Any, T2 extends Any> AbstractEventEmitter<EventType> off1(EventType event, SuspendFunction2<T, T2, Object> handler)

• off1

   <T extends Any, T2 extends Any, T3 extends Any> AbstractEventEmitter<EventType> off1(EventType event, SuspendFunction3<T, T2, T3, Object> handler)

• once

   <T extends Any> AbstractEventEmitter<EventType> once(EventType event, Function1<T, Object> handler, T param)

  Like on but the listener will only be fired once and then it will be removed.

  Parameters:

  event -

  • the event you'd like to listen to

  handler -

  • the handler function to run when the event occurs

• once

   <T extends Any, T2 extends Any> AbstractEventEmitter<EventType> once(EventType event, Function2<T, T2, Object> handler, T param, T2 param2)

  Like on but the listener will only be fired once and then it will be removed.

  Parameters:

  event -

  • the event you'd like to listen to

  handler -

  • the handler function to run when the event occurs

• once

   <T extends Any, T2 extends Any, T3 extends Any> AbstractEventEmitter<EventType> once(EventType event, Function3<T, T2, T3, Object> handler, T param, T2 param2, T3 param3)

  Like on but the listener will only be fired once, and then it will be removed.

  Parameters:

  event -

  • the event you'd like to listen to

  handler -

  • the handler function to run when the event occurs

• once1

   <T extends Any> AbstractEventEmitter<EventType> once1(EventType event, SuspendFunction1<T, Object> handler, T param)

• once1

   <T extends Any, T2 extends Any> AbstractEventEmitter<EventType> once1(EventType event, SuspendFunction2<T, T2, Object> handler, T param, T2 param2)

• once1

   <T extends Any, T2 extends Any, T3 extends Any> AbstractEventEmitter<EventType> once1(EventType event, SuspendFunction3<T, T2, T3, Object> handler, T param, T2 param2, T3 param3)

• hasListeners

   Boolean hasListeners(EventType event)

  Check if the given event listener is registered

• listeners

   List<Function<Object>> listeners()

  Get a list of the registered event listeners

• listeners

   List<Function<Object>> listeners(EventType event)

  Get a list of the registered event listeners with the given type

• count

   Integer count(EventType event)

  Gets the number of listeners for a given event.

  Parameters:

  event -

  • the event to get the listener count for