com.dukescript.api.events

Class EventSource<S>

java.lang.Object

com.dukescript.api.events.EventSource<S>

public abstract class EventSource<S>
extends Object

EventSource is your entry point to DukeScript Events. Simply create a new one using the create factory method passing in the id of the HTML-element you'd like to receive events from and an arbitrary object, which can then be used as the source of the events. A typical use case would be to use with the canvas API:

 
 GraphicsContext2D ctx = GraphicsContext2D.getOrCreate("canvas");
 EventSource es = EventSource.create(ctx, "canvas");
 es.addEventHandler(MouseEvent.MOUSE_PRESSED, new EventHandler<MouseEvent>() {
    @Override
   public void handle(MouseEvent event) {
     GraphicsContext2D g2d = (GraphicsContext2D) event.getSource();
     g2d.setFillStyle(ctx.getWebColor("orange"));
     g2d.fillCircle((float) event.getX(), (float) event.getY(), 10);
   }
 });
 
 

Then add your EventHandlers there and receive Events.

Author:

antonepple

Constructor Summary

Constructors

Constructor and Description
EventSource()

Method Summary

Modifier and Type	Method and Description
abstract <T extends Event> void	addEventHandler(Event.Type<T> type, EventHandler<T> handler) Add an EventHandler to this EventSource to receive Events of the specified type.
static <S> EventSource	create(S source, String id) Create a new EventSource for the HTML Element identified by the id and pass an object, which will be used as the source in any Event.
static <S> EventSource	create(S source, String id, boolean documentFiresKeyEvents) Create a new EventSource for the HTML Element identified by the id and pass an object, which will be used as the source in any Event.
abstract <T extends Event> void	removeEventHandler(Event.Type<T> type, EventHandler<T> handler) Remove the EventHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSource

public EventSource()

Method Detail

addEventHandler

public abstract <T extends Event> void addEventHandler(Event.Type<T> type,
                                                       EventHandler<T> handler)

Add an EventHandler to this EventSource to receive Events of the specified type.

Type Parameters:

T - The event class this type applies to.

Parameters:

type - The Type of Event you're interested in, e.g. MouseEvent.MOUSE_CLICKED.

handler - The EventHandler which should receive the event.

removeEventHandler

public abstract <T extends Event> void removeEventHandler(Event.Type<T> type,
                                                          EventHandler<T> handler)

Remove the EventHandler

Type Parameters:

T - The event class this type applies to.

Parameters:

type - The Type of Event you want to remove it from listening to.

handler - The handler you want to remove.

create

public static <S> EventSource create(S source,
                                     String id)

Create a new EventSource for the HTML Element identified by the id and pass an object, which will be used as the source in any Event. Typically the source is an object that represents the element, like a GraphicsContext in case of a Canvas.

Type Parameters:

S - The type of the source object that will be used when dispatching events.

Parameters:

source - The object that will be the source in all events from this EventSource.

id - The id of the HTML-Element you want to receive events from.

Returns:

a new EventSource.

create

public static <S> EventSource create(S source,
                                     String id,
                                     boolean documentFiresKeyEvents)

Create a new EventSource for the HTML Element identified by the id and pass an object, which will be used as the source in any Event. Typically the source is an object that represents the element, like a GraphicsContext in case of a Canvas. The parameter documentFiresKeyEvents allows you to get all keyevents even if your Element doesn't have the focus. This is a typical behaviour for games.

Type Parameters:

S - The type of the source object that will be used when dispatching events.

Parameters:

source - The object that will be the source in all events from this EventSource.

id - The id of the HTML-Element you want to receive events from.

documentFiresKeyEvents - if true document fires keyevents instead of element

Returns:

a new EventSource.