edu.brook.ascape.model
Class ScapeEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--edu.brook.ascape.model.ScapeEvent

public class ScapeEvent

extends java.util.EventObject

An event describing some change in scape state.

Since:

1.0

Version:

1.5

See Also:

Serialized Form

Field Summary

static int	REPORT_ITERATE The scape has been updated (iterated.)
static int	REPORT_START The scape has been initialized and started.
static int	REPORT_STOP The scape has stopped.
static int	REQUEST_CLOSE The scape is quitting, and requests the view to finish its business and destroy itself.
static int	REQUEST_SETUP The scape is in a pre-initialization state, and can be modified freely.
static int	TICK A 'tick' event gerated while a scape is paused.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ScapeEvent(java.lang.Object source, int id)
Constructs a control event, used to control a scape.

Method Summary

int	getID() Gets the id decribing the control event.
java.lang.String	paramString() Returns a paramter string describing this event.
java.lang.String	toString() Reutrns a descriptive string for this event in the form for .

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REQUEST_SETUP

public static final int REQUEST_SETUP

The scape is in a pre-initialization state, and can be modified freely. Warning; the internal state of the scape is not consistent at this point; this event should only be used by objects which set scape state, not by objects that attempt to use it.

REQUEST_CLOSE

public static final int REQUEST_CLOSE

The scape is quitting, and requests the view to finish its business and destroy itself.

REPORT_START

public static final int REPORT_START

The scape has been initialized and started.

REPORT_STOP

public static final int REPORT_STOP

The scape has stopped.

REPORT_ITERATE

public static final int REPORT_ITERATE

The scape has been updated (iterated.)

TICK

public static final int TICK

A 'tick' event gerated while a scape is paused.

Constructor Detail

ScapeEvent

public ScapeEvent(java.lang.Object source,
                  int id)

Constructs a control event, used to control a scape.

Parameters:

source - the object firing this alert event.

Method Detail

getID

public int getID()

Gets the id decribing the control event.

paramString

public java.lang.String paramString()

Returns a paramter string describing this event.

toString

public java.lang.String toString()

Reutrns a descriptive string for this event in the form for .

Overrides:

toString in class java.util.EventObject