org.apache.fop.render.afp.modca
Class PageObject
java.lang.Object
org.apache.fop.render.afp.modca.AbstractAFPObject
org.apache.fop.render.afp.modca.AbstractNamedAFPObject
org.apache.fop.render.afp.modca.AbstractPageObject
org.apache.fop.render.afp.modca.PageObject
public class PageObject
- extends AbstractPageObject
Pages contain the data objects that comprise a presentation document. Each
page has a set of data objects associated with it. Each page within a
document is independent from any other page, and each must establish its own
environment parameters.
The page is the level in the document component hierarchy that is used for
printing or displaying a document's content. The data objects contained in
the page envelope in the data stream are presented when the page is
presented. Each data object has layout information associated with it that
directs the placement and orientation of the data on the page. In addition,
each page contains layout information that specifies the measurement units,
page width, and page depth.
A page is initiated by a begin page structured field and terminated by an end
page structured field. Structured fields that define objects and active
environment groups or that specify attributes of the page may be encountered
in page state.
Constructor Summary |
PageObject(java.lang.String name,
int width,
int height,
int rotation,
int widthResolution,
int heightResolution)
Construct a new page object for the specified name argument, the page
name should be an 8 character identifier. |
Method Summary |
void |
addOverlay(Overlay overlay)
Adds an overlay to the page resources |
void |
createIncludePageOverlay(java.lang.String name,
int x,
int y,
int orientation)
Creates an IncludePageOverlay on the page. |
void |
writeDataStream(java.io.OutputStream os)
Accessor method to write the AFP datastream for the page. |
Methods inherited from class org.apache.fop.render.afp.modca.AbstractPageObject |
createFont, createIncludePageSegment, createLine, createNoOperation, createShading, createTagLogicalElement, createText, endPage, getActiveEnvironmentGroup, getHeight, getImageObject, getRotation, getWidth, isComplete |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PageObject
public PageObject(java.lang.String name,
int width,
int height,
int rotation,
int widthResolution,
int heightResolution)
- Construct a new page object for the specified name argument, the page
name should be an 8 character identifier.
- Parameters:
name
- the name of the page.width
- the width of the page.height
- the height of the page.rotation
- the rotation of the page.widthResolution
- the width resolution of the page.heightResolution
- the height resolution of the page.
addOverlay
public void addOverlay(Overlay overlay)
- Adds an overlay to the page resources
- Parameters:
overlay
- the overlay to add
createIncludePageOverlay
public void createIncludePageOverlay(java.lang.String name,
int x,
int y,
int orientation)
- Creates an IncludePageOverlay on the page.
- Parameters:
name
- the name of the overlayx
- the x position of the overlayy
- the y position of the overlayorientation
- the orientation required for the overlay
writeDataStream
public void writeDataStream(java.io.OutputStream os)
throws java.io.IOException
- Accessor method to write the AFP datastream for the page.
- 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.