Package org.apache.fop.afp.modca
Class ResourceEnvironmentGroup
- java.lang.Object
-
- 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_LENGTH
-
-
Constructor Summary
Constructors Constructor Description ResourceEnvironmentGroup()Default constructorResourceEnvironmentGroup(java.lang.String name)Constructor for the ResourceEnvironmentGroup, this takes a name parameter which must be 8 characters long.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanisComplete()Returns true if this object is completevoidsetComplete(boolean complete)Sets whether or not this object is complete or notprotected voidwriteContent(java.io.OutputStream os)Helper method to write the contents of the Object.protected voidwriteEnd(java.io.OutputStream os)Helper method to write the end of the Object.protected voidwriteStart(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, setFullyQualifiedName, setObjectClassification, writeTriplets
-
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeToStream
-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
-
-
-
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.IOExceptionHelper method to write the start of the Object.- Overrides:
writeStartin classAbstractStructuredObject- 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.IOExceptionHelper method to write the end of the Object.- Overrides:
writeEndin classAbstractStructuredObject- 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.IOExceptionHelper method to write the contents of the Object.- Overrides:
writeContentin classAbstractEnvironmentGroup- 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:
setCompletein interfaceCompletable- Parameters:
complete- true if this object is complete
-
isComplete
public boolean isComplete()
Returns true if this object is complete- Specified by:
isCompletein interfaceCompletable- Returns:
- true if this object is complete
-
-