org.cesiumjs.cs.core

Class Event<T>

java.lang.Object

org.cesiumjs.cs.core.Event<T>

@JsType(isNative=true,
        namespace="Cesium",
        name="Event")
public class Event<T>
extends Object

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Event.Listener Universal callback listener, supports array params
static interface	Event.RemoveCallback A function that removes a listener.

Constructor Summary

Constructors

Constructor and Description
Event() A generic utility class for managing subscribers for a particular event.

Method Summary

Modifier and Type	Method and Description
Event.RemoveCallback	addEventListener(T listener) Registers a callback function to be executed whenever the event is raised.
Event.RemoveCallback	addEventListener(T listener, Object scope) Registers a callback function to be executed whenever the event is raised.
int	numberOfListeners()
boolean	removeEventListener(T listener) Unregisters a previously registered callback.
boolean	removeEventListener(T listener, Object scope) Unregisters a previously registered callback.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Event

@JsConstructor
public Event()

A generic utility class for managing subscribers for a particular event. This class is usually instantiated inside of a container class and exposed as a property for others to subscribe to.

Method Detail

numberOfListeners

@JsProperty(name="numberOfListeners")
public int numberOfListeners()

addEventListener

@JsMethod
public Event.RemoveCallback addEventListener(T listener)

Registers a callback function to be executed whenever the event is raised. An optional scope can be provided to serve as the this pointer in which the function will execute.

Parameters:

listener - The function to be executed when the event is raised.

Returns:

A function that will remove this event listener when invoked.

addEventListener

@JsMethod
public Event.RemoveCallback addEventListener(T listener,
                                                       Object scope)

Registers a callback function to be executed whenever the event is raised. An optional scope can be provided to serve as the this pointer in which the function will execute.

Parameters:

listener - The function to be executed when the event is raised.

scope - An optional object scope to serve as the this pointer in which the listener function will execute.

Returns:

A function that will remove this event listener when invoked.

removeEventListener

@JsMethod
public boolean removeEventListener(T listener)

Unregisters a previously registered callback.

Parameters:

listener - he function to be unregistered.

Returns:

true if the listener was removed; false if the listener and scope are not registered with the event.

removeEventListener

@JsMethod
public boolean removeEventListener(T listener,
                                             Object scope)

Unregisters a previously registered callback.

Parameters:

listener - he function to be unregistered.

scope - The scope that was originally passed to addEventListener.

Returns:

true if the listener was removed; false if the listener and scope are not registered with the event.