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

java.lang.Object
  org.apache.fop.render.afp.modca.AFPObject
      org.apache.fop.render.afp.modca.IncludeObject

public class IncludeObject

extends AFPObject

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

LOGGER

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

byte[]	getDataStream() DataStream objects must implement the getDataStream() method to return a byte array of the AFP datastream.
void	setOrientation(int orientation) Sets the orienation to use for the Include Object.

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 orienation to use for the Include Object.

Parameters:

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

getDataStream

public byte[] getDataStream()

Description copied from class: AFPObject

DataStream objects must implement the getDataStream() method to return a byte array of the AFP datastream.

Specified by:

getDataStream in class AFPObject

Returns:

byte[] The AFP data stream