com.aspose.words

Class BreakType

  • java.lang.Object
    • com.aspose.words.BreakType
public class BreakType 
extends java.lang.Object

Utility class containing constants. Specifies type of a break inside a document.

Example:

Shows how to create headers and footers in a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Specify that we want different headers and footers for first, even and odd pages.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);

// Create the headers, then add three pages to the document to display each header type.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.write("Header for the first page");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.write("Header for even pages");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for all other pages");

builder.moveToSection(0);
builder.writeln("Page1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page3");

doc.save(getArtifactsDir() + "DocumentBuilder.HeadersAndFooters.docx");

Example:

Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");

// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);

Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());

// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();

Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());

builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");

doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");

Example:

Shows how to insert a Table of contents (TOC) into a document using heading styles as entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a table of contents for the first page of the document.
// Configure the table to pick up paragraphs with headings of levels 1 to 3.
// Also, set its entries to be hyperlinks that will take us
// to the location of the heading when left-clicked in Microsoft Word.
builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
builder.insertBreak(BreakType.PAGE_BREAK);

// Populate the table of contents by adding paragraphs with heading styles.
// Each such heading with a level between 1 and 3 will create an entry in the table.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
builder.writeln("Heading 1");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
builder.writeln("Heading 2");
builder.writeln("Heading 3");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 3.1");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
builder.writeln("Heading 3.1.1");
builder.writeln("Heading 3.1.2");
builder.writeln("Heading 3.1.3");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_4);
builder.writeln("Heading 3.1.3.1");
builder.writeln("Heading 3.1.3.2");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 3.2");
builder.writeln("Heading 3.3");

// A table of contents is a field of a type that needs to be updated to show an up-to-date result.
doc.updateFields();
doc.save(getArtifactsDir() + "DocumentBuilder.InsertToc.docx");

Field Summary
static final intPARAGRAPH_BREAK = 0
Break between paragraphs.
static final intPAGE_BREAK = 1
Explicit page break.
static final intCOLUMN_BREAK = 2
Explicit column break.
static final intSECTION_BREAK_CONTINUOUS = 3
Specifies start of new section on the same page as the previous section.
static final intSECTION_BREAK_NEW_COLUMN = 4
Specifies start of new section in the new column.
static final intSECTION_BREAK_NEW_PAGE = 5
Specifies start of new section on a new page.
static final intSECTION_BREAK_EVEN_PAGE = 6
Specifies start of new section on a new even page.
static final intSECTION_BREAK_ODD_PAGE = 7
Specifies start of new section on a odd page.
static final intLINE_BREAK = 8
Explicit line break.
 

    • Field Detail

      • PARAGRAPH_BREAK = 0

        public static final int PARAGRAPH_BREAK
        Break between paragraphs.
      • PAGE_BREAK = 1

        public static final int PAGE_BREAK
        Explicit page break.
      • COLUMN_BREAK = 2

        public static final int COLUMN_BREAK
        Explicit column break.
      • SECTION_BREAK_CONTINUOUS = 3

        public static final int SECTION_BREAK_CONTINUOUS
        Specifies start of new section on the same page as the previous section.
      • SECTION_BREAK_NEW_COLUMN = 4

        public static final int SECTION_BREAK_NEW_COLUMN
        Specifies start of new section in the new column.
      • SECTION_BREAK_NEW_PAGE = 5

        public static final int SECTION_BREAK_NEW_PAGE
        Specifies start of new section on a new page.
      • SECTION_BREAK_EVEN_PAGE = 6

        public static final int SECTION_BREAK_EVEN_PAGE
        Specifies start of new section on a new even page.
      • SECTION_BREAK_ODD_PAGE = 7

        public static final int SECTION_BREAK_ODD_PAGE
        Specifies start of new section on a odd page.
      • LINE_BREAK = 8

        public static final int LINE_BREAK
        Explicit line break.