fop 0.95

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

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.IncludeObject

public class IncludeObject
extends AbstractNamedAFPObject

An Include Object structured field references an object on a page or overlay. It optionally contains parameters that identify the object and that specify presentation parameters such as object position, size, orientation, mapping, and default color.

Where the presentation parameters conflict with parameters specified in the object's environment group (OEG), the parameters in the Include Object structured field override. If the referenced object is a page segment, the IOB parameters override the corresponding environment group parameters on all data objects in the page segment.


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
IncludeObject(java.lang.String name)
          Constructor for the include object with the specified name, the name must be a fixed length of eight characters and is the name of the referenced object.
 
Method Summary
 void setOrientation(int orientation)
          Sets the orientation to use for the Include Object.
 void writeDataStream(java.io.OutputStream os)
          Accessor method to write the AFP datastream for the Include Object
 
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

IncludeObject

public IncludeObject(java.lang.String name)
Constructor for the include object with the specified name, the name must be a fixed length of eight characters and is the name of the referenced object.

Parameters:
name - the name of the image
Method Detail

setOrientation

public void setOrientation(int orientation)
Sets the orientation to use for the Include Object.

Parameters:
orientation - The orientation (0,90, 180, 270)

writeDataStream

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

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.