triana.types

Class TrianaImage

java.lang.Object

triana.types.TrianaType

triana.types.TrianaImage

All Implemented Interfaces:

java.io.Serializable, SequenceInterface

public class TrianaImage
extends TrianaType

TrianaImage is a TrianaType wrapper for the Java image type. It contains a reference to a Java Image object (called image) and implements things which allow it to be a TrianaType. TrianaImage also subclasses JPanel so that the image can be prepared before it is used. Images in Java have to be put on a JComponent before you can find out their actual size. To display a TrianaImage then you just add it to your container and pack it in.

See Also:

Serialized Form

Field Summary

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
TrianaImage() Default constructor.
TrianaImage(java.awt.Image image) Constructor for given image.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyData(TrianaType source) Implement the abstract copyData method of TrianaType.
TrianaType	copyMe() This is one of the most important methods of Triana data.
java.awt.Image	getImage()
java.awt.Dimension	getImageDimensions()
javax.swing.JComponent	getImageObs()
void	readObject(java.io.ObjectInputStream in) Uses the default writer to input and create an object from the Object input stream.
void	setImage(java.awt.Image image) Put an image into the current object.
void	writeObject(java.io.ObjectOutputStream out) Uses the default writer to output this object to the given Object output stream.

Methods inherited from class triana.types.TrianaType

containerSize, copyParameters, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber, updateObsoletePointers

Methods inherited from class java.lang.Object

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

Constructor Detail

TrianaImage

public TrianaImage()

Default constructor.

TrianaImage

public TrianaImage(java.awt.Image image)

Constructor for given image.

Parameters:

image - The image to be held in the new TrianaImage

Method Detail

setImage

public void setImage(java.awt.Image image)

Put an image into the current object.

Parameters:

image - The image to be placed into this object

getImage

public java.awt.Image getImage()

Returns:

the Java Image which this TrianaImage represents

getImageObs

public javax.swing.JComponent getImageObs()

Returns:

the Image observer for this TrianaImage

getImageDimensions

public java.awt.Dimension getImageDimensions()

Returns:

the dimensions of the image

copyMe

public TrianaType copyMe()

This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.

To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:

 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 

The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.

Specified by:

copyMe in class TrianaType

Returns:

TrianaType Copy by value of the current Object except for an updated description

copyData

protected void copyData(TrianaType source)

Implement the abstract copyData method of TrianaType. This copies an image from the given object to the present one. (There is no need to over-ride method copyParameters here, since there are no variable parameters in this class.)

Overrides:

copyData in class TrianaType

Parameters:

source - The TrianaImage whose image is being copied

writeObject

public void writeObject(java.io.ObjectOutputStream out)
                 throws java.io.IOException

Uses the default writer to output this object to the given Object output stream.

Parameters:

out - The stream to write to

Throws:

java.io.IOException

readObject

public void readObject(java.io.ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException

Uses the default writer to input and create an object from the Object input stream.

Parameters:

in - The stream to createTool from

Throws:

java.io.IOException

java.lang.ClassNotFoundException