public class PageSequence extends FormattingObject
EMPTY_ARRAY
MAP_TYPE_FLYWEIGHT, MAP_TYPE_HASH
Constructor and Description |
---|
PageSequence()
Creates a new page-sequence.
|
PageSequence(Document doc)
Creates a new page sequence and adds it to a document.
|
PageSequence(Document doc,
PageMaster pageMaster)
Creates a new page-sequence that references the given PageMaster.
|
PageSequence(Document doc,
PageMaster pageMaster,
int initialPageNr)
Creates a new page-sequence that references the given PageMaster and
page-number ist started at the given number.
|
PageSequence(PageMaster pageMaster)
Deprecated.
Use
new PageSequence(Document, PageMaster) instead. |
PageSequence(PageMaster pageMaster,
int initialPageNr)
Deprecated.
Use
new PageSequence(Document, PageMaster, int) instead. |
Modifier and Type | Method and Description |
---|---|
boolean |
addStaticContent(StaticContent content)
Adds a static content to this page-sequence.
|
void |
addStaticContent(java.lang.String flowName,
StaticContent content)
Adds a static content to this page-sequence.
|
void |
addStaticContent(Values.Region region,
StaticContent content)
Adds a static content to this page-sequence.
|
boolean |
addUnsafe(java.lang.Object child)
Adds a NodeElement to this FormattingObject.
|
java.lang.Object |
clone()
Clones this element.
|
StaticContent |
getContentAfter()
Gets the region after body (Footer).
|
StaticContent |
getContentBefore()
Gets the region before body (Header).
|
StaticContent |
getContentEnd()
Gets the region right of body.
|
StaticContent |
getContentStart()
Gets the region left of body.
|
Document |
getDocument()
Gets the document, that contains this.
|
java.util.List |
getElements()
Gets childreen of this node.
|
Flow |
getFlow()
Gets the flow of body.
|
int |
getIndex()
Returns the index of this page-sequence in parent document starting at 0.
|
java.lang.Integer |
getInitialPageNumber()
Gets the initial page number.
|
java.lang.String |
getMasterReference() |
PageMaster |
getPageMaster()
Gets the PageMaster of this PageSequence.
|
StaticContent |
getStaticContent(java.lang.String flowName) |
StaticContent |
getStaticContent(Values.Region region)
Gets the static-content of a region.
|
Title |
getTitle()
Gets the title of this page sequence.
|
void |
setContentAfter(StaticContent content)
Sets the content after body (Footer).
|
void |
setContentBefore(StaticContent content)
Sets the content before body (Header).
|
void |
setContentEnd(StaticContent content)
Sets the content right of body.
|
void |
setContentStart(StaticContent content)
Sets the content left of body.
|
void |
setForcePageCount(Values.ForcePageCount value)
Sets the force-page-count attribute.
|
void |
setInitialPageNumber(java.lang.Integer nr)
Sets the initial page number.
|
void |
setPageMaster(PageMaster master)
Sets the PageMaster of this PageSequence.
|
void |
setTitle(Title title)
Sets the title of this page sequence.
|
addElement, addElement, addUnsafe, cloned, clonedList, createUniqueID, createUniqueID, doGetAttribute, doSetAttribute, elementCount, get, getAbsolutePosition, getAccessibility, getAttributeMap, getBackground, getBorder, getDefinedAttributes, getFont, getID, getLanguage, getLogger, getMargin, getMeasureValue, getObjectValue, getObjectValue, getObjectValue, getObjectValue, getOrphans, getPadding, getParentFO, getRelativePosition, getWidows, hasBorder, hasID, hasPadding, isEmpty, isHyphenation, removeElement, removeElement, replaceElement, setAbsolutePosition, setAccessibility, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBackground, setBorder, setElement, setFont, setHyphenation, setID, setLanguage, setLanguage, setMargin, setOrphans, setPadding, setRelativePosition, setWidows
getDefaultMapType, setDefaultMapType
addAttributeChangeListener, addElements, addElements, clearEqualAttributes, clearInheratedAttribute, clearInheratedAttributes, clearValue, contains, contains, copyAttributes, createID, findFirstNodeWithText, findNode, findNodesWithText, fire, fireSaxEvents, firstElement, getAttrAsBoolean, getAttrAsInteger, getAttrAsString, getAttrAsString, getAttribute, getAttribute, getAttributeMap, getContentText, getContentText, getDefinedAttributes, getElements, getElements, getElements, getFirstElement, getLocalName, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getParent, getParent, getParent, getParentOrThis, getQName, getRoot, hasEqualAttrs, indexOf, lastElement, liftInheritedAttribute, removeAttributeChangeListener, setAttribute, setAttributes, setAttrIfNotNull, setEnableAttributeChangeEvent, setNamespace, setParent, setQName, setUndefinedAttributes, writeTo, writeTo, writeTo, writeTo
public PageSequence()
public PageSequence(Document doc)
doc
- Document.public PageSequence(PageMaster pageMaster)
new PageSequence(Document, PageMaster)
instead.pageMaster
- PageMaster.public PageSequence(Document doc, PageMaster pageMaster)
doc
- Document.pageMaster
- PageMaster.public PageSequence(PageMaster pageMaster, int initialPageNr)
new PageSequence(Document, PageMaster, int)
instead.pageMaster
- PageMaster.initialPageNr
- Initial page number.public PageSequence(Document doc, PageMaster pageMaster, int initialPageNr)
doc
- Document.pageMaster
- PageMaster.initialPageNr
- Initial page number.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
NodeElement
clone
in interface NodeElement
clone
in class FormattingObject
java.lang.CloneNotSupportedException
public void setForcePageCount(Values.ForcePageCount value)
value
- public void setInitialPageNumber(java.lang.Integer nr)
nr
- Initial page number.public java.lang.Integer getInitialPageNumber()
public void setTitle(Title title)
title
- Titlepublic Title getTitle()
public boolean addStaticContent(StaticContent content)
content
- Static content.true
if content was added.public void addStaticContent(Values.Region region, StaticContent content)
region
- Region of content (see Values.Region...)content
- Static content.public void addStaticContent(java.lang.String flowName, StaticContent content)
flowName
- Flow name of region.content
- Static content.public StaticContent getStaticContent(Values.Region region)
region
- Region.public StaticContent getStaticContent(java.lang.String flowName)
public void setContentBefore(StaticContent content)
content
- Content before body.public StaticContent getContentBefore()
public void setContentAfter(StaticContent content)
content
- Content after body.public StaticContent getContentAfter()
public void setContentStart(StaticContent content)
content
- Content left of body.public StaticContent getContentStart()
public void setContentEnd(StaticContent content)
content
- Content right of body.public StaticContent getContentEnd()
public Flow getFlow()
public java.util.List getElements()
AbstractNode
NodeElement
or String
.getElements
in interface Node
getElements
in class AbstractNode
public void setPageMaster(PageMaster master)
master
- PageMaster.public PageMaster getPageMaster()
public Document getDocument()
getDocument
in class FormattingObject
public int getIndex()
getIndex
in class AbstractNode
public boolean addUnsafe(java.lang.Object child)
FormattingObject
addUnsafe
in class FormattingObject
child
- Element.false
if this FO is unable to add object.public java.lang.String getMasterReference()
© 2003-2011 by Sascha Schmidt (vision-cloud.de). All Rights Reserved.