org.apache.fop.render.afp.modca
Class PageGroup
java.lang.Object
|
+--org.apache.fop.render.afp.modca.AbstractAFPObject
|
+--org.apache.fop.render.afp.modca.AbstractNamedAFPObject
|
+--org.apache.fop.render.afp.modca.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
Constructor Summary |
PageGroup(java.lang.String name)
Constructor for the PageGroup. |
Method Summary |
void |
addPage(PageObject page)
Adds a page object to the group. |
void |
createInvokeMediumMap(java.lang.String name)
Creates an InvokeMediaMap on the page. |
void |
createTagLogicalElement(java.lang.String name,
java.lang.String value)
Creates a TagLogicalElement on the page. |
void |
endPageGroup()
Method to mark the end of the page group. |
java.lang.String |
getName()
|
boolean |
isComplete()
Returns an indication if the page group is complete |
void |
writeDataStream(java.io.OutputStream os)
Accessor method to write the AFP datastream for the page group. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PageGroup
public PageGroup(java.lang.String name)
- Constructor for the PageGroup.
- Parameters:
name
- the name of the page group
addPage
public void addPage(PageObject page)
- Adds a page object to the group.
- Parameters:
page
- the page object to add
getName
public java.lang.String getName()
- Returns:
- the name of the page group
createTagLogicalElement
public void createTagLogicalElement(java.lang.String name,
java.lang.String value)
- Creates a TagLogicalElement on the page.
- Parameters:
name
- the name of the tagvalue
- the value of the tag
createInvokeMediumMap
public void createInvokeMediumMap(java.lang.String name)
- Creates an InvokeMediaMap on the page.
- Parameters:
name
- the name of the media map
endPageGroup
public void endPageGroup()
- Method to mark the end of the page group.
isComplete
public boolean isComplete()
- Returns an indication if the page group is complete
writeDataStream
public void writeDataStream(java.io.OutputStream os)
throws java.io.IOException
- Accessor method to write the AFP datastream for the page group.
- Overrides:
writeDataStream
in class AbstractAFPObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
-
Copyright 1999-2006 The Apache Software Foundation. All Rights Reserved.