FootnotePosition

Inheritance: java.lang.Object

public class FootnotePosition

Defines the footnote position.

Examples:

Shows how to select a different place where the document collects and displays its footnotes.

 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // A footnote is a way to attach a reference or a side comment to text
 // that does not interfere with the main body text's flow.
 // Inserting a footnote adds a small superscript reference symbol
 // at the main body text where we insert the footnote.
 // Each footnote also creates an entry at the bottom of the page, consisting of a symbol
 // that matches the reference symbol in the main body text.
 // The reference text that we pass to the document builder's "InsertFootnote" method.
 builder.write("Hello world!");
 builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote contents.");

 // We can use the "Position" property to determine where the document will place all its footnotes.
 // If we set the value of the "Position" property to "FootnotePosition.BottomOfPage",
 // every footnote will show up at the bottom of the page that contains its reference mark. This is the default value.
 // If we set the value of the "Position" property to "FootnotePosition.BeneathText",
 // every footnote will show up at the end of the page's text that contains its reference mark.
 doc.getFootnoteOptions().setPosition(footnotePosition);

 doc.save(getArtifactsDir() + "InlineStory.PositionFootnote.docx");
 

Fields

Field	Description
BENEATH_TEXT	Footnotes are output beneath text on each page.
BOTTOM_OF_PAGE	Footnotes are output at the bottom of each page.
length

Methods

Method	Description
fromName(String footnotePositionName)
getName(int footnotePosition)
getValues()
toString(int footnotePosition)

BENEATH_TEXT

public static int BENEATH_TEXT

Footnotes are output beneath text on each page.

BOTTOM_OF_PAGE

public static int BOTTOM_OF_PAGE

Footnotes are output at the bottom of each page.

length

public static int length

fromName(String footnotePositionName)

public static int fromName(String footnotePositionName)

Parameters:

Parameter	Type	Description
footnotePositionName	java.lang.String

Returns: int

getName(int footnotePosition)

public static String getName(int footnotePosition)

Parameters:

Parameter	Type	Description
footnotePosition	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int footnotePosition)

public static String toString(int footnotePosition)

Parameters:

Parameter	Type	Description
footnotePosition	int

Returns: java.lang.String