org.pentaho.reporting.engine.classic.core
Interface LocalImageContainer

All Superinterfaces:
Cloneable, ImageContainer
All Known Implementing Classes:
DefaultImageReference

public interface LocalImageContainer
extends ImageContainer

The LocalImageContainer makes the image available as 'java.awt.Image' instance. This way, the image can be included in the local content creation process.

Author:
Thomas Morgner

Method Summary
 Object getIdentity()
          Returns the identity information.
 Image getImage()
          Returns the image instance for this image container.
 String getName()
          Returns the name of this image reference.
 boolean isIdentifiable()
          Checks whether this image has a assigned identity.
 
Methods inherited from interface org.pentaho.reporting.engine.classic.core.ImageContainer
getImageHeight, getImageWidth, getScaleX, getScaleY
 

Method Detail

getImage

Image getImage()
Returns the image instance for this image container. This method might return null, if the image is not available.

Returns:
the image data.

getName

String getName()
Returns the name of this image reference. The name returned should be unique.

Returns:
the name.

isIdentifiable

boolean isIdentifiable()
Checks whether this image has a assigned identity. Two identities should be equal, if the image contents are equal.

Returns:
true, if that image contains contains identity information, false otherwise.

getIdentity

Object getIdentity()
Returns the identity information.

Returns:
the image identifier.