Package org.apache.fop.afp.modca
Class AbstractResourceEnvironmentGroupContainer
java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
org.apache.fop.afp.modca.AbstractNamedAFPObject
org.apache.fop.afp.modca.AbstractPageObject
org.apache.fop.afp.modca.AbstractResourceGroupContainer
org.apache.fop.afp.modca.AbstractResourceEnvironmentGroupContainer
- All Implemented Interfaces:
Completable,Streamable
public abstract class AbstractResourceEnvironmentGroupContainer
extends AbstractResourceGroupContainer
An abstract class which encapsulates the common features of
Document and PageGroup resource containers
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ResourceEnvironmentGroupThe resource environment group used to store complex resourcesFields inherited from class org.apache.fop.afp.modca.AbstractResourceGroupContainer
resourceGroup, startedFields inherited from class org.apache.fop.afp.modca.AbstractPageObject
activeEnvironmentGroup, complete, factory, invokeMediumMaps, objects, rotationFields inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
nameFields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
tripletsFields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH -
Constructor Summary
ConstructorsConstructorDescriptionAbstractResourceEnvironmentGroupContainer(Factory factory, String name) Main constructor -
Method Summary
Modifier and TypeMethodDescriptionvoidaddPage(PageObject page) Adds a page to the resource container.voidaddPageGroup(PageGroup pageGroup) Adds a PageGroup to the resource container.voidcreateInvokeMediumMap(String name) Creates an InvokeMediaMap on the page.protected ResourceEnvironmentGroupReturns the resource environment groupprotected voidHelper method to write the contents of the Object.Methods inherited from class org.apache.fop.afp.modca.AbstractResourceGroupContainer
canWrite, getResourceCount, getResourceGroup, hasResources, writeObjects, writeObjects, writeToStreamMethods inherited from class org.apache.fop.afp.modca.AbstractPageObject
addObject, createFont, createIncludePageSegment, createLine, createNoOperation, createTagLogicalElement, createText, endPage, endPresentationObject, getActiveEnvironmentGroup, getHeight, getPresentationTextObject, getRotation, getTagLogicalElements, getWidth, isComplete, setCompleteMethods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName, toStringMethods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTripletsMethods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeEnd, writeStartMethods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream
-
Field Details
-
resourceEnvironmentGroup
The resource environment group used to store complex resources
-
-
Constructor Details
-
AbstractResourceEnvironmentGroupContainer
Main constructor- Parameters:
factory- the object factoryname- the name of this resource container
-
-
Method Details
-
addPage
Adds a page to the resource container.- Parameters:
page- - the Page object
-
addPageGroup
Adds a PageGroup to the resource container.- Parameters:
pageGroup- the PageGroup object
-
createInvokeMediumMap
Creates an InvokeMediaMap on the page.- Overrides:
createInvokeMediumMapin classAbstractPageObject- Parameters:
name- the name of the media map
-
writeContent
Helper method to write the contents of the Object.- Overrides:
writeContentin classAbstractPageObject- Parameters:
os- The stream to write to- Throws:
IOException- throws an I/O exception if one occurred
-
getResourceEnvironmentGroup
Returns the resource environment group- Returns:
- the resource environment group
-