org.apache.fop.render.afp.modca

Class 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(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(OutputStream os)
Accessor method to write the AFP datastream for the Include Object

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

writeDataStream, writeObjectList

Constructor Details

IncludeObject

public IncludeObject(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 Details

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(OutputStream os)
            throws IOException
Accessor method to write the AFP datastream for the Include Object
Overrides:
writeDataStream in interface AbstractAFPObject
Parameters:
os - The stream to write to

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