org.apache.fop.render.afp.modca
Class IncludePageSegment
java.lang.Object
org.apache.fop.render.afp.modca.AbstractAFPObject
org.apache.fop.render.afp.modca.AbstractNamedAFPObject
org.apache.fop.render.afp.modca.IncludePageSegment
public class IncludePageSegment
- extends AbstractNamedAFPObject
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.
Constructor Summary |
IncludePageSegment(java.lang.String name,
int x,
int y)
Constructor for the Include Page Segment |
Method Summary |
void |
writeDataStream(java.io.OutputStream os)
Accessor method to write the AFP datastream for the Include Page Segment |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
IncludePageSegment
public IncludePageSegment(java.lang.String name,
int x,
int y)
- Constructor for the Include Page Segment
- Parameters:
name
- Name of the page segmentx
- The x positiony
- The y position
writeDataStream
public void writeDataStream(java.io.OutputStream os)
throws java.io.IOException
- Accessor method to write the AFP datastream for the Include Page Segment
- 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
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.