com.objex.panywhere
Class ImageEvent

java.lang.Object
  java.util.EventObject
      com.objex.panywhere.ImageEvent

All Implemented Interfaces:

java.io.Serializable

public class ImageEvent
extends java.util.EventObject

An event which is generated every time an image of the Pedigree is requested through method getImage(BufferedImage[] bi) and is generated. Interested classes must register to receive these events using the Pedigree Instance's addImageListener() method.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ImageEvent(java.lang.Object source, java.awt.image.BufferedImage bimage)
Creates a new instance of ImageEvent.

Method Summary

java.awt.image.BufferedImage

getImage()

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageEvent

public ImageEvent(java.lang.Object source,
                  java.awt.image.BufferedImage bimage)

Creates a new instance of ImageEvent.

Parameters:

source - Pedigree instance from which the imageEvent was generated

bimage - The image for which this event was generated. This value will be null if event is generated at the beggining of the image generation and may remain so until such time as the image has been fully generated by the pedigree and is fully available

Method Detail

getImage

public java.awt.image.BufferedImage getImage()

Returns:

The image that was just generated with this event. Null is returned if the image generation failed for any reason or if the method is invoked from an event object generated at the beginning of the image generation before the image becomes available.