org.apache.fop.render.afp.modca
Class PageGroup
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.
PageGroup(String name) - Constructor for the PageGroup.
|
PageGroup
public PageGroup(String name)
Constructor for the PageGroup.
name
- the name of the page group
addPage
public void addPage(PageObject page)
Adds a page object to the group.
page
- the page object to add
createInvokeMediumMap
public void createInvokeMediumMap(String name)
Creates an InvokeMediaMap on the page.
name
- the name of the media map
createTagLogicalElement
public void createTagLogicalElement(String name,
String value)
Creates a TagLogicalElement on the page.
name
- the name of the tagvalue
- the value of the tag
endPageGroup
public void endPageGroup()
Method to mark the end of the page group.
getName
public String getName()
- the name of the page group
isComplete
public boolean isComplete()
Returns an indication if the page group is complete
- 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.
- writeDataStream in interface AbstractAFPObject
os
- The stream to write to
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.