Overview Package Class Use Tree Index Deprecated About
fop 0.94
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.fop.render.afp.modca

Class 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

IncludePageOverlay(String overlayName, int x, int y, int orientation)
Constructor for the Include Page Overlay

Method Summary

void
setOrientation(int orientation)
Sets the orienation to use for the overlay.
void
writeDataStream(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

writeDataStream, writeObjectList

Constructor Details

IncludePageOverlay

public IncludePageOverlay(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 Details

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(OutputStream os)
            throws IOException
Accessor method to write the AFP datastream for the Include Page Overlay
Overrides:
writeDataStream in interface AbstractAFPObject
Parameters:
os - The stream to write to

Overview Package Class Use Tree Index Deprecated About
fop 0.94
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.