Package org.apache.fop.afp.modca
Class PageGroup
java.lang.Object
- All Implemented Interfaces:
Completable
,Streamable
A page group is used in the data stream to define a named, logical grouping
of sequential pages. Page groups are delimited by begin-end structured fields
that carry the name of the page group. Page groups are defined so that the
pages that comprise the group can be referenced or processed as a single
entity. Page groups are often processed in stand-alone fashion; that is, they
are indexed, retrieved, and presented outside the context of the containing
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.AbstractResourceEnvironmentGroupContainer
resourceEnvironmentGroup
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, invokeMediumMaps, 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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Creates a TagLogicalElement on the page.void
Method to mark the end of the page group.toString()
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.AbstractResourceEnvironmentGroupContainer
addPage, addPageGroup, createInvokeMediumMap, getResourceEnvironmentGroup, writeContent
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, 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
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.AbstractAFPObject
copySF, truncate, writeChunksToStream
-
Constructor Details
-
PageGroup
Constructor for the PageGroup.- Parameters:
factory
- the resource managername
- the name of the page group
-
-
Method Details
-
createTagLogicalElement
Creates a TagLogicalElement on the page.- Overrides:
createTagLogicalElement
in classAbstractPageObject
- Parameters:
state
- the state of the TLE
-
endPageGroup
public void endPageGroup()Method to mark the end of the page group. -
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
-
toString
- Overrides:
toString
in classAbstractNamedAFPObject
-