org.apache.fop.afp.modca
Class IncludePageOverlay
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.IncludePageOverlay
- All Implemented Interfaces:
- Streamable
public class IncludePageOverlay
- extends AbstractNamedAFPObject
The Include Page Overlay structured field references an overlay resource
definition that is to be positioned on the page. A page overlay can be
referenced at any time during the page state, but not during an object state.
The overlay contains its own active environment group definition.
Note: There is no need for the triplets, so I have ignored them.
A real example of where this will be used is for static overlays, such as an
address on the page.
Constructor Summary |
IncludePageOverlay(java.lang.String overlayName,
int x,
int y,
int orientation)
Constructor for the Include Page Overlay |
Method Summary |
void |
setOrientation(int orientation)
Sets the orientation to use for the overlay. |
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 |
IncludePageOverlay
public IncludePageOverlay(java.lang.String overlayName,
int x,
int y,
int orientation)
- Constructor for the Include Page Overlay
- Parameters:
overlayName
- Name of the page segmentx
- The x positiony
- The y positionorientation
- The orientation
setOrientation
public void setOrientation(int orientation)
- Sets the orientation to use for the overlay.
- Parameters:
orientation
- The orientation (0,90, 180, 270)
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.