|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Section
public class Section
Represents a section in a Pdf document.
Typical usages are the following:
Field Summary | |
---|---|
float |
CurColumnPosY
If the section has multiple Columns, and Columns have not taken all the pages for each height (using the #$NC can be switched to the new Column), need to record the current section of the Y coordinates, so that the next section starting from this position. |
int |
FirstPageNumber
The First Page Number in Section , default is -1; |
boolean |
IsNewPageCreated
a boolean value that indicates whether the new page created, default is false. |
boolean |
IsWidowOrphanControlSet
a boolean value that indicates whether Widow/Orphan control has been set, default is false. |
int |
PagesNumber
Indicates the pages number of the section. |
float |
RealFooterMarginBottom
a float value that Indicates Footer distance from the bottom, default is -1. |
float |
RealPageBottom
a float value that Indicates the distance from the bottom, default is 0 |
HeaderFooter |
watermark
indicates the HeaderFooter Object of watermark |
Constructor Summary | |
---|---|
Section()
Initializes a new instance of the Section class. |
|
Section(Pdf pdf)
Initializes a new instance of the Section class. |
Method Summary | |
---|---|
void |
addParagraph(Paragraph para)
Add a paragraph into the section. |
java.lang.Object |
clone()
Clones a new Section object. |
java.lang.Object |
completeClone()
Clones a new Section object. |
HeaderFooter |
getAdditionalEvenFooter()
Gets a HeaderFooter object that indicates the additional even footer of the section. |
HeaderFooter |
getAdditionalEvenHeader()
Gets a HeaderFooter object that indicates the additional even header of the section. |
HeaderFooter |
getAdditionalOddFooter()
Gets a HeaderFooter object that indicates the additional odd footer of the section. |
HeaderFooter |
getAdditionalOddHeader()
Gets a HeaderFooter object that indicates the additional odd header of the section. |
Color |
getBackgroundColor()
Gets a Color object that indicates the background color of the |
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. |
ImageFileType |
getBackgroundImageType()
Gets a Image enum that indicates the type of the
background image. |
ColumnInfo |
getColumnInfo()
Gets a ColumnInfo object that indicates the columns info. |
int |
getEndNoteNumberInSection()
Gets End Note Number in Section. |
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. |
int |
getFootNoteNumberInPage()
Gets Footer Note Number in Page |
int |
getFootNoteNumberInSection()
Gets Footer Note Number in Section |
GraphInfo |
getGraphInfo()
Gets a GraphInfo that indicates graph info of the section. |
boolean |
getHasColumnLine()
Gets a bool value that indicates the vertical line between columns need to been added |
java.lang.String |
getID()
Gets a string that indicates the ID of the section. |
boolean |
getIsAutoHyphenated()
Gets a bool value that indicates whether the text is hyphenated automatically. |
boolean |
getIsBackgroundImageBlackWhite()
Gets a bool value that indicates whether the image is forced to be black-and-white. |
boolean |
getIsDisabled()
Gets a bool value that indicates whether this section is disabled. |
boolean |
getIsEmpty()
Gets a bool value that indicates whether the paragraph in the section is empty. |
boolean |
getIsFirstParaWritten()
Gets whether the first paragraph of the section has been written. |
boolean |
getIsFullPage()
Gets a boolean value that indicates whether The current Section is filled with the page. |
boolean |
getIsHasNextColumnFlag()
Gets a bool value that indicates the next column flag. |
boolean |
getIsInitialized()
Gets whether the Xml.DirectWriter.InitSection() has been called. |
boolean |
getIsLandscape()
Gets a bool value that indicates whether the page orientation is landscape. |
boolean |
getIsNewColumn()
Gets a bool value that indicates whether the section starts at new column.Default is true. |
boolean |
getIsNewPage()
Gets a bool value that indicates whether the section starts a new page. |
boolean |
getIsPageNumberRestarted()
Gets a bool value that indicates whether the page number is restarted at this section. |
boolean |
getIsSpaced()
Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
boolean |
getIsWidowOrphanControlEnabled()
Gets a bool value that indicates whether the Widow/Orphan control is enabled. |
java.lang.Object |
getObjectByID(java.lang.String ID)
Gets a object with specified ID in 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 |
getPageCount()
Gets the pages number of the section. |
PageSetup |
getPageInfo()
Gets a PageSetup that indicates page info of the section. |
int |
getPageRotatingAngle()
Gets the number of degrees by which the page should be rotated clockwise when displayed or printed. |
Paragraphs |
getParagraphs()
Gets a GraphInfo collection that indicates all paragraphs in the
section. |
Pdf |
getPdf()
Get a Pdf Object that indicates the parent Pdf of the
section. |
int |
getStartingPageNumber()
Gets a int value that indicates the starting page number of the section. |
TextInfo |
getTextInfo()
Gets a TextInfo that indicates text info of the section. |
HeaderFooter |
getWatermark()
Get a HeaderFooter Object that indicates the HeaderFooter Object
of watermark. |
HeaderFooter |
insertFooter(HeaderFooterType type)
Insert footer of the section. |
HeaderFooter |
insertHeader(HeaderFooterType type)
Insert Header of the section. |
boolean |
isSameSize(Section sec)
Gets a bool value that indicates whether the Specify Section and current Section is the same size. |
void |
setAdditionalEvenFooter(HeaderFooter value)
Sets a HeaderFooter object that indicates the additional even footer of the section. |
void |
setAdditionalEvenHeader(HeaderFooter value)
Sets a HeaderFooter object that indicates the additional even header of the section. |
void |
setAdditionalOddFooter(HeaderFooter value)
Sets a HeaderFooter object that indicates the additional odd footer of the section. |
void |
setAdditionalOddHeader(HeaderFooter value)
Sets a HeaderFooter object that indicates the additional odd
header of the section. |
void |
setBackgroundColor(Color value)
Sets a Color object that indicates the background color of the |
void |
setBackgroundImageFile(java.lang.String value)
Sets a string that indicates the background image file name. |
void |
setBackgroundImageFixedWidth(float value)
Sets a float value that indicates the fixed width of the background image. |
void |
setBackgroundImageType(ImageFileType value)
Sets a Image enum that indicates the type of the
background image. |
void |
setColumnInfo(ColumnInfo value)
Sets a ColumnInfo object that indicates the columns info. |
void |
setEndNoteNumberInSection(int value)
Sets End Note Number in Section. |
void |
setEvenFooter(HeaderFooter value)
Sets a HeaderFooter object that indicates the even footer of the
section. |
void |
setEvenHeader(HeaderFooter value)
Sets a HeaderFooter object that indicates the even header of the
section. |
void |
setFirstLineIndent(int value)
Sets an int value that indicates the blank space at the beginning of the section. |
void |
setFootNoteNumberInPage(int value)
Sets Foot Note Number in Page |
void |
setFootNoteNumberInSection(int value)
Sets Footer Note Number in Section |
void |
setGraphInfo(GraphInfo value)
Sets a GraphInfo that indicates graph info of the section. |
void |
setHasColumnLine(boolean value)
Sets a bool value that indicates the vertical line between columns need to been added |
void |
setID(java.lang.String value)
Sets a string that indicates the ID of the section. |
void |
setIsAutoHyphenated(boolean value)
Sets a bool value that indicates whether the text is hyphenated automatically. |
void |
setIsBackgroundImageBlackWhite(boolean value)
Sets a bool value that indicates whether the image is forced to be black-and-white. |
void |
setIsDisabled(boolean value)
Sets a bool value that indicates whether this section is disabled. |
void |
setIsFirstParaWritten(boolean value)
Sets whether the first paragraph of the section has been written. |
void |
setIsFullPage(boolean isFullPage)
Sets a boolean value that indicates whether The current Section is filled with the page. |
void |
setIsHasNextColumnFlag(boolean value)
Sets a bool value that indicates the next column flag |
void |
setIsInitialized(boolean value)
Sets whether the Xml.DirectWriter.InitSection() has been called. |
void |
setIsLandscape(boolean value)
Sets a bool value that indicates whether the page orientation is landscape. |
void |
setIsNewColumn(boolean value)
Sets a bool value that indicates whether the section starts at new column.Default is true. |
void |
setIsNewPage(boolean value)
Sets a bool value that indicates whether the section starts a new page. |
void |
setIsPageNumberRestarted(boolean value)
Sets a bool value that indicates whether the page number is restarted at this section. |
void |
setIsSpaced(boolean value)
Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
void |
setIsWidowOrphanControlEnabled(boolean value)
Sets a bool value that indicates whether the Widow/Orphan control is enabled. |
void |
setOddFooter(HeaderFooter value)
Sets a HeaderFooter object that indicates the odd footer of the
section. |
void |
setOddHeader(HeaderFooter value)
Sets a HeaderFooter object that indicates the odd header of the
section. |
void |
setPageCount(int value)
Sets the pages number of the section. |
void |
setPageInfo(PageSetup value)
Sets a PageSetup that indicates page info of the section. |
void |
setPageRotatingAngle(int value)
Sets the number of degrees by which the page should be rotated clockwise when displayed or printed. |
void |
setParagraphs(Paragraphs value)
Sets a GraphInfo collection that indicates all paragraphs in the
section. |
void |
setPdf(Pdf value)
Set a Pdf Object that indicates the parent Pdf of the
section. |
void |
setStartingPageNumber(int value)
Sets a int value that indicates the starting page number of the section. |
void |
setTextInfo(TextInfo value)
Sets a TextInfo that indicates text info of the section. |
void |
setWatemark(HeaderFooter value)
Set a HeaderFooter Object that indicates the HeaderFooter Object
of watermark. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public float RealPageBottom
public int PagesNumber
public int FirstPageNumber
Section
, default is -1;
public boolean IsWidowOrphanControlSet
public boolean IsNewPageCreated
public float CurColumnPosY
public HeaderFooter watermark
public float RealFooterMarginBottom
Constructor Detail |
---|
public Section()
public Section(Pdf pdf)
Section
class.
pdf
- The pdf document object.
Remarks: This constructor can inherit common property
values from the specified Pdf
object.
Method Detail |
---|
public boolean getIsFullPage()
public void setIsFullPage(boolean isFullPage)
isFullPage
- public boolean getIsAutoHyphenated()
public void setIsAutoHyphenated(boolean value)
value
- public PageSetup getPageInfo()
PageSetup
that indicates page info of the section.
public void setPageInfo(PageSetup value)
PageSetup
that indicates page info of the section.
value
- public boolean isSameSize(Section sec)
sec
- public TextInfo getTextInfo()
TextInfo
that indicates text info of the section.
public void setTextInfo(TextInfo value)
TextInfo
that indicates text info of the section.
value
- public Pdf getPdf()
Pdf
Object that indicates the parent Pdf
of the
section.
public void setPdf(Pdf value)
Pdf
Object that indicates the parent Pdf
of the
section.
value
- public boolean getIsFirstParaWritten()
public void setIsFirstParaWritten(boolean value)
value
- public void addParagraph(Paragraph para)
para
- The paragraph to be added.public GraphInfo getGraphInfo()
GraphInfo
that indicates graph info of the section.
public void setGraphInfo(GraphInfo value)
GraphInfo
that indicates graph info of the section.
value
- public Paragraphs getParagraphs()
GraphInfo
collection that indicates all paragraphs in the
section.
public void setParagraphs(Paragraphs value)
GraphInfo
collection that indicates all paragraphs in the
section.
value
- public HeaderFooter getOddHeader()
HeaderFooter
object that indicates the odd header of the
section.
public void setOddHeader(HeaderFooter value)
HeaderFooter
object that indicates the odd header of the
section.
value
- public HeaderFooter getEvenHeader()
HeaderFooter
object that indicates the even header of the
section.
public void setEvenHeader(HeaderFooter value)
HeaderFooter
object that indicates the even header of the
section.
value
- public HeaderFooter getOddFooter()
HeaderFooter
object that indicates the odd footer of the
section.
public void setOddFooter(HeaderFooter value)
HeaderFooter
object that indicates the odd footer of the
section.
value
- public HeaderFooter getEvenFooter()
HeaderFooter
object that indicates the even footer of the
section.
public void setEvenFooter(HeaderFooter value)
HeaderFooter
object that indicates the even footer of the
section.
value
- public int getFirstLineIndent()
public void setFirstLineIndent(int value)
value
- public boolean getIsSpaced()
If IsSpaced is false, the result will be:
If IsSpaced is true, the result will be:
public void setIsSpaced(boolean value)
If IsSpaced is false, the result will be:
If IsSpaced is true, the result will be:
value
- public java.lang.String getID()
public void setID(java.lang.String value)
value
- public boolean getIsDisabled()
public void setIsDisabled(boolean value)
public boolean getIsWidowOrphanControlEnabled()
public void setIsWidowOrphanControlEnabled(boolean value)
value
- public int getFootNoteNumberInSection()
public void setFootNoteNumberInSection(int value)
value
- public int getFootNoteNumberInPage()
public void setFootNoteNumberInPage(int value)
value
- public boolean getIsHasNextColumnFlag()
public void setIsHasNextColumnFlag(boolean value)
value
- public int getEndNoteNumberInSection()
public void setEndNoteNumberInSection(int value)
value
- public HeaderFooter insertHeader(HeaderFooterType type)
public HeaderFooter insertFooter(HeaderFooterType type)
public java.lang.String getBackgroundImageFile()
public void setBackgroundImageFile(java.lang.String value)
value
- public Color getBackgroundColor()
Color
object that indicates the background color of the
public void setBackgroundColor(Color value)
Color
object that indicates the background color of the
value
- public ImageFileType getBackgroundImageType()
Image
enum that indicates the type of the
background image.
public void setBackgroundImageType(ImageFileType value)
Image
enum that indicates the type of the
background image.
value
- public boolean getIsLandscape()
public void setIsLandscape(boolean value)
value
- public HeaderFooter getAdditionalOddFooter()
public void setAdditionalOddFooter(HeaderFooter value)
value
- public HeaderFooter getAdditionalEvenFooter()
public void setAdditionalEvenFooter(HeaderFooter value)
public HeaderFooter getAdditionalOddHeader()
public void setAdditionalOddHeader(HeaderFooter value)
HeaderFooter
object that indicates the additional odd
header of the section. If the first page needs one header style, the
subsequent pages need another header style, the additional header is
needed.
value
- public HeaderFooter getAdditionalEvenHeader()
public void setAdditionalEvenHeader(HeaderFooter value)
value
- public float getBackgroundImageFixedWidth()
public void setBackgroundImageFixedWidth(float value)
value
- public boolean getIsBackgroundImageBlackWhite()
public void setIsBackgroundImageBlackWhite(boolean value)
value
- public boolean getIsNewPage()
public void setIsNewPage(boolean value)
value
- public boolean getIsInitialized()
public void setIsInitialized(boolean value)
value
- public int getPageRotatingAngle()
public void setPageRotatingAngle(int value)
value
- public boolean getHasColumnLine()
public void setHasColumnLine(boolean value)
value
- public ColumnInfo getColumnInfo()
public void setColumnInfo(ColumnInfo value)
value
- public java.lang.Object getObjectByID(java.lang.String ID)
public boolean getIsPageNumberRestarted()
public void setIsPageNumberRestarted(boolean value)
value
- public boolean getIsNewColumn()
public void setIsNewColumn(boolean value)
value
- public int getStartingPageNumber()
public void setStartingPageNumber(int value)
value
- public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.Object completeClone()
public HeaderFooter getWatermark()
HeaderFooter
Object that indicates the HeaderFooter Object
of watermark.
public void setWatemark(HeaderFooter value)
HeaderFooter
Object that indicates the HeaderFooter Object
of watermark.
value
- public boolean getIsEmpty()
public int getPageCount()
public void setPageCount(int value)
value
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |