org.apache.fop.afp.modca
Class IncludePageSegment
java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
org.apache.fop.afp.modca.AbstractNamedAFPObject
org.apache.fop.afp.modca.IncludePageSegment
- All Implemented Interfaces:
- Streamable
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 |
writeToStream(java.io.OutputStream os)
DataStream objects must implement the writeToStream()
method to write its data to the given OutputStream |
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject |
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setObjectClassification, writeTriplets |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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
writeToStream
public void writeToStream(java.io.OutputStream os)
throws java.io.IOException
- DataStream objects must implement the writeToStream()
method to write its data to the given OutputStream
- Specified by:
writeToStream
in interface Streamable
- Overrides:
writeToStream
in class AbstractStructuredObject
- Parameters:
os
- the outputsteam stream
- Throws:
java.io.IOException
- an I/O exception of some sort has occurred.
Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.