fop 1.0

org.apache.fop.afp.modca
Class ResourceEnvironmentGroup

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.AbstractEnvironmentGroup
                      extended by org.apache.fop.afp.modca.ResourceEnvironmentGroup
All Implemented Interfaces:
Completable, Streamable

public class ResourceEnvironmentGroup
extends AbstractEnvironmentGroup
implements Completable

A Resource Environment Group contains a set of resources for a document or for a group of pages in a document.


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.AbstractEnvironmentGroup
mapDataResources, mapPageOverlays
 
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
ResourceEnvironmentGroup()
          Default constructor
ResourceEnvironmentGroup(java.lang.String name)
          Constructor for the ResourceEnvironmentGroup, this takes a name parameter which must be 8 characters long.
 
Method Summary
 boolean isComplete()
          Returns true if this object is complete
 void setComplete(boolean complete)
          Sets whether or not this object is complete or not
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.AbstractEnvironmentGroup
createOverlay, getLastElement
 
Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName, toString
 
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.AbstractStructuredObject
writeToStream
 
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copyChunks, copySF, truncate, writeChunksToStream, writeObjects
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceEnvironmentGroup

public ResourceEnvironmentGroup()
Default constructor


ResourceEnvironmentGroup

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

Parameters:
name - the resource environment group name
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 AbstractStructuredObject
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 AbstractStructuredObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - 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 AbstractEnvironmentGroup
Parameters:
os - The stream to write to
Throws:
java.io.IOException - throws an I/O exception if one occurred

setComplete

public void setComplete(boolean complete)
Sets whether or not this object is complete or not

Specified by:
setComplete in interface Completable
Parameters:
complete - true if this object is complete

isComplete

public boolean isComplete()
Returns true if this object is complete

Specified by:
isComplete in interface Completable
Returns:
true if this object is complete

fop 1.0

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