org.apache.fop.render.afp.modca

Class PageGroup


public class PageGroup
extends AbstractNamedAFPObject

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.
Author:
Pete Townsend

Field Summary

Fields inherited from class org.apache.fop.render.afp.modca.AbstractNamedAFPObject

name, nameBytes

Fields inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject

log

Constructor Summary

PageGroup(String name)
Constructor for the PageGroup.

Method Summary

void
addPage(PageObject page)
Adds a page object to the group.
void
createInvokeMediumMap(String name)
Creates an InvokeMediaMap on the page.
void
createTagLogicalElement(String name, String value)
Creates a TagLogicalElement on the page.
void
endPageGroup()
Method to mark the end of the page group.
String
getName()
boolean
isComplete()
Returns an indication if the page group is complete
void
writeDataStream(OutputStream os)
Accessor method to write the AFP datastream for the page group.

Methods inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject

writeDataStream, writeObjectList

Constructor Details

PageGroup

public PageGroup(String name)
Constructor for the PageGroup.
Parameters:
name - the name of the page group

Method Details

addPage

public void addPage(PageObject page)
Adds a page object to the group.
Parameters:
page - the page object to add

createInvokeMediumMap

public void createInvokeMediumMap(String name)
Creates an InvokeMediaMap on the page.
Parameters:
name - the name of the media map

createTagLogicalElement

public void createTagLogicalElement(String name,
                                    String value)
Creates a TagLogicalElement on the page.
Parameters:
name - the name of the tag
value - the value of the tag

endPageGroup

public void endPageGroup()
Method to mark the end of the page group.

getName

public String getName()
Returns:
the name of the page group

isComplete

public boolean isComplete()
Returns an indication if the page group is complete
Returns:
whether or not this page group is complete or not

writeDataStream

public void writeDataStream(OutputStream os)
            throws IOException
Accessor method to write the AFP datastream for the page group.
Overrides:
writeDataStream in interface AbstractAFPObject
Parameters:
os - The stream to write to

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.