Package org.apache.fop.afp.modca
Class IMImageObject
- java.lang.Object
-
- All Implemented Interfaces:
Streamable
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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
-
Field Summary
-
Fields inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
name
-
Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
triplets
-
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
-
Constructor Summary
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.protected void
writeContent(java.io.OutputStream os)
Helper method to write the contents of the Object.protected void
writeEnd(java.io.OutputStream os)
Helper method to write the end of the Object.protected void
writeStart(java.io.OutputStream os)
Helper method to write the start of the Object.-
Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName, toString
-
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets
-
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeToStream
-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
-
-
-
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
-
writeContent
protected void writeContent(java.io.OutputStream os) throws java.io.IOException
Helper method to write the contents of the Object.- Overrides:
writeContent
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
- throws an I/O exception if one occurred
-
writeStart
protected void writeStart(java.io.OutputStream os) throws java.io.IOException
Helper method to write the start of the Object.- Overrides:
writeStart
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
- throws an I/O exception if one occurred
-
writeEnd
protected void writeEnd(java.io.OutputStream os) throws java.io.IOException
Helper method to write the end of the Object.- Overrides:
writeEnd
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
- an I/O exception if one occurred
-
-