app.spa
Enum EventId

java.lang.Object
  extended by java.lang.Enum<EventId>
      extended by app.spa.EventId
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EventId>

public enum EventId
extends java.lang.Enum<EventId>

An enumeration containing all the event ids handled by the SiGMLPlayerApplet's event dispatch thread. These event ids are partitioned into the four categories defined in the EventCategory enumeration.


Enum Constant Summary
AVATAR_LOAD_FAILED
           
AVATAR_LOADED_OK
           
AVATAR_UNLOADED
           
HALT
           
LOAD_AVATAR
           
LOAD_FRAMES_DONE_BAD
           
LOAD_FRAMES_DONE_OK
           
LOAD_FRAMES_START
           
LOADED_NEXT_SIGN
           
PLAY_DONE
           
PLAY_FIRST_FRAME_OF_SIGN
           
PLAY_FRAME
           
PLAY_SIGML_TEXT
           
PLAY_SIGML_URL
           
RESUME_IF_PLAYING
           
SET_SPEED_UP
           
SHUT_DOWN
           
SKIP_FIRST_FRAME_OF_SIGN
           
SKIP_FRAME
           
STOP_PLAY_SIGML
           
SUSPEND_IF_PLAYING
           
 
Method Summary
 boolean isAnimationEvent()
          Tests whether this is an animation event.
 boolean isAvatarEvent()
          Tests whether this is an avatar event.
 boolean isFramesGenEvent()
          Tests whether this is a frames generation event.
 boolean isIn(java.util.EnumSet<EventId> eids)
          Tests whether this event is in the given set.
 boolean isUIEvent()
          Tests whether this is a HTML/LiveConnect UI generated event.
static void main(java.lang.String[] args)
           
static java.util.EnumSet<EventId> spaEventIds(EventId e0, EventId e1)
          Returns a set containing the given pair of SPA event ids.
static java.util.EnumSet<EventId> spaEventIds(EventId s0, EventId s1, EventId s2)
          Returns a set containing the given trio of SPA event ids.
static EventId valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static EventId[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

HALT

public static final EventId HALT

SHUT_DOWN

public static final EventId SHUT_DOWN

LOAD_AVATAR

public static final EventId LOAD_AVATAR

PLAY_SIGML_URL

public static final EventId PLAY_SIGML_URL

PLAY_SIGML_TEXT

public static final EventId PLAY_SIGML_TEXT

STOP_PLAY_SIGML

public static final EventId STOP_PLAY_SIGML

SET_SPEED_UP

public static final EventId SET_SPEED_UP

SUSPEND_IF_PLAYING

public static final EventId SUSPEND_IF_PLAYING

RESUME_IF_PLAYING

public static final EventId RESUME_IF_PLAYING

AVATAR_LOADED_OK

public static final EventId AVATAR_LOADED_OK

AVATAR_LOAD_FAILED

public static final EventId AVATAR_LOAD_FAILED

AVATAR_UNLOADED

public static final EventId AVATAR_UNLOADED

LOAD_FRAMES_START

public static final EventId LOAD_FRAMES_START

LOADED_NEXT_SIGN

public static final EventId LOADED_NEXT_SIGN

LOAD_FRAMES_DONE_OK

public static final EventId LOAD_FRAMES_DONE_OK

LOAD_FRAMES_DONE_BAD

public static final EventId LOAD_FRAMES_DONE_BAD

PLAY_FRAME

public static final EventId PLAY_FRAME

SKIP_FRAME

public static final EventId SKIP_FRAME

PLAY_FIRST_FRAME_OF_SIGN

public static final EventId PLAY_FIRST_FRAME_OF_SIGN

SKIP_FIRST_FRAME_OF_SIGN

public static final EventId SKIP_FIRST_FRAME_OF_SIGN

PLAY_DONE

public static final EventId PLAY_DONE
Method Detail

values

public static final EventId[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(EventId c : EventId.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static EventId valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

main

public static void main(java.lang.String[] args)

isUIEvent

public final boolean isUIEvent()
Tests whether this is a HTML/LiveConnect UI generated event.


isAvatarEvent

public final boolean isAvatarEvent()
Tests whether this is an avatar event.


isFramesGenEvent

public final boolean isFramesGenEvent()
Tests whether this is a frames generation event.


isAnimationEvent

public final boolean isAnimationEvent()
Tests whether this is an animation event.


isIn

public final boolean isIn(java.util.EnumSet<EventId> eids)
Tests whether this event is in the given set.


spaEventIds

public static final java.util.EnumSet<EventId> spaEventIds(EventId e0,
                                                           EventId e1)
Returns a set containing the given pair of SPA event ids.


spaEventIds

public static final java.util.EnumSet<EventId> spaEventIds(EventId s0,
                                                           EventId s1,
                                                           EventId s2)
Returns a set containing the given trio of SPA event ids.