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 Modifier and Type Field Description private boolean
complete
the resource environment group stateprivate static java.lang.String
DEFAULT_NAME
default name for the resource group-
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 boolean
isComplete()
Returns true if this object is completevoid
setComplete(boolean complete)
Sets whether or not this object is complete or notprotected 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, 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
-
-
-
-
Field Detail
-
DEFAULT_NAME
private static final java.lang.String DEFAULT_NAME
default name for the resource group- See Also:
- Constant Field Values
-
complete
private boolean complete
the resource environment group state
-
-
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 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.IOException
Helper method to write the end of the Object.- Overrides:
writeEnd
in 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.IOException
Helper method to write the contents of the Object.- Overrides:
writeContent
in 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:
setComplete
in interfaceCompletable
- Parameters:
complete
- true if this object is complete
-
isComplete
public boolean isComplete()
Returns true if this object is complete- Specified by:
isComplete
in interfaceCompletable
- Returns:
- true if this object is complete
-
-