addText

multiple runs of text with diverse formatting
inline and floating images
inline and floating charts
footnotes and endnotes
all kinds of different line breaks (line, column, page)
all kind of different tabs (light, right, center with leading characters or not)
links and bookmarks
page numbers
date and hour
form elements
shapes

You may, in general, insert any "inline". If you try to insert a block type element, like a table, its inline contents will be extracted and inserted ignoring the containing block element.

Parameters

paragraphContents

This could be:

a simple string of text.
a WordFragment.
an ArrayList. Each of the elements of this array may be an OptionsText object:

Option	Type	Description
text	String	The text to be inserted.
bold	Boolean	If true the text will be shown in bold characters.
caps	Boolean	If true displays text in capital letters.
characterBorder	HashMap<String, String>	Adds a border to the character: type => none, single, double, dashed..., color => ffffff, ff0000, spacing => 0, 1, 2..., width => in eights of a point.
color	String	Hexadecimal color value: "FF0000", "000000"...
columnBreak	String	Inserts a column break. Possible values are: before, after or both.
doubleStrikeThrough	Boolean	If true displays text in doubleStrikeThrough.
em	String	Emphasis mark type: "none", "dot", "circle", "comma", "underDot".
font	String	Font family: "Arial", "Calibri"...
fontSize	Integer	Font size in points.
highlightColor	String	Highlights the run of text. The available colors are: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none.
italic	Boolean	If true displays the text in italics.
lineBreak	String	Inserts a line break. Possible values are: before, after or both.
position	Integer	Position value. Positive value for raised and negative value for lowered.
rStyle	String	Character style to be used.
rtl	Boolean	Sets to true for right to left languages like Hebrew or Arabic.
scaling	String	Scaling value, 100 is the default value.
smallCaps	Boolean	If true displays text in small capital letters.
spaces	String	Number of additional leading empty spaces before the current run of text.
spacing	String	character spacing, positive value for expanded and negative value for condensed.
strikeThrough	Boolean	If true displays text in strikethrough.
subscript	Boolean	If true displays text in subscript.
superscript	Boolean	If true displays text in superscript.
tab	Boolean	Inserts a tab.
underline	String	Underlines text. Possible values are: single, words, double, dotted, dash and wave.
underlineColor	String	Underlines text with a color: "FF0000", "000000"...
vanish	Boolean	Uses a vanish style.

paragraphOptions

Option	Type	Description
pStyle	String	Word style to be used.
backgroundColor	String	Hexadecimal color value: FF0000, 000000...
bidi	Boolean	Sets to true for right to left languages like Hebrew or Arabic.
bold	Boolean	If true the text will be shown in bold characters.
border	String	Available values are: none (default) double dashed outset inset threeDEmboss threeDEngrave
borderBottom	String	Overwrites the general border type for the bottom border of the paragraph.
borderLeft	String	Overwrites the general border type for the left border of the paragraph.
borderTop	String	Overwrites the general border type for the top border of the paragraph.
borderRight	String	Overwrites the general border type for the right border of the paragraph.
borderColor	String	Hexadecimal color value: FF0000, 000000...
borderBottomColor	String	Overwrites the general border color for the bottom border of the paragraph.
borderLeftColor	String	Overwrites the general border color for the left border of the paragraph.
borderTopColor	String	Overwrites the general border color for the top border of the paragraph.
borderRightColor	String	Overwrites the general border color for the right border of the paragraph.
borderSpacing	Integer	Separation between border and text in points.
borderBottomSpacing	Integer	Overwrites the general border spacing for the bottom border of the paragraph.
borderLeftSpacing	Integer	Overwrites the general border spacing for the left border of the paragraph.
borderTopSpacing	Integer	Overwrites the general border spacing for the top border of the paragraph.
borderRightSpacing	Integer	Overwrites the general border spacing for the right border of the paragraph.
borderWidth	Integer	Border width in eigths of a point.
borderBottomWidth	Integer	Overwrites the general border width for the bottom border of the paragraph.
borderLeftWidth	Integer	Overwrites the general border width for the left border of the paragraph.
borderTopWidth	Integer	Overwrites the general border width for the top border of the paragraph.
borderRightWidth	Integer	Overwrites the general border width for the right border of the paragraph.
caps	Boolean	If true displays text in capital letters.
color	String	Hexadecimal color value: "FF0000", "000000"...
contextualSpacing	String	Ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style.
doubleStrikeThrough	Boolean	If true displays text in doubleStrikeThrough.
em	String	Emphasis mark type: "none", "dot", "circle", "comma", "underDot".
firstLineIndent	Integer	First line indentation in twentieths of a point (twips).
font	String	Font family: "Arial", "Calibri"...
fontSize	Integer	Font size in points.
hanging	Integer	Paragraph hanging in twentieths of a point (twips).
headingLevel	Integer	The heading level if you want this paragraph to be a heading.
italic	Boolean	If true displays the text in italics.
indentLeft	Integer	Left margin in points.
indentRight	Integer	Right margin in points.
keepLines	Boolean	Keeps (whenever possible) all the current paragraph lines on the same page (default value is false).
keepNext	Boolean	Keeps (whenever possible) in the same page the current paragraph with next paragraph (default value is false).
lineSpacing	Integer	120, 240 (standard), 360, 480... (in twentieths of a point).
pageBreakBefore	Boolean	If true forces a page break before the paragraph.
primaryStyle	Boolean	If true sets as primary style.
position	Integer	Position value. Positive value for raised and negative value for lowered.
rtl	Boolean	Sets to true for right to left languages like Hebrew or Arabic.
scaling	Integer	Scaling value, 100 is the default value.
semiHidden	Boolean	If true sets as semihidden style.
smallCaps	Boolean	If true displays text in small capital letters.
spacingBottom	Integer	Bottom padding in twentieths of a point.
spacingTop	Integer	Top padding in twentieths of a point.
strikeThrough	Boolean	If true displays text in strikethrough.
tabPositions	ArrayList<HashMap<String, String>>	Each entry is a HashMap array with the following keys and values: type can be clear, left (default), center, right, decimal, bar and num. leader can be none (default), dot, hyphen, underscore, heavy and middleDot. position given in twentieths of a point.
textAlign	String	Text alignment within paragraph. Possible values are: center, right, both and distribute.
textDirection	String	Text flow direction within a table cell. Possible values are: lrTb, tbRl, btLr, lrTbV, tbRlV and tbLrV.
underline	String	Underlines text. Possible values are: single, words, double, dotted, dash and wave.
underlineColor	String	Underlines text with a color: "FF0000", "000000"...
vanish	Boolean	Uses a vanish style.
widowControl	Boolean	Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan).
wordWrap	Boolean	Allows line breaking at character level (default value is false).

Code samples

Example #1

package examples.Core.addText;

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

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        String text = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi utaliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";
        
        OptionsParagraph paragraphOptions = new OptionsParagraph();
        paragraphOptions.setBold(true)
                        .setFont("Arial");

        docx.addText(text, paragraphOptions);
        
        docx.createDocx("example_addText_1");
    }
}

The resulting Word document looks like:

Example #2

package examples.Core.addText;

import java.util.ArrayList;

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

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsText textOptionsA = new OptionsText();
        textOptionsA.setText("We know this looks ugly")
                    .setUnderline("single");
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText(" but we only want to illustrate some of the functionality of the addText method.")
                    .setBold(true);
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);

        // a paragraph composed of two runs of text with different properties
        ArrayList<WordFragment> runs = new ArrayList<WordFragment>();
        
        runs.add(textFragmentA);
        runs.add(textFragmentB);
        
        OptionsParagraph paragraphOptions = new OptionsParagraph();
        paragraphOptions.setBorder("double")
                        .setBorderColor("b70000")
                        .setBorderWidth(12)
                        .setBorderSpacing(8)
                        .setBorderTopColor("000000");

        docx.addText(runs, paragraphOptions);
        
        docx.createDocx("example_addText_2");
    }
}

The resulting Word document looks like:

Example #3

package examples.Core.addText;

import java.util.ArrayList;

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

public class Sample3 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        WordFragment imageFragment = new WordFragment(docx);
        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setImageAlign("center")
                    .setScaling(50)
                    .setFloatImage("right")
                    .setTextWrap(1);
        
        imageFragment.addImage("src/examples/files/img/image.png", imageOptions);
        
        OptionsLink linkOptions = new OptionsLink();
        linkOptions.setUrl("http://www.google.es")
                   .setColor("0000FF")
                   .setUnderline("single");
        WordFragment linkFragment = new WordFragment(docx);
        linkFragment.addLink("link to Google", linkOptions);
        
        OptionsText textFootnote = new OptionsText();
        textFootnote.setText("This is the footnote text.");
        WordFragment textFootnoteFragment = new WordFragment(docx);
        textFootnoteFragment.addText(textFootnote);
        
        OptionsFootnote footnoteOptions = new OptionsFootnote();
        footnoteOptions.setTextDocument("here it is")
                       .setTextFootnote(textFootnoteFragment);
        
        WordFragment footnoteFragment = new WordFragment(docx);
        footnoteFragment.addFootnote(footnoteOptions);
        
        OptionsText textOptionsA = new OptionsText();
        textOptionsA.setText("I am going to write a link: ")
                    .setBold(true);
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText(" to illustrate how to include links. ");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        OptionsText textOptionsC = new OptionsText();
        textOptionsC.setText(" As you may see it is extremely simple to do so and it can be done with any other Word element. For example to include  a footnote is also as simple as this: ");
        WordFragment textFragmentC = new WordFragment(docx);
        textFragmentC.addText(textOptionsC);
        
        OptionsText textOptionsD = new OptionsText();
        textOptionsD.setText(" , as you may check there is a footnote at the bottom of the page. ")
                    .setColor("B70000");
        WordFragment textFragmentD = new WordFragment(docx);
        textFragmentD.addText(textOptionsD);
        
        ArrayList<WordFragment> runs = new ArrayList<WordFragment>();
        runs.add(imageFragment);
        runs.add(textFragmentA);
        runs.add(linkFragment);
        runs.add(textFragmentB);
        runs.add(textFragmentC);
        runs.add(footnoteFragment);
        runs.add(textFragmentD);

        docx.addText(runs);
        
        docx.createDocx("example_addText_3");
    }
}

The resulting Word document looks like:

Example #4

package examples.Core.addText;

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

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

public class Sample4 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        docx.addText("Some examples that illustrate how to include tabbed text in your Word document:");
        
        ArrayList<HashMap<String, String>> tabs = new ArrayList<HashMap<String, String>>();
        HashMap<String, String> tab1 = new HashMap<String, String>();
        tab1.put("position", "2000");
        HashMap<String, String> tab2 = new HashMap<String, String>();
        tab2.put("position", "4000");
        HashMap<String, String> tab3 = new HashMap<String, String>();
        tab3.put("position", "6000");
        tabs.add(tab1);
        tabs.add(tab2);
        tabs.add(tab3);
        
        OptionsParagraph paragraphOptions = new OptionsParagraph();
        paragraphOptions.setTabPositions(tabs);
        
        OptionsText textOptionsA = new OptionsText();
        textOptionsA.setText("one");
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText("two");
        textOptionsB.setTab(true);
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        OptionsText textOptionsC = new OptionsText();
        textOptionsC.setText("three");
        textOptionsC.setTab(true);
        WordFragment textFragmentC = new WordFragment(docx);
        textFragmentC.addText(textOptionsC);
        
        ArrayList<WordFragment> text = new ArrayList<WordFragment>();
        text.add(textFragmentA);
        text.add(textFragmentB);
        text.add(textFragmentC);
        
        docx.addText(text, paragraphOptions);
        
        tabs = new ArrayList<HashMap<String, String>>();
        tab1 = new HashMap<String, String>();
        tab1.put("position", "1000");
        tab2 = new HashMap<String, String>();
        tab2.put("position", "3000");
        tab3 = new HashMap<String, String>();
        tab3.put("type", "center");
        tab3.put("leader", "dot");
        tab3.put("position", "4000");
        tabs.add(tab1);
        tabs.add(tab2);
        tabs.add(tab3);
        
        paragraphOptions = new OptionsParagraph();
        paragraphOptions.setTabPositions(tabs);
        
        docx.addText(text, paragraphOptions);
        
        tabs = new ArrayList<HashMap<String, String>>();
        tab1 = new HashMap<String, String>();
        tab1.put("position", "1500");
        tab2 = new HashMap<String, String>();
        tab2.put("position", "5000");
        tab3 = new HashMap<String, String>();
        tab3.put("type", "center");
        tab3.put("leader", "dot");
        tab3.put("position", "7000");
        tabs.add(tab1);
        tabs.add(tab2);
        tabs.add(tab3);
        
        paragraphOptions = new OptionsParagraph();
        paragraphOptions.setTabPositions(tabs);
        
        textOptionsA = new OptionsText();
        textOptionsA.setText("one");
        textOptionsA.setTab(true);
        textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        textOptionsB = new OptionsText();
        textOptionsB.setText("two");
        textOptionsB.setTab(true);
        textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        textOptionsC = new OptionsText();
        textOptionsC.setText("three");
        textOptionsC.setTab(true);
        textFragmentC = new WordFragment(docx);
        textFragmentC.addText(textOptionsC);
        
        text = new ArrayList<WordFragment>();
        text.add(textFragmentA);
        text.add(textFragmentB);
        text.add(textFragmentC);
        
        docx.addText(text, paragraphOptions);
        
        docx.createDocx("example_addText_4");
    }
}

The resulting Word document looks like: