|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.HeaderFooter
public class HeaderFooter
Represents a header or footer of a page in a Pdf document.
Typical usages are the following:
Field Summary | |
---|---|
boolean |
hasProcessedForRS
|
Paragraphs |
ParasBehindText
define paragraphs behind text |
Paragraphs |
ParasOverText
define paragraphs over text |
Constructor Summary | |
---|---|
HeaderFooter()
Constructor - initializes a new instance of the HeaderFooter class. |
|
HeaderFooter(Section section)
Constructor - initializes a new instance of the HeaderFooter class. |
Method Summary | |
---|---|
java.lang.Object |
completeClone()
Clones a new HeaderFooter object. |
java.lang.Object |
completeCloneAll()
Clones a new HeaderFooter object. |
float |
getAdditionalHeight()
Get the additional height of the header or footer , If the height of more than headerfooter page margin, an increase of this AdditionalHeight |
float |
getDistanceFromEdge()
Gets a float value that indicates the Header or Footer's distance from the edge of the page. |
GraphInfo |
getGraphInfo()
Gets a GraphInfo object that indicates the graph info of the header or
footer. |
boolean |
getHasProcessed()
Gets a boolean value that indicates whether the header or footer has been processed. |
boolean |
getIsHeader()
Gets a boolean value that indicates whether this object is Header. |
MarginInfo |
getMargin()
Gets a MarginInfo object that indicates the margin info of the header or
footer. |
Paragraphs |
getParagraphs()
Gets a Paragraphs collection that indicates all paragraphs in the
header or footer. |
TextInfo |
getTextInfo()
Gets a TextInfo object that indicates the text info of the header or
footer. |
boolean |
isFirstPageOnly()
Gets a boolean value that indicates whether the header or footer be printed on first page only. |
boolean |
isLastPageOnly()
Gets a boolean value that indicates whether the header or footer be printed on last page only. |
boolean |
isSubsequentPagesOnly()
Gets a boolean value that indicates whether the header or footer be printed not on first page but on subsequent pages only. |
void |
setAdditionalHeight(float additionalHeight)
Set the additional height of the header or footer , If the height of more than headerfooter page margin, an increase of this AdditionalHeight |
void |
setDistanceFromEdge(float fromEdges)
Sets a float value that indicates the Header or Footer's distance from the edge of the page. |
void |
setGraphInfo(GraphInfo graphInfo)
Sets a GraphInfo object that indicates the graph info of the header or
footer. |
void |
setHasProcessed(boolean hasProcessed)
Sets a boolean value that indicates whether the header or footer has been processed. |
void |
setIsFirstPageOnly(boolean firstPageOnly)
Sets a boolean value that indicates whether the header or footer be printed on first page only. |
void |
setIsHeader(boolean isHeader)
Sets a boolean value that indicates whether this object is Header. |
void |
setIsLastPageOnly(boolean lastPageOnly)
Sets a boolean value that indicates whether the header or footer be printed on last page only. |
void |
setIsSubsequentPagesOnly(boolean subsequentPagesOnly)
Sets a boolean value that indicates whether the header or footer be printed not on first page but on subsequent pages only. |
void |
setMargin(MarginInfo headerFooterMargin)
Sets a MarginInfo object that indicates the margin info of the header or
footer. |
void |
setParagraphs(Paragraphs paras)
Sets a Paragraphs collection that indicates all paragraphs in the
header or footer. |
void |
setTextInfo(TextInfo hfTextInfo)
Sets a TextInfo object that indicates the text info of the header or
footer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public Paragraphs ParasBehindText
public Paragraphs ParasOverText
public boolean hasProcessedForRS
Constructor Detail |
---|
public HeaderFooter()
HeaderFooter
class.
public HeaderFooter(Section section)
HeaderFooter
class.
section
- The section object.Method Detail |
---|
public float getAdditionalHeight()
public void setAdditionalHeight(float additionalHeight)
additionalHeight
- public TextInfo getTextInfo()
TextInfo
object that indicates the text info of the header or
footer.
TextInfo
object.public void setTextInfo(TextInfo hfTextInfo)
TextInfo
object that indicates the text info of the header or
footer.
hfTextInfo
- A TextInfo
object.public GraphInfo getGraphInfo()
GraphInfo
object that indicates the graph info of the header or
footer.
GraphInfo
object.public void setGraphInfo(GraphInfo graphInfo)
GraphInfo
object that indicates the graph info of the header or
footer.
graphInfo
- A GraphInfo
object.public Paragraphs getParagraphs()
Paragraphs
collection that indicates all paragraphs in the
header or footer.
Paragraphs
object.public void setParagraphs(Paragraphs paras)
Paragraphs
collection that indicates all paragraphs in the
header or footer.
paras
- A Paragraphs
object.public MarginInfo getMargin()
MarginInfo
object that indicates the margin info of the header or
footer.
MarginInfo
object.public void setMargin(MarginInfo headerFooterMargin)
MarginInfo
object that indicates the margin info of the header or
footer.
headerFooterMargin
- A MarginInfo
object.public float getDistanceFromEdge()
public void setDistanceFromEdge(float fromEdges)
fromEdges
- A float value.public boolean isFirstPageOnly()
public void setIsFirstPageOnly(boolean firstPageOnly)
firstPageOnly
- A boolean value.public boolean isLastPageOnly()
public void setIsLastPageOnly(boolean lastPageOnly)
lastPageOnly
- A boolean value.public boolean isSubsequentPagesOnly()
public void setIsSubsequentPagesOnly(boolean subsequentPagesOnly)
subsequentPagesOnly
- A boolean value.public boolean getIsHeader()
public void setIsHeader(boolean isHeader)
isHeader
- A boolean value.public boolean getHasProcessed()
public void setHasProcessed(boolean hasProcessed)
hasProcessed
- A boolean value.public java.lang.Object completeClone()
HeaderFooter
object. Both format and content is cloned.
HeaderFooter
object.public java.lang.Object completeCloneAll()
HeaderFooter
object. All format and content is cloned.
HeaderFooter
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |