fop 1.0

org.apache.fop.afp.modca
Class Overlay

java.lang.Object
  extended by org.apache.fop.afp.modca.AbstractAFPObject
      extended by org.apache.fop.afp.modca.AbstractStructuredObject
          extended by org.apache.fop.afp.modca.AbstractTripletStructuredObject
              extended by org.apache.fop.afp.modca.AbstractNamedAFPObject
                  extended by org.apache.fop.afp.modca.AbstractPageObject
                      extended by org.apache.fop.afp.modca.AbstractResourceGroupContainer
                          extended by org.apache.fop.afp.modca.PageObject
                              extended by org.apache.fop.afp.modca.Overlay
All Implemented Interfaces:
Completable, Streamable

public class Overlay
extends PageObject

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.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
 
Field Summary
 
Fields inherited from class org.apache.fop.afp.modca.AbstractResourceGroupContainer
resourceGroup, started
 
Fields inherited from class org.apache.fop.afp.modca.AbstractPageObject
activeEnvironmentGroup, complete, factory, objects, rotation, tagLogicalElements
 
Fields inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
name
 
Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
triplets
 
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
log, SF_CLASS, SF_HEADER
 
Constructor Summary
Overlay(Factory factory, 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
protected  void writeContent(java.io.OutputStream os)
          Helper method to write the contents of the Object.
protected  void writeEnd(java.io.OutputStream os)
          Helper method to write the end of the Object.
protected  void writeStart(java.io.OutputStream os)
          Helper method to write the start of the Object.
 
Methods inherited from class org.apache.fop.afp.modca.PageObject
addObject, canWrite, createIncludePageOverlay, createShading, toString
 
Methods inherited from class org.apache.fop.afp.modca.AbstractResourceGroupContainer
getResourceCount, getResourceGroup, hasResources, writeObjects, writeObjects, writeToStream
 
Methods inherited from class org.apache.fop.afp.modca.AbstractPageObject
createFont, createIncludePageSegment, createLine, createNoOperation, createTagLogicalElement, createText, endPage, endPresentationObject, getActiveEnvironmentGroup, getHeight, getPresentationTextObject, getRotation, getTagLogicalElements, getWidth, isComplete, setComplete
 
Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName
 
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 org.apache.fop.afp.modca.AbstractAFPObject
copyChunks, copySF, truncate, writeChunksToStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Overlay

public Overlay(Factory factory,
               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:
factory - the resource manager of the page.
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

writeStart

protected void writeStart(java.io.OutputStream os)
                   throws java.io.IOException
Helper method to write the start of the Object.

Overrides:
writeStart in class PageObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - throws an I/O exception if one occurred

writeContent

protected void writeContent(java.io.OutputStream os)
                     throws java.io.IOException
Helper method to write the contents of the Object.

Overrides:
writeContent in class PageObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - throws an I/O exception if one occurred

writeEnd

protected void writeEnd(java.io.OutputStream os)
                 throws java.io.IOException
Helper method to write the end of the Object.

Overrides:
writeEnd in class PageObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - an I/O exception if one occurred

fop 1.0

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