fop 0.95

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

java.lang.Object
  extended by org.apache.fop.render.afp.modca.AbstractAFPObject
      extended by org.apache.fop.render.afp.modca.AbstractNamedAFPObject
          extended by org.apache.fop.render.afp.modca.IMImageObject

public class IMImageObject
extends AbstractNamedAFPObject

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.AbstractNamedAFPObject
name, nameBytes
 
Fields inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject
log
 
Constructor Summary
IMImageObject(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
 void setImageCellPosition(ImageCellPosition imageCellPosition)
          Sets the ImageCellPosition.
 void setImageInputDescriptor(ImageInputDescriptor imageInputDescriptor)
          Sets the ImageInputDescriptor.
 void setImageOutputControl(ImageOutputControl imageOutputControl)
          Sets the ImageOutputControl.
 void setImageRasterData(ImageRasterData imageRasterData)
          Sets the ImageRastorData.
 void writeDataStream(java.io.OutputStream os)
          Accessor method to write the AFP datastream for the IM Image Objetc
 
Methods inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject
writeObjectList
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IMImageObject

public IMImageObject(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

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

setImageRasterData

public void setImageRasterData(ImageRasterData imageRasterData)
Sets the ImageRastorData.

Parameters:
imageRasterData - The imageRasterData to set

writeDataStream

public void writeDataStream(java.io.OutputStream os)
                     throws java.io.IOException
Accessor method to write the AFP datastream for the IM Image Objetc

Specified by:
writeDataStream in class AbstractAFPObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - thrown if an I/O exception of some sort has occurred

fop 0.95

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.