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

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

public class IncludePageSegment

extends AFPObject

The Include Page Segment structured field references a page segment resource object that is to be presented on the page or overlay presentation space. The IPS specifies a reference point on the including page or overlay coordinate system that may be used to position objects contained in the page segment. A page segment can be referenced at any time during page or overlay state, but not during an object state. The page segment inherits the active environment group definition of the including page or overlay. Note : No use for Triplets. A 'real' example for where this will be used is for the dynamic placing of overlay objects, such as signatures that may have to be placed at different positions on a document.

Field Summary

Fields inherited from class org.apache.fop.render.afp.modca.AFPObject

LOGGER

Constructor Summary

IncludePageSegment(java.lang.String name, int xVal, int yVal)

Method Summary

byte[]

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IncludePageSegment

public IncludePageSegment(java.lang.String name,
                          int xVal,
                          int yVal)

Method Detail

getDataStream

public byte[] getDataStream()
                     throws java.io.IOException

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

Throws:

java.io.IOException