src/org/vamsas/client/Events.java

   1 package org.vamsas.client;
   2 /**
   3  * Enumerates the event types generated
   4  * during the lifecycle of a Vamsas session.
   5  */
   6
   7 public class Events {
   8   /**
   9    * Generated when a client has finished updating the document.
  10    * Passes applicationHandle of client so the updating client can recognise its own updates.
  11    */
  12   public static final String DOCUMENT_UPDATE="org.vamsas.client.events.documentUpdateEvent";
  13   /**
  14    * Generated when a new vamsas document is created
  15    * so an application may do its own data space initialization
  16    */
  17   public static final String DOCUMENT_CREATE="org.vamsas.client.events.documentCreateEvent";
  18   /**
  19    * Generated when a new vamsas client is attached to a session (Handle is passed)
  20    * Note: the newly created client does not receive the event.
  21    */
  22   public static final String CLIENT_CREATION="org.vamsas.client.events.clientCreateEvent";
  23   /**
  24    * Generated when a vamsas client leaves a session (Handle is passed).
  25    */
  26   public static final String CLIENT_FINALIZATION="org.vamsas.client.events.clientFinalizationEvent";
  27   /**
  28    * Generated prior to session Shutdown, after the last participating vamsas client has finalized.
  29    */
  30   public static final String SESSION_SHUTDOWN="org.vamsas.client.events.SessionShutdownEvent";
  31   /**
  32    * Generated by Vorba stub after the penultimate client makes a call to closeDocument().
  33    * Sequence is as follows :
  34    *    1. All other vamsas clients have called closeDocument()
  35    *    2. Final living client monitors closures, and realises that it is last.
  36    *    3. Final client generates event to prompt associated application to inquire if
  37    *       the user wishes to save the document for future reference.
  38    *
  39    * *  Any call to closeDocument in a thread other than the registered EventListener
  40    *    will block until the RequestToClose handler has exited.
  41    *
  42    */
  43   public static final String DOCUMENT_REQUESTTOCLOSE="org.vamas.client.DocumentRequestToCloseEvent";
  44   public static java.util.Vector EventList = initList();
  45   private static java.util.Vector initList() {
  46     java.util.Vector vec = new java.util.Vector();
  47     vec.add((Object) DOCUMENT_UPDATE);
  48     vec.add((Object) DOCUMENT_CREATE);
  49     vec.add((Object) CLIENT_CREATION);
  50     vec.add((Object) CLIENT_FINALIZATION);
  51     vec.add((Object) SESSION_SHUTDOWN);
  52     vec.add((Object) DOCUMENT_REQUESTTOCLOSE);
  53     return vec;
  54   }
  55 }