addFootnote

Option	Type	Description
textDocument	String	Text that will appear in the Word document.
textFootnote	WordFragment	WordFragment that will appear as the footnote in the Word document.
footnoteMark	HashMap<String, String>	customMark: a special character, if any, that you would like to use for the call to the footnote content. font: the font family you wish to use (Arial, Calibri...). bold: bold text. bidi: bidi option. italic: turn on italics. color: an hexadecimal color ("000000", "FF0000"...). rtl: right to left language. highlightColor: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none. underline: underlines text: single. backgroundColor: an hexadecimal color.
referenceMark	HashMap<String, String>	font: the font family you wish to use (Arial, Calibri...). bold: bold text. bidi: bidi option. italic: turn on italics. color: an hexadecimal color ('000000', 'FF0000'...). rtl: right to left language.

Code samples

Example #1

package examples.Core.addFootnote;

import java.util.ArrayList;
import java.util.HashMap;

import com.javadocx.CreateDocx;
import com.javadocx.WordFragment;
import com.javadocx.elements.*;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();

        OptionsText textFootnote = new OptionsText();
        textFootnote.setText("The footnote we want to insert.");
        WordFragment textFootnoteFragment = new WordFragment(docx, "footnote");
        textFootnoteFragment.addText(textFootnote);

        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setImageAlign("center")
                    .setScaling(50)
                    .setTextWrap(0);

        textFootnoteFragment.addImage("src/examples/files/img/image.png", imageOptions);

        HashMap<String, String> footnoteMarkOptions = new HashMap<String, String>();
        footnoteMarkOptions.put("customMark", "*");

        OptionsFootnote footnoteOptions = new OptionsFootnote();
        footnoteOptions.setTextDocument("footnote")
                       .setTextFootnote(textFootnoteFragment)
                       .setFootnoteMark(footnoteMarkOptions);

        WordFragment footnoteFragment = new WordFragment(docx);
        footnoteFragment.addFootnote(footnoteOptions);

        OptionsText textOptionsA = new OptionsText();
        textOptionsA.setText("Here comes the ");
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);

        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText(" and some other text.");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);

        ArrayList<WordFragment> text = new ArrayList<WordFragment>();
        text.add(textFragmentA);
        text.add(footnoteFragment);
        text.add(textFragmentB);

        docx.addText(text);

        docx.addText("Some other text.");

        docx.createDocx("example_addFootnote_1");
    }
}

The resulting Word document looks like: