org.apache.fop.render.afp.modca

Class ImageSegment

java.lang.Object

org.apache.fop.render.afp.modca.AbstractAFPObject

org.apache.fop.render.afp.modca.ImageSegment

public class ImageSegment
extends AbstractAFPObject

An Image Segment is represented by a set of self-defining fields, fields that describe their own contents. It starts with a Begin Segment, and ends with an End Segment. Between the Begin Segment and End Segment is the image information to be processed, called the Image Content. Only one Image Content can exist within a single IOCA Image Segment.

Field Summary

Fields inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject

log

Constructor Summary

Constructors

Constructor and Description
ImageSegment() Default constructor for the ImageSegment.
ImageSegment(java.lang.String name) Constructor for the image segment with the specified name, the name must be a fixed length of eight characters.

Method Summary

Methods

Modifier and Type	Method and Description
void	setImageCompression(byte compression) Sets the image compression.
void	setImageData(byte[] data) Set the data of the image.
void	setImageEncoding(byte encoding) Sets the image encoding.
void	setImageIDEColorModel(byte colorModel) Sets the image IDE color model.
void	setImageIDESize(byte size) Sets the image IDE size.
void	setImageSize(int hresol, int vresol, int hsize, int vsize) Sets the image size parameters resolution, hsize and vsize.
void	writeDataStream(java.io.OutputStream os) Accessor method to write the AFP datastream for the Image Segment

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

ImageSegment

public ImageSegment()

Default constructor for the ImageSegment.

ImageSegment

public ImageSegment(java.lang.String name)

Constructor for the image segment with the specified name, the name must be a fixed length of eight characters.

Parameters:

name - The name of the image.

Method Detail

setImageSize

public void setImageSize(int hresol,
                int vresol,
                int hsize,
                int vsize)

Sets the image size parameters resolution, hsize and vsize.

Parameters:

hresol - The horizontal resolution of the image.

vresol - The vertical resolution of the image.

hsize - The horizontal size of the image.

vsize - The vertival size of the image.

setImageEncoding

public void setImageEncoding(byte encoding)

Sets the image encoding.

Parameters:

encoding - The image encoding.

setImageCompression

public void setImageCompression(byte compression)

Sets the image compression.

Parameters:

compression - The image compression.

setImageIDESize

public void setImageIDESize(byte size)

Sets the image IDE size.

Parameters:

size - The IDE size.

setImageIDEColorModel

public void setImageIDEColorModel(byte colorModel)

Sets the image IDE color model.

Parameters:

colorModel - the IDE color model.

setImageData

public void setImageData(byte[] data)

Set the data of the image.

Parameters:

data - the image data

writeDataStream

public void writeDataStream(java.io.OutputStream os)
                     throws java.io.IOException

Accessor method to write the AFP datastream for the Image Segment

Specified by:

writeDataStream in class AbstractAFPObject

Parameters:

os - The stream to write to

Throws:

java.io.IOException - if an I/O exception occurred