Package org.apache.fop.afp.modca
Class ResourceEnvironmentGroup
- All Implemented Interfaces:
Completable
,Streamable
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
ConstructorsConstructorDescriptionDefault constructorConstructor for the ResourceEnvironmentGroup, this takes a name parameter which must be 8 characters long. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if this object is completevoid
setComplete
(boolean complete) Sets whether or not this object is complete or notprotected void
Helper method to write the contents of the Object.protected void
writeEnd
(OutputStream os) Helper method to write the end of the Object.protected void
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 Details
-
ResourceEnvironmentGroup
public ResourceEnvironmentGroup()Default constructor -
ResourceEnvironmentGroup
Constructor for the ResourceEnvironmentGroup, this takes a name parameter which must be 8 characters long.- Parameters:
name
- the resource environment group name
-
-
Method Details
-
writeStart
Helper method to write the start of the Object.- Overrides:
writeStart
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
IOException
- throws an I/O exception if one occurred
-
writeEnd
Helper method to write the end of the Object.- Overrides:
writeEnd
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
IOException
- an I/O exception if one occurred
-
writeContent
Helper method to write the contents of the Object.- Overrides:
writeContent
in classAbstractEnvironmentGroup
- Parameters:
os
- The stream to write to- Throws:
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
-