org.apache.fop.render.afp.modca

Class IncludePageOverlay

java.lang.Object

org.apache.fop.render.afp.modca.AbstractAFPObject

org.apache.fop.render.afp.modca.AbstractNamedAFPObject

org.apache.fop.render.afp.modca.IncludePageOverlay

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.

Field Summary

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

name, nameBytes

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

log

Constructor Summary

Constructors

Constructor and Description
IncludePageOverlay(java.lang.String overlayName, int x, int y, int orientation) Constructor for the Include Page Overlay

Method Summary

Methods

Modifier and Type	Method and Description
void	setOrientation(int orientation) Sets the orienation to use for the overlay.
void	writeDataStream(java.io.OutputStream os) Accessor method to write the AFP datastream for the Include Page Overlay

Methods inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject

writeObjectList

Methods inherited from class java.lang.Object

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

Constructor Detail

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 segment

x - The x position

y - The y position

orientation - The orientation

Method Detail

setOrientation

public void setOrientation(int orientation)

Sets the orienation to use for the overlay.

Parameters:

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

writeDataStream

public void writeDataStream(java.io.OutputStream os)
                     throws java.io.IOException

Accessor method to write the AFP datastream for the Include Page Overlay

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