View Javadoc

1   /*
2    * ClientInterface.java Created @ Jun 22, 2004
3    * 
4    * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
5    * Delft, the Netherlands. All rights reserved.
6    * 
7    * See for project information <a href="http://www.simulation.tudelft.nl/">
8    * www.simulation.tudelft.nl </a>.
9    * 
10   * The source code and binary code of this software is proprietary information
11   * of Delft University of Technology.
12   */
13  
14  package org.gscg.common.gui;
15  
16  import nl.tudelft.simulation.event.EventProducerInterface;
17  import nl.tudelft.simulation.event.EventType;
18  
19  /***
20   * The client interface serves as a placeholder for several methods each client
21   * graphical user interface should embody. 
22   * <p>
23   * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
24   * Delft, the Netherlands. All rights reserved.
25   * 
26   * See for project information <a href="http://www.simulation.tudelft.nl/">
27   * www.simulation.tudelft.nl </a>.
28   * 
29   * The source code and binary code of this software is proprietary information
30   * of Delft University of Technology.
31   * 
32   * @author <a
33   *         href="http://www.tbm.tudelft.nl/webstaf/stijnh/index.htm">Stijn-Pieter
34   *         van Houten </a>
35   * @version $Revision: 1.1 $ $Date: 2005/06/16 12:34:10 $
36   * @since 1.0.0
37   */
38  public interface ClientInterface extends EventProducerInterface
39  {
40  	/***
41  	 * indicates all the objects which are listening to server side events to
42  	 * unsubscribe
43  	 */
44  	EventType UNSUBSCRIBE_FROM_SERVER_EVENT = new EventType(
45  			"UNSUBSCRIBE_FROM_SERVER_EVENT");
46  
47  	/***
48  	 * the INITIALIZATION_COMPLETED_EVENT is fired when the client is
49  	 * initialized completely
50  	 */
51  	EventType INITIALIZATION_COMPLETED_EVENT = new EventType(
52  			"INITIALIZATION_COMPLETED_EVENT");
53  
54  	/***
55  	 * adds events to a list, these events are send by the client to the server
56  	 * 
57  	 * @param eventType the event to add
58  	 */
59  	void addEventSentByClient(final EventType eventType);
60  
61  	/***
62  	 * The dispose method is called when the frame which is started by client is
63  	 * closed. The method is used to unsubscribe the client server-side
64  	 */
65  	void dispose();
66  }