VOIVectorEvent (MIPAV API Documentation)

java.lang.Object
- java.util.EventObject
- - gov.nih.mipav.model.structures.event.VOIVectorEvent

All Implemented Interfaces:

java.io.Serializable
```
public class VOIVectorEvent
extends java.util.EventObject
```
An event from a VOIVector. Registers the VOIVector as the event source and, if needed, the VOI that changed within the VOIVector.

Version:

Aug 2002

Author:

David Parsons
$Logfile: /mipav/src/gov/nih/mipav/model/structures/EVENT/VOIVectorEvent.java $ $Revision: 1 $ $Date: 9/04/02 3:20p $

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) VOI`	`mostRecentUpdate`	holds reference because referring to a VOI held by the ViewVOIVector would cause all kinds of memory clean-up concerns. may be null.
`private static long`	`serialVersionUID`	Use serialVersionUID for interoperability.

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor	Description
`VOIVectorEvent(ViewVOIVector eventSource)`	creates an event with no VOI as reference.
`VOIVectorEvent(ViewVOIVector eventSource, VOI changedVOI)`	creates an event using the supplied VOI as reference.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`finalize()`	cleanup.
`boolean`	`getState()`	if the VOIVector were to have state, this would return it. currently returns `true`
`VOI`	`getVOI()`	returns the reference VOI.

Methods inherited from class java.util.EventObject
getSource, toString

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Use serialVersionUID for interoperability.
    
    See Also:
    
    Constant Field Values
  - mostRecentUpdate
```
VOI mostRecentUpdate
```
    holds reference because referring to a VOI held by the ViewVOIVector would cause all kinds of memory clean-up concerns. may be null.
- Constructor Detail
  - VOIVectorEvent
```
public VOIVectorEvent(ViewVOIVector eventSource)
```
    creates an event with no VOI as reference.
    
    Parameters:
    
    eventSource - DOCUMENT ME!
  - VOIVectorEvent
```
public VOIVectorEvent(ViewVOIVector eventSource,
                      VOI changedVOI)
```
    creates an event using the supplied VOI as reference.
    
    Parameters:
    
    eventSource - DOCUMENT ME!
    
    changedVOI - DOCUMENT ME!
- Method Detail
  - finalize
```
public void finalize()
```
    cleanup. Sets the reference VOI to null, to prevent memory errors when the VOI itself is through.
    
    Overrides:
    
    finalize in class java.lang.Object
  - getState
```
public boolean getState()
```
    if the VOIVector were to have state, this would return it. currently returns true
    
    Returns:
    
    DOCUMENT ME!
  - getVOI
```
public VOI getVOI()
```
    returns the reference VOI. May be null
    
    Returns:
    
    DOCUMENT ME!