org.apache.fop.render.afp.modca
Class PageGroup

java.lang.Object
  org.apache.fop.render.afp.modca.AFPObject
      org.apache.fop.render.afp.modca.PageGroup

public class PageGroup

extends AFPObject

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.

Field Summary

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

LOGGER

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	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.
byte[]	getDataStream() Accessor method to obtain the byte array AFP datastream for the page group.
java.lang.String	getName()

Methods inherited from class java.lang.Object

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

Constructor Detail

PageGroup

public PageGroup(java.lang.String name)

Constructor for the PageGroup.

Parameters:

name - the name of the page group

Method Detail

getDataStream

public byte[] getDataStream()
                     throws java.io.IOException

Accessor method to obtain the byte array AFP datastream for the page group.

Specified by:

getDataStream in class AFPObject

Returns:

byte[] data stream

Throws:

java.io.IOException

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 tag

value - the value of the tag

endPageGroup

public void endPageGroup()

Method to mark the end of the page group.