org.apache.fop.render.afp.modca
Class ImageObject

java.lang.Object
  extended byorg.apache.fop.render.afp.modca.AFPObject
      extended byorg.apache.fop.render.afp.modca.ImageObject

public class ImageObject
extends AFPObject

An IM image data object specifies the contents of a raster image and its placement on a page, overlay, or page segment. An IM image can be either simple or complex. A simple image is composed of one or more Image Raster Data (IRD) structured fields that define the raster pattern for the entire image. A complex image is divided into regions called image cells. Each image cell is composed of one or more IRD structured fields that define the raster pattern for the image cell, and one Image Cell Position (ICP) structured field that defines the position of the image cell relative to the origin of the entire image. Each ICP also specifies the size of the image cell and a fill rectangle into which the cell is replicated.


Field Summary
 
Fields inherited from class org.apache.fop.render.afp.modca.AFPObject
LOGGER
 
Constructor Summary
ImageObject(java.lang.String name)
          Constructor for the image object with the specified name, the name must be a fixed length of eight characters.
 
Method Summary
 byte[] getDataStream()
          DataStream objects must implement the getDataStream() method to return a byte array of the AFP datastream.
 void setImageCellPosition(ImageCellPosition imageCellPosition)
          Sets the ImageCellPosition.
 void setImageInputDescriptor(ImageInputDescriptor imageInputDescriptor)
          Sets the ImageInputDescriptor.
 void setImageOutputControl(ImageOutputControl imageOutputControl)
          Sets the ImageOutputControl.
 void setImageRastorData(ImageRasterData imageRastorData)
          Sets the ImageRastorData.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageObject

public ImageObject(java.lang.String name)
Constructor for the image object with the specified name, the name must be a fixed length of eight characters.

Parameters:
name - The name of the image.
Method Detail

getDataStream

public byte[] getDataStream()
                     throws java.io.IOException
Description copied from class: AFPObject
DataStream objects must implement the getDataStream() method to return a byte array of the AFP datastream.

Specified by:
getDataStream in class AFPObject
Returns:
byte[] The AFP data stream
Throws:
java.io.IOException

setImageOutputControl

public void setImageOutputControl(ImageOutputControl imageOutputControl)
Sets the ImageOutputControl.

Parameters:
imageOutputControl - The imageOutputControl to set

setImageCellPosition

public void setImageCellPosition(ImageCellPosition imageCellPosition)
Sets the ImageCellPosition.

Parameters:
imageCellPosition - The imageCellPosition to set

setImageInputDescriptor

public void setImageInputDescriptor(ImageInputDescriptor imageInputDescriptor)
Sets the ImageInputDescriptor.

Parameters:
imageInputDescriptor - The imageInputDescriptor to set

setImageRastorData

public void setImageRastorData(ImageRasterData imageRastorData)
Sets the ImageRastorData.

Parameters:
imageRastorData - The imageRastorData to set