addList

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

removeSection

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

stream

ENCRYPT

encryptPDF

addList

BASIC / ADVANCED / PREMIUM

Inserts (nested) lists into the Word document.

Description

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 allows the insertion of lists (numbered or with bullets) into your Word document.

You may also include nested lists by means of nested arrays of data and fully customize its contents with the use of WordML fragments.

The following style types are always available:

Clear: with no bullet or indentation. This is the default value.
Unordered: the standard bulleted list of Word.
Ordered: the standard ordered list of Word.

You may also use the list styles created via the createListStyle method using the name you gave to your custom list.

Parameters

itemList

The ArrayList of data with the (nested) list of items. The possible values of each array entry are:

A string of text.
An inline WordFragment: all block elements are removed prior to insertion.
An ArrayList.

styleType

0 (clear), 1 (inordinate) (default), 2 (numerical) or the name of the created list

options

Option	Type	Description
bold	Boolean	If true the text will be shown in bold characters.
caps	Boolean	If true displays text in capital letters.
color	String	Hexadecimal color value: "FF0000", "000000"...
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.
numId	positive Integer	Sets a numId value. Useful to generate a continue numbering.
outlineLvl	Integer	Heading level (1-9).
pStyle	String	Word style to be used.
smallCaps	Boolean	If true displays text in small capital letters.
underline	String	Underlines text. Possible values are: single, words, double, dotted, dash and wave.
useWordFragmentStyles	Boolean	Use WordFragment paragraph styles.

Code samples

Example #1

package examples.Core.addList;

import java.util.ArrayList;

import com.javadocx.CreateDocx;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        ArrayList<String> itemList = new ArrayList<String>();
        itemList.add("Line 1");
        itemList.add("Line 2");
        itemList.add("Line 3");
        itemList.add("Line 4");
        itemList.add("Line 5");
        
        docx.addList(itemList, "1");
        
        docx.createDocx("example_addList_1");
    }
}

The resulting Word document looks like:

Example #2

package examples.Core.addList;

import java.util.ArrayList;

import com.javadocx.CreateDocx;

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        ArrayList itemList = new ArrayList();
        itemList.add("Line 1");
        
        ArrayList itemSubList = new ArrayList();
        itemSubList.add("Line A");
        itemSubList.add("Line B");
        itemSubList.add("Line C");
        
        itemList.add(itemSubList);
        
        itemList.add("Line 2");
        itemList.add("Line 3");
        
        docx.addList(itemList, "2");
        
        docx.createDocx("example_addList_2");
    }
}

The resulting Word document looks like:

Example #3

package examples.Core.addList;

import java.util.ArrayList;

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

public class Sample3 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsText textOptions = new OptionsText();
        textOptions.setText("We insert some ");
        WordFragment textFragment = new WordFragment(docx);
        textFragment.addText(textOptions);
        
        textOptions = new OptionsText();
        textOptions.setText("bold text")
                   .setBold(true);
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptions);
        
        ArrayList<WordFragment> textRuns = new ArrayList<WordFragment>();
        textRuns.add(textFragment);
        textRuns.add(textFragmentB);
        
        WordFragment runs = new WordFragment(docx);
        runs.addText(textRuns);
        
        ArrayList itemList = new ArrayList();
        itemList.add("In this example we use a custom list (val = 5) that comes bundled with the default Javadocx template.");
        
        ArrayList itemSubList = new ArrayList();
        itemSubList.add(runs);
        itemSubList.add("Line B");
        itemSubList.add("Line C");
        
        itemList.add(itemSubList);
        
        itemList.add("Line 3");
        
        docx.addList(itemList, "5");
        
        docx.createDocx("example_addList_3");
    }
}

Example #4

package examples.Core.addList;

import java.util.ArrayList;

import com.javadocx.CreateDocx;
import com.javadocx.elements.OptionsList;

public class Sample4 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        ArrayList<String> itemList = new ArrayList<String>();
        itemList.add("Line 1");
        itemList.add("Line 2");
        itemList.add("Line 3");
        itemList.add("Line 4");
        itemList.add("Line 5");
        
        OptionsList listOptions = new OptionsList();
        listOptions.setFont("Arial")
                   .setItalic(true)
                   .setFontSize(14)
                   .setColor("B70000");
        
        docx.addList(itemList, "1", listOptions);
        
        docx.createDocx("example_addList_4");
    }
}

The resulting Word document looks like: