FlashCommunicationServer Class Reference

List of all members.

Public Member Functions

 FlashCommunicationServer ()
 Allows us to send messages to the Flash GUI.
 FlashCommunicationServer (int port)
void addFlashClientListener (FlashListener flashListener)
void exitServer ()
void handleCommand (int clientID, String command)
void openFlashGUI (File flashGUIFile)
 Currently, we assume the next client connection is for THIS flash GUI.
void openFlashApolloGUI (File apolloGUIFile)
 Point it to the Apollo exe that will serve as your GUI.
void removeAllFlashClientListeners ()
void sendMessage (String msg)

Static Public Attributes

static final int DEFAULT_PORT = Constants.Ports.FLASH_COMMUNICATION_SERVER
 communicate through this port

Detailed Description

A messaging server that will relay information objects to one or more Flash GUIs, which will listen for them. It's a two way pipe, so the Flash GUIs can also send messages back!

This is an early implementation. Later on, we may allow our event handlers to live in the world of Flash, for faster UI prototyping.

This software is distributed under the BSD License.

Author:
Ron B Yeh (ronyeh(AT)cs.stanford.edu)

Definition at line 33 of file FlashCommunicationServer.java.


Constructor & Destructor Documentation

FlashCommunicationServer ( int  port  ) 

Parameters:
port 

Definition at line 74 of file FlashCommunicationServer.java.


Member Function Documentation

void addFlashClientListener ( FlashListener  flashListener  ) 

Parameters:
flashListener 

Definition at line 83 of file FlashCommunicationServer.java.

Referenced by FlashWhiteboard.load(), InkAPIBrowser.showFlashView(), DebuggingEnvironment.showFlashView(), and ToolExplorer.ToolExplorer().

void handleCommand ( int  clientID,
String  command 
)

Parameters:
clientID 
command 

Definition at line 143 of file FlashCommunicationServer.java.

Referenced by FlashClient.FlashClient().

void openFlashApolloGUI ( File  apolloGUIFile  ) 

Point it to the Apollo exe that will serve as your GUI.

Parameters:
apolloGUIFile 

Definition at line 174 of file FlashCommunicationServer.java.

Referenced by ToolExplorer.ToolExplorer().

void openFlashGUI ( File  flashGUIFile  ) 

Currently, we assume the next client connection is for THIS flash GUI.

=) We'll hopefully be able to use this information later.

Parameters:
flashGUIFile Or perhaps this should be a URL in the future, as the GUI can live online? Launches the flash GUI in a browser.

Definition at line 159 of file FlashCommunicationServer.java.

Referenced by InkAPIBrowser.showFlashView(), and DebuggingEnvironment.showFlashView().

void sendMessage ( String  msg  ) 

Parameters:
msg 

Definition at line 191 of file FlashCommunicationServer.java.

Referenced by FlashWhiteboard.addPen(), FlashWhiteboard.load(), InkAPIBrowser.saveInkFromCurrentFileToDiskAndDisplayIt(), and DebuggingEnvironment.visualize().


The documentation for this class was generated from the following file:
Generated on Sat Apr 14 18:21:41 2007 for R3 Paper Toolkit by  doxygen 1.4.7