|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.render.afp.modca.AbstractAFPObject
org.apache.fop.render.afp.modca.AbstractNamedAFPObject
org.apache.fop.render.afp.modca.PageGroup
public 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.
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(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 org.apache.fop.render.afp.modca.AbstractAFPObject |
---|
writeObjectList |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageGroup(java.lang.String name)
name
- the name of the page groupMethod Detail |
---|
public void addPage(PageObject page)
page
- the page object to addpublic java.lang.String getName()
public void createTagLogicalElement(java.lang.String name, java.lang.String value)
name
- the name of the tagvalue
- the value of the tagpublic void createInvokeMediumMap(java.lang.String name)
name
- the name of the media mappublic void endPageGroup()
public boolean isComplete()
public void writeDataStream(java.io.OutputStream os) throws java.io.IOException
writeDataStream
in class AbstractAFPObject
os
- The stream to write to
java.io.IOException
- thrown if an I/O exception of some sort has occurred
|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |