|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.aspose.pdf.elements.PdfElementBase
com.aspose.pdf.elements.Section
Represents a section in a Pdf document.
| Constructor Summary | |
Section(Pdf pdf)
Initializes a new instance of the Section class. |
|
| Method Summary | |
java.lang.Object |
clone()
Clone an object. |
java.lang.String |
getBackgroundImageFile()
Gets a string that indicates the background image file name. |
float |
getBackgroundImageFixedWidth()
Gets a float value that indicates the fixed width of the background image. |
java.lang.String |
getBackgroundImageType()
Gets an ImageFileType enum that indicates the type of the background image. |
ColumnInfo |
getColumnInfo()
Gets a ColumnInfo object that indicates the columns info. |
org.w3c.dom.Element |
getDOMElement()
Gets a DOM representation of the pdf element. |
HeaderFooter |
getEvenFooter()
Gets a HeaderFooter object that indicates the even footer of the section. |
HeaderFooter |
getEvenHeader()
Gets a HeaderFooter object that indicates the even header of the section. |
int |
getFirstLineIndent()
Gets an int value that indicates the blank space at the beginning of the section. |
HeaderFooter |
getFirstPageFooter()
Gets a HeaderFooter object that indicates the first page footer of the section. |
HeaderFooter |
getFirstPageHeader()
Gets a HeaderFooter object that indicates the first page header of the section. |
GraphInfo |
getGraphInfo()
Gets a GraphInfo that indicates graph info of the section. |
HeaderFooter |
getLastPageFooter()
Gets a HeaderFooter object that indicates the last page footer of the section. |
HeaderFooter |
getLastPageHeader()
Gets a HeaderFooter object that indicates the lasgt page header of the section. |
HeaderFooter |
getOddFooter()
Gets a HeaderFooter object that indicates the odd footer of the section. |
HeaderFooter |
getOddHeader()
Gets a HeaderFooter object that indicates the odd header of the section. |
int |
getPageRotatingAngle()
Gets the number of degrees by which the page should be rotated clockwise when displayed or printed. |
PageSetup |
getPageSetup()
Gets a PageSetup that indicates page info of the section. |
Paragraphs |
getParagraphs()
Gets a Paragraph collection that indicates all paragraphs in the section. |
Pdf |
getPdf()
Gets the pdf document. |
int |
getStartingPageNumber()
Gets a int value that indicates the starting page number of the section. |
TextInfo |
getTextInfo()
|
boolean |
isBackgroundImageBlackWhite()
Gets a bool value that indicates whether the image is forced to be black-and-white. |
boolean |
isDisabled()
Gets a bool value that indicates whether this section is disabled. |
boolean |
isLandscape()
Gets a bool value that indicates whether the page orientation is landscape. |
boolean |
isNewColumn()
Gets a bool value that indicates whether the section starts at new column.Default is true. |
void |
isNewColumn(boolean isNewColumn)
Sets a bool value that indicates whether the section starts at new column.Default is true. |
boolean |
isNewPage()
Gets a bool value that indicates whether the section starts a new page. |
boolean |
isPageNumberRestarted()
Gets a bool value that indicates whether the page number be restarted at this section. |
void |
isPageNumberRestarted(boolean pageNumberRestarted)
Sets a bool value that indicates whether the page number be restarted at this section. |
boolean |
isSpaced()
Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
void |
setBackgroundImageFile(java.lang.String imageFile)
Sets a string that indicates the background image file name. |
void |
setBackgroundImageFixedWidth(float imageFixedWidth)
Sets a float value that indicates the fixed width of the background image. |
void |
setBackgroundImageType(java.lang.String imageType)
Sets an ImageFileType enum that indicates the type of the background image. |
void |
setColumnInfo(ColumnInfo info)
Sets a ColumnInfo object that indicates the columns info. |
void |
setEvenFooter(HeaderFooter footer)
Sets a HeaderFooter object that indicates the even footer of the section. |
void |
setEvenHeader(HeaderFooter header)
Sets a HeaderFooter object that indicates the even header of the section. |
void |
setFirstLineIndent(int indent)
Sets an int value that indicates the blank space at the beginning of the section. |
void |
setFirstPageFooter(HeaderFooter firstPageFooter)
Sets a HeaderFooter object that indicates the first page footer of the section. |
void |
setFirstPageHeader(HeaderFooter firstPageHeader)
Sets a HeaderFooter object that indicates the first page header of the section. |
void |
setGraphInfo(GraphInfo graphInfo)
Sets a GraphInfo that indicates graph info of the section. |
void |
setIsBackgroundImageBlackWhite(boolean backgroundImageBlackWhite)
Sets a bool value that indicates whether the image is forced to be black-and-white. |
void |
setIsDisabled(boolean disabled)
Sets a bool value that indicates whether this section is disabled. |
void |
setIsLandscape(boolean landscape)
Sets a bool value that indicates whether the page orientation is landscape. |
void |
setIsNewPage(boolean newPage)
Sets a bool value that indicates whether the section starts a new page. |
void |
setIsSpaced(boolean isSpaced)
Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
void |
setLastPageFooter(HeaderFooter lastPageFooter)
Sets a HeaderFooter object that indicates the last page footer of the section. |
void |
setLastPageHeader(HeaderFooter lastPageHeader)
Sets a HeaderFooter object that indicates the last page header of the section. |
void |
setOddFooter(HeaderFooter oddFooter)
Sets a HeaderFooter object that indicates the odd footer of the section. |
void |
setOddHeader(HeaderFooter oddHeader)
Sets a HeaderFooter object that indicates the odd header of the section. |
void |
setPageRotatingAngle(int rotatingAngle)
Sets the number of degrees by which the page should be rotated clockwise when displayed or printed. |
void |
setPageSetup(PageSetup pageSetup)
Sets a PageSetup that indicates page info of the section. |
void |
setParagraphs(Paragraphs paragraphs)
Sets a Paragraph collection that indicates all paragraphs in the section. |
void |
setStartingPageNumber(int startingPageNumber)
Sets a int value that indicates the starting page number of the section. |
void |
setTextInfo(TextInfo textInfo)
|
| Methods inherited from class com.aspose.pdf.elements.PdfElementBase |
getElementFactory, getID, getNameIndex, setID |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Section(Pdf pdf)
throws AsposeBaseException
pdf - the pdf document that owns the Section.
AsposeBaseException| Method Detail |
public java.lang.Object clone()
throws java.lang.CloneNotSupportedException
PdfElementBase
clone in class PdfElementBasejava.lang.CloneNotSupportedExceptionjava.lang.Object#clone()public void setPageSetup(PageSetup pageSetup)
public PageSetup getPageSetup()
public void setTextInfo(TextInfo textInfo)
public TextInfo getTextInfo()
public Paragraphs getParagraphs()
public void setParagraphs(Paragraphs paragraphs)
paragraphs - The paragraphs to set.public int getFirstLineIndent()
public void setFirstLineIndent(int indent)
indent - The indent to set.public boolean isSpaced()
[SampleCode]
Gets or sets a bool value that indicates whether the spaces at
the begin of the text and returns in the text be shown.
For the following XML:
The first line,
The second line.
If IsSpaced is false, the result will be:
The first line,The second line.
If IsSpaced is true, the result will be:
The first line,
The second line.
public void setIsSpaced(boolean isSpaced)
public GraphInfo getGraphInfo()
public void setGraphInfo(GraphInfo graphInfo)
public boolean isPageNumberRestarted()
public void isPageNumberRestarted(boolean pageNumberRestarted)
pageNumberRestarted - The m_isPageNumberRestarted to set.public boolean isNewColumn()
public void isNewColumn(boolean isNewColumn)
isNewColumn - The isNewColumn to set.public int getStartingPageNumber()
public void setStartingPageNumber(int startingPageNumber)
startingPageNumber - The startingPageNumber to set.public HeaderFooter getFirstPageFooter()
public void setFirstPageFooter(HeaderFooter firstPageFooter)
firstPageFooter - The FirstPageFooter to set.public HeaderFooter getFirstPageHeader()
public void setFirstPageHeader(HeaderFooter firstPageHeader)
firstPageHeader - The FirstPageHeader to set.public HeaderFooter getLastPageFooter()
public void setLastPageFooter(HeaderFooter lastPageFooter)
lastPageFooter - The LastPageFooter to set.public HeaderFooter getLastPageHeader()
public void setLastPageHeader(HeaderFooter lastPageHeader)
lastPageHeader - The LastPageHeader to set.public java.lang.String getBackgroundImageFile()
public void setBackgroundImageFile(java.lang.String imageFile)
imageFile - The BackgroundImageFile to set.public float getBackgroundImageFixedWidth()
public void setBackgroundImageFixedWidth(float imageFixedWidth)
imageFixedWidth - The BackgroundImageFixedWidth to set.public java.lang.String getBackgroundImageType()
public void setBackgroundImageType(java.lang.String imageType)
imageType - The BackgroundImageType to set.public ColumnInfo getColumnInfo()
public void setColumnInfo(ColumnInfo info)
info - The ColumnInfo to set.public HeaderFooter getEvenFooter()
public void setEvenFooter(HeaderFooter footer)
footer - The EvenFooter to set.public HeaderFooter getEvenHeader()
public void setEvenHeader(HeaderFooter header)
header - The EvenHeader to set.public boolean isBackgroundImageBlackWhite()
public void setIsBackgroundImageBlackWhite(boolean backgroundImageBlackWhite)
backgroundImageBlackWhite - The IsBackgroundImageBlackWhite to set.public boolean isDisabled()
public void setIsDisabled(boolean disabled)
disabled - The IsDisabled to set.public boolean isLandscape()
public void setIsLandscape(boolean landscape)
landscape - The IsLandscape to set.public boolean isNewPage()
public void setIsNewPage(boolean newPage)
newPage - The IsNewPage to set.public HeaderFooter getOddFooter()
public void setOddFooter(HeaderFooter oddFooter)
public HeaderFooter getOddHeader()
public void setOddHeader(HeaderFooter oddHeader)
public int getPageRotatingAngle()
public void setPageRotatingAngle(int rotatingAngle)
rotatingAngle - The PageRotatingAngle to set.public Pdf getPdf()
public org.w3c.dom.Element getDOMElement()
throws AsposeBaseException
PdfElementBase
getDOMElement in class PdfElementBaseAsposeBaseExceptionPdfElementBase.getDOMElement()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||