fop 0.95

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

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.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(java.lang.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, int widthResolution, int heightResolution)
          Sets the object area parameters.
 void writeDataStream(java.io.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
writeObjectList
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ObjectEnvironmentGroup

public ObjectEnvironmentGroup()
Default constructor for the ObjectEnvironmentGroup.


ObjectEnvironmentGroup

public ObjectEnvironmentGroup(java.lang.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 Detail

setObjectArea

public void setObjectArea(int x,
                          int y,
                          int width,
                          int height,
                          int rotation,
                          int widthResolution,
                          int heightResolution)
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
widthResolution - the object resolution width
heightResolution - the object resolution height

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

writeDataStream

public void writeDataStream(java.io.OutputStream os)
                     throws java.io.IOException
Accessor method to obtain write the AFP datastream for the object environment group.

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

fop 0.95

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