fop 0.95

org.apache.fop.render.afp.modca
Class Overlay

java.lang.Object
  extended by org.apache.fop.render.afp.modca.AbstractAFPObject
      extended by org.apache.fop.render.afp.modca.AbstractNamedAFPObject
          extended by org.apache.fop.render.afp.modca.AbstractPageObject
              extended by org.apache.fop.render.afp.modca.Overlay

public class Overlay
extends AbstractPageObject

An overlay is a MO:DCA-P resource object. It may be stored in an external resource library or it may be carried in a resource group. An overlay is similar to a page in that it defines its own environment and carries the same data objects.


Field Summary
 
Fields inherited from class org.apache.fop.render.afp.modca.AbstractPageObject
activeEnvironmentGroup, objects, segments, tagLogicalElements
 
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
Overlay(java.lang.String name, int width, int height, int rotation, int widthResolution, int heightResolution)
          Construct a new overlay object for the specified name argument, the overlay name should be an 8 character identifier.
 
Method Summary
 void writeDataStream(java.io.OutputStream os)
          Accessor method to write the AFP datastream for the overlay.
 
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 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

Overlay

public Overlay(java.lang.String name,
               int width,
               int height,
               int rotation,
               int widthResolution,
               int heightResolution)
Construct a new overlay object for the specified name argument, the overlay 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.
Method Detail

writeDataStream

public void writeDataStream(java.io.OutputStream os)
                     throws java.io.IOException
Accessor method to write the AFP datastream for the 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

fop 0.95

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.