fop 0.95

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

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.ResourceGroup

public final class ResourceGroup
extends AbstractNamedAFPObject

A Resource Group contains a set of overlays.


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
ResourceGroup()
          Default constructor
ResourceGroup(java.lang.String name)
          Constructor for the ResourceGroup, this takes a name parameter which must be 8 characters long.
 
Method Summary
 void addOverlay(Overlay overlay)
          Adds an overlay to the resource group
 java.util.List getOverlays()
          Returns the list of overlays
 void writeDataStream(java.io.OutputStream os)
          Accessor method to obtain write the AFP datastream for the resource group.
 
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

ResourceGroup

public ResourceGroup()
Default constructor


ResourceGroup

public ResourceGroup(java.lang.String name)
Constructor for the ResourceGroup, this takes a name parameter which must be 8 characters long.

Parameters:
name - the resource group name
Method Detail

addOverlay

public void addOverlay(Overlay overlay)
Adds an overlay to the resource group

Parameters:
overlay - the overlay to add

getOverlays

public java.util.List getOverlays()
Returns the list of overlays

Returns:
the list of overlays

writeDataStream

public void writeDataStream(java.io.OutputStream os)
                     throws java.io.IOException
Accessor method to obtain write the AFP datastream for the resource group.

Specified by:
writeDataStream in class AbstractAFPObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - if an I/O exception of some sort has occurred

fop 0.95

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