com.SIMRacingApps

Class SIMPluginAWTEventDispatcher

java.lang.Object

com.SIMRacingApps.SIMPluginAWTEventDispatcher

public class SIMPluginAWTEventDispatcher
extends java.lang.Object

This class is used by a Java AWT application to send data events to registered listeners. It uses a singleton pattern to create and manage the connection to the SIM. The main routine must call createDispatcher() before anything else is done to establish the singleton instance for the specific SIM. Then others may access the dispatcher using the getDispatcher() method to register listeners for the events. Then, the startThread() method must be called to start the thread that sends the events to the listeners.

For example:

  //create a SIMPlugin to the SIM and pass it to the createDispatcher().
  SIMPluginAWTEventDispatcher.createDispatcher(
      SIMPlugin.createSIMPlugin(m_SIM)
  );
          
  //process SIMPlugin arguments.
  SIMPluginAWTEventDispatcher.getDispatcher().getSIMPlugin().setPlay(m_play);
          
  //initialize your application, register all the listeners
  m_geardata = new JDataLabel("Car/REFERENCE/Gauge/Gear/ValueCurrent");
  m_geardata.addPropertyChangeListener("data",
      new PropertyChangeListener() {
          public void propertyChange(PropertyChangeEvent evt) {
              Data d = (Data) evt.getNewValue();
              // normally you would do some fancy formatting that the
              // setFormat() method cannot handle.
              m_geardata.setText("[" + d.getString() + "]");
          }
      });
  widgetPanel.add(m_geardata);
          
  //start the dispatcher thread running to place data into the event queue
  SIMPluginAWTEventDispatcher.getDispatcher().startThread();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SIMPluginAWTEventDispatcher.SIMPluginAWTEventsException Any exceptions are caught and wrapped in this exception.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Since I cannot listen unless you give me the name, this method throws an exception.
void	addPropertyChangeListener(java.lang.String name, java.beans.PropertyChangeListener listener) Registers a listener to receive events for the named SIM value.
static SIMPluginAWTEventDispatcher	createDispatcher(SIMPlugin SIMPlugin) A static factory method that creates the dispatcher instance and returns it.
static SIMPluginAWTEventDispatcher	getDispatcher() Returns the dispatcher singleton.
SIMPlugin	getSIMPlugin() Returns the SIMPlugin.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Since I cannot listen unless you give me the name, this method throws an exception.
void	removePropertyChangeListener(java.lang.String name, java.beans.PropertyChangeListener listener) Removes a listener that was already registered to receive events for the named SIM value.
void	startThread()
void	startThread(SIMPlugin.Callback callback) Starts the dispatcher thread.

Methods inherited from class java.lang.Object

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

Method Detail

createDispatcher

public static SIMPluginAWTEventDispatcher createDispatcher(SIMPlugin SIMPlugin)

A static factory method that creates the dispatcher instance and returns it. This must be called first so the other methods have access to the singleton.

Parameters:

SIMPlugin - The SIMPlugin.

Returns:

A reference to the dispatcher singleton.

getDispatcher

public static SIMPluginAWTEventDispatcher getDispatcher()

Returns the dispatcher singleton. Can return null if createDispatcher() has not been called.

Returns:

A reference to the dispatcher singleton.

getSIMPlugin

public SIMPlugin getSIMPlugin()

Returns the SIMPlugin. Can return null if the createDipatcher() method has not been called.

Returns:

The SIMPlugin.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
                               throws SIMPluginAWTEventDispatcher.SIMPluginAWTEventsException

Since I cannot listen unless you give me the name, this method throws an exception. I will leave these here for Bean editors that don't recognize the named ones.

Parameters:

listener - The listener to receive the events.

Throws:

SIMPluginAWTEventDispatcher.SIMPluginAWTEventsException - A fatal exception.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
                                  throws SIMPluginAWTEventDispatcher.SIMPluginAWTEventsException

Since I cannot listen unless you give me the name, this method throws an exception. I will leave these here for Bean editors that don't recognize the named ones.

Parameters:

listener - The listener to receive the events.

Throws:

SIMPluginAWTEventDispatcher.SIMPluginAWTEventsException - A fatal exception.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String name,
                                      java.beans.PropertyChangeListener listener)

Registers a listener to receive events for the named SIM value.

Parameters:

name - The name of the value.

listener - The listener to receive the events.

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String name,
                                         java.beans.PropertyChangeListener listener)

Removes a listener that was already registered to receive events for the named SIM value.

Parameters:

name - The name of the value.

listener - The listener to receive the events.

startThread

public void startThread(SIMPlugin.Callback callback)

Starts the dispatcher thread. This should be called from the main thread after all your listeners are registered, and only once. It starts a background thread and then returns.

Parameters:

callback - (Optional) A callback implementation to receive events.

startThread

public void startThread()