public class Page
extends dom.DOMSubDocument
PageSet Page
This class represents a <page></page> section of a PageSet XML definition file.
Constructor and Description |
---|
Page(org.w3c.dom.Node oRefNode,
PageSet oPagSet) |
Modifier and Type | Method and Description |
---|---|
int[] |
blockIds()
Get a list of Block identifiers in source order
|
java.util.Vector<Block> |
blocks()
Get Page blocks.
|
java.util.Vector<Block> |
blocks(java.lang.String sMetaBlockId,
java.lang.String sTag,
java.lang.String sZone)
Get Page blocks matching a given criteria.
|
java.lang.String |
container()
GUID of Container that describes this Page structure
|
java.lang.String |
filePath() |
void |
filePath(java.lang.String sPath)
Set path to final document generated after XSL transformation of Page.
|
Container |
getContainer()
Reference to Container object that describes this Page structure
|
PageSet |
getPaseSet()
Reference to PageSet object that contains this Page
|
java.lang.String |
getTitle() |
java.lang.String |
guid()
Value of attribute guid for this Page at PageSet XML file
|
java.lang.String |
nextBlockId()
Get next free block integer identifier.
|
void |
permute(java.lang.String sMetaBlockId,
int[] aPermutation)
Permute Blocks
This method is used for reordering blocks.
|
void |
setTitle(java.lang.String sTitle)
Set <title>element contents.
|
java.lang.String |
template()
Get XSL transformer stylesheet name for this Page
|
public Page(org.w3c.dom.Node oRefNode, PageSet oPagSet)
oRefNode
- DOMDocument Node holding <page> element.oPagSet
- Reference to PageSet object that contains this pagepublic PageSet getPaseSet()
public Container getContainer()
public java.lang.String template() throws org.w3c.dom.DOMException
org.w3c.dom.DOMException
public java.lang.String filePath()
public void filePath(java.lang.String sPath)
sPath
- Path to generated XHTML (or other) final file.public java.lang.String guid()
public java.lang.String container()
public java.lang.String getTitle()
public void setTitle(java.lang.String sTitle)
sTitle
- public java.util.Vector<Block> blocks() throws org.w3c.dom.DOMException
org.w3c.dom.DOMException
- If <blocks> node is not foundpublic java.util.Vector<Block> blocks(java.lang.String sMetaBlockId, java.lang.String sTag, java.lang.String sZone) throws org.w3c.dom.DOMException
sMetaBlockId
- Identifier of metablock to matchsTag
- sZone
- org.w3c.dom.DOMException
- If <blocks> node is not foundpublic int[] blockIds() throws java.lang.NumberFormatException
Get a list of Block identifiers in source order
java.lang.NumberFormatException
- If any Block Id. is not an integerpublic java.lang.String nextBlockId() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- If any of the previous block identifiers is not an integer.public void permute(java.lang.String sMetaBlockId, int[] aPermutation) throws java.lang.ArrayIndexOutOfBoundsException
Permute Blocks
This method is used for reordering blocks.aPermutation
- New order for blocks.java.lang.ArrayIndexOutOfBoundsException