addBreak

line: inserts a standard line break.
column: inserts a column break, i.e. the text restarts to be rendered in the next column if the section has more than one column.
page: the contents continue in the next available page.

You may also include a line or column break in the middle of a paragraph via the addText method.

Parameters

options

The possible keys and values are (required options are shown with yellow background):

Option	Type	Description
type	String	The possible values are: "line", "column" and "page".
number	Integer	The number of breaks to add.

Code samples

Example #1

package examples.Core.addBreak;

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

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsText textOptions = new OptionsText();
        textOptions.setText("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.");
        docx.addText(textOptions);
        docx.addText(textOptions);
        
        OptionsBreak breakOptions = new OptionsBreak();
        breakOptions.setType("line");
        docx.addBreak(breakOptions);
        docx.addText(textOptions);
        
        breakOptions = new OptionsBreak();
        breakOptions.setType("line");
        breakOptions.setNumber(2);
        docx.addBreak(breakOptions);
        
        docx.addText(textOptions);
        
        breakOptions = new OptionsBreak();
        breakOptions.setType("page");
        docx.addBreak(breakOptions);
        
        docx.addText(textOptions);
        
        docx.createDocx("example_addBreak_1");
    }
}

Example #2

package examples.Core.addBreak;

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("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText("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.");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        OptionsBreak breakOptions = new OptionsBreak();
        WordFragment breakFragment = new WordFragment(docx); 
        breakFragment.addBreak(breakOptions);
        
        ArrayList<WordFragment> runs = new ArrayList<WordFragment>();
        runs.add(textFragmentA);
        runs.add(breakFragment);
        runs.add(textFragmentB);
        
        docx.addText(runs);
        
        docx.createDocx("example_addBreak_2");
    }
}

The resulting Word document looks like: