Class PageGroup

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

org.apache.fop.afp.modca.PageGroup

All Implemented Interfaces:

Completable, Streamable

public class PageGroup
extends AbstractResourceEnvironmentGroupContainer

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 AbstractAFPObject

AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary

Fields inherited from class AbstractResourceEnvironmentGroupContainer

resourceEnvironmentGroup

Fields inherited from class AbstractResourceGroupContainer

resourceGroup, started

Fields inherited from class AbstractPageObject

activeEnvironmentGroup, complete, factory, invokeMediumMaps, objects, rotation

Fields inherited from class AbstractNamedAFPObject

name

Fields inherited from class AbstractTripletStructuredObject

triplets

Fields inherited from class AbstractAFPObject

LOG, SF_CLASS, SF_HEADER_LENGTH

Constructor Summary

Constructors

Constructor	Description
PageGroup(Factory factory, String name)	Constructor for the PageGroup.

Method Summary

Modifier and Type	Method	Description
void	createTagLogicalElement(TagLogicalElement.State state)	Creates a TagLogicalElement on the page.
void	endPageGroup()	Method to mark the end of the page group.
String	toString()
protected void	writeEnd(OutputStream os)	Helper method to write the end of the Object.
protected void	writeStart(OutputStream os)	Helper method to write the start of the Object.

Methods inherited from class AbstractResourceEnvironmentGroupContainer

addPage, addPageGroup, createInvokeMediumMap, getResourceEnvironmentGroup, writeContent

Methods inherited from class AbstractResourceGroupContainer

canWrite, getResourceCount, getResourceGroup, hasResources, writeObjects, writeObjects, writeToStream

Methods inherited from class AbstractPageObject

addObject, createFont, createIncludePageSegment, createLine, createNoOperation, createText, endPage, endPresentationObject, getActiveEnvironmentGroup, getHeight, getPresentationTextObject, getRotation, getTagLogicalElements, getWidth, isComplete, setComplete

Methods inherited from class AbstractNamedAFPObject

copySF, getName, getNameBytes, getNameLength, setName

Methods inherited from class AbstractTripletStructuredObject

addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets

Methods inherited from class AbstractAFPObject

copySF, truncate, writeChunksToStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PageGroup

public PageGroup(Factory factory,
 String name)

Constructor for the PageGroup.

Parameters:

factory - the resource manager

name - the name of the page group

Method Details

createTagLogicalElement

public void createTagLogicalElement(TagLogicalElement.State state)

Creates a TagLogicalElement on the page.

Overrides:

createTagLogicalElement in class AbstractPageObject

Parameters:

state - the state of the TLE

endPageGroup

public void endPageGroup()

Method to mark the end of the page group.

writeStart

protected void writeStart(OutputStream os)
                   throws IOException

Helper method to write the start of the Object.

Overrides:

writeStart in class AbstractStructuredObject

Parameters:

os - The stream to write to

Throws:

IOException - throws an I/O exception if one occurred

writeEnd

protected void writeEnd(OutputStream os)
                 throws IOException

Helper method to write the end of the Object.

Overrides:

writeEnd in class AbstractStructuredObject

Parameters:

os - The stream to write to

Throws:

IOException - an I/O exception if one occurred

toString

public String toString()

Overrides:

toString in class AbstractNamedAFPObject