org.apache.fop.render.afp.modca

Class ObjectEnvironmentGroup


public final class ObjectEnvironmentGroup
extends AbstractNamedAFPObject

An Object Environment Group (OEG) may be associated with an object and is contained within the object's begin-end envelope. The object environment group defines the object's origin and orientation on the page, and can contain font and color attribute table information. The scope of an object environment group is the scope of its containing object. An application that creates a data-stream document may omit some of the parameters normally contained in the object environment group, or it may specify that one or more default values are to be used.

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

ObjectEnvironmentGroup()
Default constructor for the ObjectEnvironmentGroup.
ObjectEnvironmentGroup(String name)
Constructor for the ObjectEnvironmentGroup, this takes a name parameter which must be 8 characters long.

Method Summary

void
setImageData(int xresol, int yresol, int width, int height)
Set the dimensions of the image.
void
setObjectArea(int x, int y, int width, int height, int rotation)
Sets the object area parameters.
void
writeDataStream(OutputStream os)
Accessor method to obtain write the AFP datastream for the object environment group.

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

writeDataStream, writeObjectList

Constructor Details

ObjectEnvironmentGroup

public ObjectEnvironmentGroup()
Default constructor for the ObjectEnvironmentGroup.

ObjectEnvironmentGroup

public ObjectEnvironmentGroup(String name)
Constructor for the ObjectEnvironmentGroup, this takes a name parameter which must be 8 characters long.
Parameters:
name - the object environment group name

Method Details

setImageData

public void setImageData(int xresol,
                         int yresol,
                         int width,
                         int height)
Set the dimensions of the image.
Parameters:
xresol - the x resolution of the image
yresol - the y resolution of the image
width - the image width
height - the image height

setObjectArea

public void setObjectArea(int x,
                          int y,
                          int width,
                          int height,
                          int rotation)
Sets the object area parameters.
Parameters:
x - the x position of the object
y - the y position of the object
width - the object width
height - the object height
rotation - the object orientation

writeDataStream

public void writeDataStream(OutputStream os)
            throws IOException
Accessor method to obtain write the AFP datastream for the object environment group.
Overrides:
writeDataStream in interface AbstractAFPObject
Parameters:
os - The stream to write to

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