edu.sdsc.mbt.viewables
Class StructureDocumentEvent

java.lang.Object
  edu.sdsc.mbt.viewables.StructureDocumentEvent

All Implemented Interfaces:

java.io.Serializable

public class StructureDocumentEvent

extends java.lang.Object

implements java.io.Serializable

An event generated when structural changes are made to a StructureDocument. This event class is used when Viewer or Structure objects are added or removed from a StructureDocument. But, this event type is NOT used when the internal state of any of those objects change (see the StructureEvent, StructureMapEvent, and StructureStyleEvent classes).

Example:
When a Viewer is added to a StructureDocument, the event sent to the Viewer is: type=TYPE_VIEWER, change=CHANGE_ADDED
and the Viewer object should use the structureDocument reference to process/display each Structure object in the document.

Example:
When a Structure is removed from a StructureDocument, the event sent to the Viewer is: type=TYPE_STRUCTURE, change=CHANGE_REMOVED
and the Viewer object should remove all viewable objects associated with the Structure from its display.

Author:

John L. Moreland

See Also:

StructureDocument, Viewer,

, Serialized Form

Field Summary

int	change The kind of change that occured in the StructureDocument.
static int	CHANGE_ADDED Objects were added.
static int	CHANGE_RELOAD
static int	CHANGE_REMOVED Objects were removed.
static int	CHANGE_RENAMED
Entry	entry The Structure object that was effected in the StructureDocument.
StructureDocument	structureDocument The StructureDocument object for which the state changed (once a Viewer is added to a StructureDocument this value shouldn't change since each Viewer instance only views one document at a time).
int	type The type of object that was added/removed in the StructureDocument.
static int	TYPE_DATA A Structure object was added/removed in the StructureDocument.
static int	TYPE_GLOBAL
static int	TYPE_VIEWER A Viewer object was added/removed in the StructureDocument.
Viewer	viewer The Viewer object that was effected in the StructureDocument.

Constructor Summary

StructureDocumentEvent()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

structureDocument

public StructureDocument structureDocument

The StructureDocument object for which the state changed (once a Viewer is added to a StructureDocument this value shouldn't change since each Viewer instance only views one document at a time).

entry

public Entry entry

The Structure object that was effected in the StructureDocument. (for a TYPE_VIEWER add/remove event, this may be null since a Viewer should examine ALL structures in a StructureDocument).

viewer

public Viewer viewer

The Viewer object that was effected in the StructureDocument.

type

public int type

The type of object that was added/removed in the StructureDocument.

TYPE_VIEWER

public static final int TYPE_VIEWER

A Viewer object was added/removed in the StructureDocument.

See Also:

Constant Field Values

TYPE_DATA

public static final int TYPE_DATA

A Structure object was added/removed in the StructureDocument.

See Also:

Constant Field Values

TYPE_GLOBAL

public static final int TYPE_GLOBAL

See Also:

Constant Field Values

change

public int change

The kind of change that occured in the StructureDocument.

CHANGE_ADDED

public static final int CHANGE_ADDED

Objects were added.

See Also:

Constant Field Values

CHANGE_REMOVED

public static final int CHANGE_REMOVED

Objects were removed.

See Also:

Constant Field Values

CHANGE_RENAMED

public static final int CHANGE_RENAMED

See Also:

Constant Field Values

CHANGE_RELOAD

public static final int CHANGE_RELOAD

See Also:

Constant Field Values

Constructor Detail

StructureDocumentEvent

public StructureDocumentEvent()