Practical javadocx

Adding content to a document

Introduction

To explain how the library works, let's create a new empty file and add different types of content to it: heading, paragraphs, lists, tables and page breaks.

New document

As a first step, create the document, instantiating the class CreateDocx:

CreateDocx docx = new CreateDocx();

Now, add the new contents for this docx object, always following the visualization order.

Headings

Headings are strings highlighted in the document. To add a heading, call addHeading:

public void addHeading(String text)

public void addHeading(String text, Integer level)

public void addHeading(String text, Integer level, OptionsHeading options)

text is the string, level is the heading level and options is the text properties as color, spacing or bold properties, underline, and so on.

For this document insert a text line with color and font size 24:

OptionsHeading headingOptions = new OptionsHeading();
headingOptions.setColor("8A3900")
              .setFontSize(24);

docx.addHeading("MOST USED WEB BROWSER", 1, headingOptions);

Paragraphs

The method for adding paragraphs is addText:

public void addText(String text)

public void addText(OptionsText textOptions)

public void addText(String text, OptionsParagraph paragraphOptions)

public void addText(OptionsText textOptions, OptionsParagraph paragraphOptions)

public void addText(ArrayList<WordFragment> textOptions)

public void addText(ArrayList<WordFragment> wordFragments, OptionsParagraph paragraphOptions)

The first parameter can be a string, an OptionText object or an ArrayList

The second parameter is optional. It defines the properties of the paragraph, like background color, border, alignment and spacing.

Now, add to the document a string with background and text color:

OptionsParagraph paragraphOptions = new OptionsParagraph();
paragraphOptions.setBackgroundColor("E74710")
                .setColor("FFFFFF");

docx.addText("GENERAL INFORMATION", paragraphOptions);

If you prefer to add two or more strings, create a new ArrayList with the text WordFragments to be added. For example:

OptionsText textOptionsA = new OptionsText();
textOptionsA.setText("We’ve added a few tips (like this one) to help you get started.");
WordFragment textFragmentA = new WordFragment(docx);
textFragmentA.addText(textOptionsA);

OptionsText textOptionsB = new OptionsText();
textOptionsB.setText(" When you click tip text, the whole tip is selected. Just start typing to replace it with your own.")
            .setBold(true);
WordFragment textFragmentB = new WordFragment(docx);
textFragmentB.addText(textOptionsB);

ArrayList<WordFragment> contents = new ArrayList<WordFragment>();

contents.add(textFragmentA);
contents.add(textFragmentB);

docx.addText(contents);

The "text" option is used for adding the text. The bold font type is enabled in the second paragraph only.

Lists

addList is the method for adding lists to a document:

public void addList(ArrayList data) throws Exception

public void addList(ArrayList data, String styleType) throws Exception

public void addList(ArrayList data, String styleType, OptionsList options) throws Exception

This method includes the following parameters:

data, ArrayList with the information to add to the list
styleType, for list types:

"0", list without styles
"1", unordered lists
"2", ordered lists
a custom list style

options, for colors and other text properties

Let's add an ordered list of Internet browsers to the document:

ArrayList<String> itemList = new ArrayList<String>();
itemList.add("Google Chrome");
itemList.add("Mozilla Firefox");
itemList.add("Internet Explorer");

docx.addList(itemList, "2");

To nest lists, just add new ArrayList elements as values. For example:

ArrayList itemList = new ArrayList();

ArrayList itemSubList = new ArrayList();
itemSubList.add("2013");
itemSubList.add("2014");
itemSubList.add("2015");

itemList.add("Google Chrome");
itemList.add(itemSubList);
itemList.add("Mozilla Firefox");
itemList.add("Internet Explorer");

Tables

Including tables is very similar to adding lists, but you must work with nested ArrayList elements to define the text and its properties.

You need to use addTable:

public void addTable(ArrayList<ArrayList<OptionsTableData>> tableData)

public void addTable(ArrayList<ArrayList<OptionsTableData>> tableData, OptionsTableProperties tableProperties)

public void addTable(ArrayList<ArrayList<OptionsTableData>> tableData, OptionsTableProperties tableProperties, ArrayList<OptionsTableRow> rowProperties)

The taleData parameter is an ArrayList which can contain the contents to be added. The other two parameters define the table global properties and particular row properties such as borders, sizes and spans.

ArrayList<OptionsTableData> valuesRow1 = new ArrayList<OptionsTableData>();
        
OptionsParagraph paragraphOptions = new OptionsParagraph();
paragraphOptions.setBold(true)
                .setFont("Algerian")
                .setFontSize(18);

OptionsTableData valuesRow1Cell1 = new OptionsTableData();
WordFragment textFragmentRow1Cell1 = new WordFragment(docx);
textFragmentRow1Cell1.addText("11", paragraphOptions);
valuesRow1Cell1.setValue(textFragmentRow1Cell1);

OptionsTableData valuesRow1Cell2 = new OptionsTableData();
WordFragment textFragmentRow1Cell2 = new WordFragment(docx);
textFragmentRow1Cell2.addText("12", paragraphOptions);
valuesRow1Cell2.setValue(textFragmentRow1Cell2);

OptionsTableData valuesRow1Cell3 = new OptionsTableData();
WordFragment textFragmentRow1Cell3 = new WordFragment(docx);
textFragmentRow1Cell3.addText("13", paragraphOptions);
valuesRow1Cell3.setValue(textFragmentRow1Cell3);

OptionsTableData valuesRow1Cell4 = new OptionsTableData();
WordFragment textFragmentRow1Cell4 = new WordFragment(docx);
textFragmentRow1Cell4.addText("14", paragraphOptions);
valuesRow1Cell4.setValue(textFragmentRow1Cell4);

valuesRow1.add(valuesRow1Cell1);
valuesRow1.add(valuesRow1Cell2);
valuesRow1.add(valuesRow1Cell3);
valuesRow1.add(valuesRow1Cell4);

ArrayList<OptionsTableData> valuesRow2 = new ArrayList<OptionsTableData>();

OptionsTableData valuesRow2Cell1 = new OptionsTableData();
WordFragment textFragmentRow2Cell1 = new WordFragment(docx);
textFragmentRow2Cell1.addText("21", paragraphOptions);
valuesRow2Cell1.setValue(textFragmentRow2Cell1);

OptionsTableData valuesRow2Cell2 = new OptionsTableData();
WordFragment textFragmentRow2Cell2 = new WordFragment(docx);
textFragmentRow2Cell2.addText("22", paragraphOptions);
valuesRow2Cell2.setValue(textFragmentRow2Cell2);

OptionsTableData valuesRow2Cell3 = new OptionsTableData();
WordFragment textFragmentRow2Cell3 = new WordFragment(docx);
textFragmentRow2Cell3.addText("23", paragraphOptions);
valuesRow2Cell3.setValue(textFragmentRow2Cell3);

OptionsTableData valuesRow2Cell4 = new OptionsTableData();
WordFragment textFragmentRow2Cell4 = new WordFragment(docx);
textFragmentRow2Cell4.addText("24", paragraphOptions);
valuesRow2Cell4.setValue(textFragmentRow2Cell4);

valuesRow2.add(valuesRow2Cell1);
valuesRow2.add(valuesRow2Cell2);
valuesRow2.add(valuesRow2Cell3);
valuesRow2.add(valuesRow2Cell4);

ArrayList<OptionsTableData> valuesRow3 = new ArrayList<OptionsTableData>();

OptionsTableData valuesRow3Cell1 = new OptionsTableData();
WordFragment textFragmentRow3Cell1 = new WordFragment(docx);
textFragmentRow3Cell1.addText("31", paragraphOptions);
valuesRow3Cell1.setValue(textFragmentRow3Cell1);

OptionsTableData valuesRow3Cell2 = new OptionsTableData();
WordFragment textFragmentRow3Cell2 = new WordFragment(docx);
textFragmentRow3Cell2.addText("32", paragraphOptions);
valuesRow3Cell2.setValue(textFragmentRow3Cell2);

OptionsTableData valuesRow3Cell3 = new OptionsTableData();
WordFragment textFragmentRow3Cell3 = new WordFragment(docx);
textFragmentRow3Cell3.addText("33", paragraphOptions);
valuesRow3Cell3.setValue(textFragmentRow3Cell3);

OptionsTableData valuesRow3Cell4 = new OptionsTableData();
WordFragment textFragmentRow3Cell4 = new WordFragment(docx);
textFragmentRow3Cell4.addText("34", paragraphOptions);
valuesRow3Cell4.setValue(textFragmentRow3Cell4);

valuesRow3.add(valuesRow3Cell1);
valuesRow3.add(valuesRow3Cell2);
valuesRow3.add(valuesRow3Cell3);
valuesRow3.add(valuesRow3Cell4);

ArrayList<ArrayList<OptionsTableData>> valuesTable = new ArrayList<ArrayList<OptionsTableData>>();
valuesTable.add(valuesRow1);
valuesTable.add(valuesRow2);
valuesTable.add(valuesRow3);

OptionsTableProperties tableProperties = new OptionsTableProperties();
tableProperties.setBorder("single")
               .setTableAlign("center")
               .setBorderWidth(10)
               .setBorderColor("B70000");

docx.addTable(valuesTable, tableProperties);

Page and line breaks

To make page or line breaks, use addBreak:

public void addBreak()

public void addBreak(OptionsBreak options)

You just need to indicate the type of break, ‘line’ or ‘page’, and the number of breaks to apply.

For example, to make a page break:

OptionsBreak breakOptions = new OptionsBreak();
breakOptions.setType("page");

docx.addBreak(breakOptions);

Links

For adding a link, use the addLink method:

public void addLink(String text, OptionsLink options) throws Exception

The options parameter defines the link destination and the text properties.

Here's a simple example:

OptionsLink linkElement = new OptionsLink();
linkElement.setUrl("http://www.javadocx.com")
           .setColor("B70000")
           .setUnderline("none");

docx.addLink("Link to javadocx", linkElement);

This method links the text to the URL www.javadocx.com with a color and no underline.

Next - Adding content to a template