aspose.pdf
Class FootNote

java.lang.Object
  extended by aspose.pdf.FootNote
Direct Known Subclasses:
EndNote

public class FootNote
extends java.lang.Object

Represents the FootNote of Segment.

Typical usages are the following:

[Java] Pdf pdf1 = new Pdf(); Section sec1 = pdf1.getSections().add(); Segment seg1 = new Segment("dog"); FootNote footnote1 = new FootNote("dog is an animal"); seg1.setFootNote(footnote1); Text text1 = new Text(); text1.getSegments().add(seg1); sec1.getParagraphs().add(text1); pdf1.save(...); [XML] <?xml version="1.0" encoding="utf-8" ?> <Pdf xmlns="Aspose.Pdf"> <Section PageHeight="1684"> <Text MarginTop="0"> <Segment>dog</Segment> <Segment> <FootNote fontsize="7"> <Segment>dog is an animal</Segment> </FootNote> </Segment> </Text> </Section> </Pdf>


Constructor Summary
FootNote()
          Constructor with no arguments for FootNote class .
FootNote(java.lang.String note)
          Constructor with footnote content for FootNote class.
 
Method Summary
 boolean getHasProcessed()
          Sets a boolean value that indicates whether the current footnote has been processed.
 NumberingContinuationType getNumberingContinuation()
          Gets a NumberingContinuationType enumeration value that indicates footnote numbering continuation style such as continuation in pdf or section.
 NumberingFormatType getNumberingFormat()
          Gets a NumberingFormatType enumeration value that indicates footnote number format in the Pdf document.
 Paragraphs getParagraphs()
          Gets a Paragraphs object that indicates all paragraphs in the FootNote.
 Segments getSegments()
          Gets a collection Segments object that indicates the content of footnote
 TextInfo getTextInfo()
          Gets a TextInfo that indicates the text information of footnote.
 boolean isHaveNumberInfo()
          Gets a boolean value that indicates whether the footnote has numberinfo or not.
 void setHasProcessed(boolean hasProcessed)
          Sets a boolean value that indicates whether the current footnote has been processed.
 void setHaveNumberInfo(boolean haveNumberInfo)
          Sets a boolean value that indicates whether the footnote has numberinfo or not.
 void setNumberingContinuation(NumberingContinuationType numberingContinuation)
          Sets a NumberingContinuationType enumeration value that indicates footnote numbering continuation style such as continuation in pdf or section.
 void setNumberingFormat(NumberingFormatType numberingFormat)
          Sets a NumberingFormatType enumeration value that indicates footnote number format in the Pdf document.
 void setParagraphs(Paragraphs noteParas)
          Sets a Paragraphs object that indicates all paragraphs in the FootNote.
 void setSegments(Segments segments)
          Sets a collection Segments object that indicates the content of footnote
 void setTextInfo(TextInfo textInfo)
          Sets a TextInfo that indicates the text information of footnote.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FootNote

public FootNote()
Constructor with no arguments for FootNote class .


FootNote

public FootNote(java.lang.String note)
Constructor with footnote content for FootNote class. The argument note is used for the content of footnote.

Parameters:
note - Note content.
Method Detail

isHaveNumberInfo

public boolean isHaveNumberInfo()
Gets a boolean value that indicates whether the footnote has numberinfo or not.


setHaveNumberInfo

public void setHaveNumberInfo(boolean haveNumberInfo)
Sets a boolean value that indicates whether the footnote has numberinfo or not.

Parameters:
haveNumberInfo -

getParagraphs

public Paragraphs getParagraphs()
Gets a Paragraphs object that indicates all paragraphs in the FootNote.


setParagraphs

public void setParagraphs(Paragraphs noteParas)
Sets a Paragraphs object that indicates all paragraphs in the FootNote.

Parameters:
noteParas -

getNumberingFormat

public NumberingFormatType getNumberingFormat()
Gets a NumberingFormatType enumeration value that indicates footnote number format in the Pdf document.


setNumberingFormat

public void setNumberingFormat(NumberingFormatType numberingFormat)
Sets a NumberingFormatType enumeration value that indicates footnote number format in the Pdf document.

Parameters:
numberingFormat -

getNumberingContinuation

public NumberingContinuationType getNumberingContinuation()
Gets a NumberingContinuationType enumeration value that indicates footnote numbering continuation style such as continuation in pdf or section.


setNumberingContinuation

public void setNumberingContinuation(NumberingContinuationType numberingContinuation)
Sets a NumberingContinuationType enumeration value that indicates footnote numbering continuation style such as continuation in pdf or section.

Parameters:
numberingContinuation -

getSegments

public Segments getSegments()
Gets a collection Segments object that indicates the content of footnote


setSegments

public void setSegments(Segments segments)
Sets a collection Segments object that indicates the content of footnote

Parameters:
segments -

getTextInfo

public TextInfo getTextInfo()
Gets a TextInfo that indicates the text information of footnote.


setTextInfo

public void setTextInfo(TextInfo textInfo)
Sets a TextInfo that indicates the text information of footnote.

Parameters:
textInfo -

getHasProcessed

public boolean getHasProcessed()
Sets a boolean value that indicates whether the current footnote has been processed.

Returns:
A boolean value.

setHasProcessed

public void setHasProcessed(boolean hasProcessed)
Sets a boolean value that indicates whether the current footnote has been processed.