io.datafx.eventsystem

? EventSystem

java.lang.Object

io.datafx.eventsystem.EventSystem

public final class EventSystem
extends java.lang.Object

The DataFX Event System. The event system is defined as a singleton and therefore you can only have one instance in an application. You can get the event system by calling getInstance(). The event system can be used to send events to other parts of the application an decouple a big app by doing so. Events can be send synchron (on the JavaFX Application Thread) or asynchron (on a background thread). Each event will contain content (any Java object) as data for the receiver. When sending an event an adress must be specified. Several receiver can be registered for an adress. In this case all receivers will get the event.

????

??????	?????
void	addBroadcastReceiver(java.util.function.Consumer<Event> receiver, io.datafx.core.concurrent.ThreadType type) Registers a receiver for all broadcast events.
void	addReceiver(java.lang.String address, java.util.function.Consumer<Event> receiver, io.datafx.core.concurrent.ThreadType type) Registers a receiver for all events that will be send to the given adress.
static EventSystem	getInstance() Returns the event system instance.
void	removeBroadcastReceiver(java.util.function.Consumer<Event> receiver) Deregisters the receiver
void	removeReceiver(java.lang.String address, java.util.function.Consumer<Event> receiver) Deregisters the receiver for the given adress.
<T> javafx.concurrent.Worker<java.lang.Void>	send(java.lang.String address, T content) Send an event to all receivers that are registered for the given address.
<T> javafx.concurrent.Worker<java.lang.Void>	sendBroadcast(T content) Send a broadcast event to all receivers that are registered to receive broadcast events.
<T> javafx.concurrent.Worker<java.lang.Void>	sendBroadcastEvent(Event<T> event) Send a broadcast event to all receivers that are registered to receive broadcast events.
<T> javafx.concurrent.Worker<java.lang.Void>	sendEvent(java.lang.String address, Event<T> event) Send an event to all receivers that are registered for the given address.

??????? java.lang.Object

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

??????

getInstance

public static EventSystem getInstance()

Returns the event system instance. The event system is defined as singleton and therefor this will always return the same instance.

??:

the event system instance

send

public <T> javafx.concurrent.Worker<java.lang.Void> send(java.lang.String address,
                                                         T content)

Send an event to all receivers that are registered for the given address. The event will contain the given content of type T

????:

T - content type

??:

address - The adress

content - the content

??:

a worker that will be finished once the event was sent to all receivers.

sendEvent

public <T> javafx.concurrent.Worker<java.lang.Void> sendEvent(java.lang.String address,
                                                              Event<T> event)

Send an event to all receivers that are registered for the given address.

????:

T - content type

??:

address - The adress

event - the event

??:

a worker that will be finished once the event was sent to all receivers.

sendBroadcast

public <T> javafx.concurrent.Worker<java.lang.Void> sendBroadcast(T content)

Send a broadcast event to all receivers that are registered to receive broadcast events. This are all receivers that are registered for the adress "" see send(String, Object)

????:

T - content type

??:

content - the content

??:

a worker that will be finished once the event was sent to all receivers.

sendBroadcastEvent

public <T> javafx.concurrent.Worker<java.lang.Void> sendBroadcastEvent(Event<T> event)

Send a broadcast event to all receivers that are registered to receive broadcast events. This are all receivers that are registered for the adress "" see sendBroadcast(Object)

????:

T - the content type

??:

event - the event

??:

a worker that will be finished once the event was sent to all receivers.

addReceiver

public void addReceiver(java.lang.String address,
                        java.util.function.Consumer<Event> receiver,
                        io.datafx.core.concurrent.ThreadType type)

Registers a receiver for all events that will be send to the given adress. The receiver can get the events on the JavaFX application thread or on a background thread.

??:

address - the adress

receiver - the receiver

type - defines if the receiver will get the events on the JavaFX application thread or on a background thread.

addBroadcastReceiver

public void addBroadcastReceiver(java.util.function.Consumer<Event> receiver,
                                 io.datafx.core.concurrent.ThreadType type)

Registers a receiver for all broadcast events. The receiver can get the events on the JavaFX application thread or on a background thread.

??:

receiver - the receiver

type - defines if the receiver will get the events on the JavaFX application thread or on a background thread.

removeReceiver

public void removeReceiver(java.lang.String address,
                           java.util.function.Consumer<Event> receiver)

Deregisters the receiver for the given adress.

??:

address - the adress

receiver - the receiver

removeBroadcastReceiver

public void removeBroadcastReceiver(java.util.function.Consumer<Event> receiver)

Deregisters the receiver

??:

receiver - the receiver