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
Fields Modifier and Type Field Description protected ResourceEnvironmentGroupresourceEnvironmentGroupThe resource environment group used to store complex resources-
Fields inherited from class org.apache.fop.afp.modca.AbstractResourceGroupContainer
resourceGroup, started
-
Fields inherited from class org.apache.fop.afp.modca.AbstractPageObject
activeEnvironmentGroup, complete, factory, objects, rotation
-
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 AbstractResourceEnvironmentGroupContainer(Factory factory, java.lang.String name)Main constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPage(PageObject page)Adds a page to the resource container.voidaddPageGroup(PageGroup pageGroup)Adds a PageGroup to the resource container.voidcreateInvokeMediumMap(java.lang.String name)Creates an InvokeMediaMap on the page.protected ResourceEnvironmentGroupgetResourceEnvironmentGroup()Returns the resource environment groupprotected voidwriteContent(java.io.OutputStream os)Helper method to write the contents of the Object.-
Methods inherited from class org.apache.fop.afp.modca.AbstractResourceGroupContainer
canWrite, getResourceCount, getResourceGroup, hasResources, writeObjects, writeObjects, writeToStream
-
Methods 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, setComplete
-
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
writeEnd, writeStart
-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream
-
-
-
-
Field Detail
-
resourceEnvironmentGroup
protected ResourceEnvironmentGroup resourceEnvironmentGroup
The resource environment group used to store complex resources
-
-
Constructor Detail
-
AbstractResourceEnvironmentGroupContainer
public AbstractResourceEnvironmentGroupContainer(Factory factory, java.lang.String name)
Main constructor- Parameters:
factory- the object factoryname- the name of this resource container
-
-
Method Detail
-
addPage
public void addPage(PageObject page)
Adds a page to the resource container.- Parameters:
page- - the Page object
-
addPageGroup
public void addPageGroup(PageGroup pageGroup)
Adds a PageGroup to the resource container.- Parameters:
pageGroup- the PageGroup object
-
createInvokeMediumMap
public void createInvokeMediumMap(java.lang.String name)
Creates an InvokeMediaMap on the page.- Parameters:
name- the name of the media map
-
writeContent
protected void writeContent(java.io.OutputStream os) throws java.io.IOExceptionHelper method to write the contents of the Object.- Overrides:
writeContentin classAbstractPageObject- Parameters:
os- The stream to write to- Throws:
java.io.IOException- throws an I/O exception if one occurred
-
getResourceEnvironmentGroup
protected ResourceEnvironmentGroup getResourceEnvironmentGroup()
Returns the resource environment group- Returns:
- the resource environment group
-
-