TxtExportHeadersFootersMode

Inheritance: java.lang.Object

public class TxtExportHeadersFootersMode

Specifies the way headers and footers are exported to plain text format.

Examples:

Shows how to specify how to export headers and footers to plain text format.

 Document doc = new Document();

 // Insert even and primary headers/footers into the document.
 // The primary header/footers will override the even headers/footers.
 doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.HEADER_EVEN));
 doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_EVEN).appendParagraph("Even header");
 doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.FOOTER_EVEN));
 doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_EVEN).appendParagraph("Even footer");
 doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY));
 doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_PRIMARY).appendParagraph("Primary header");
 doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY));
 doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY).appendParagraph("Primary footer");

 // Insert pages to display these headers and footers.
 DocumentBuilder builder = new DocumentBuilder(doc);
 builder.writeln("Page 1");
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.writeln("Page 2");
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.write("Page 3");

 // Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
 // to modify how we save the document to plaintext.
 TxtSaveOptions saveOptions = new TxtSaveOptions();

 // Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.None"
 // to not export any headers/footers.
 // Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.PrimaryOnly"
 // to only export primary headers/footers.
 // Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.AllAtEnd"
 // to place all headers and footers for all section bodies at the end of the document.
 saveOptions.setExportHeadersFootersMode(txtExportHeadersFootersMode);

 doc.save(getArtifactsDir() + "TxtSaveOptions.ExportHeadersFooters.txt", saveOptions);

 String docText = new Document(getArtifactsDir() + "TxtSaveOptions.ExportHeadersFooters.txt").getText().trim();

 switch (txtExportHeadersFootersMode) {
     case TxtExportHeadersFootersMode.ALL_AT_END:
         Assert.assertEquals("Page 1\r" +
                 "Page 2\r" +
                 "Page 3\r" +
                 "Even header\r\r" +
                 "Primary header\r\r" +
                 "Even footer\r\r" +
                 "Primary footer", docText);

         break;
     case TxtExportHeadersFootersMode.PRIMARY_ONLY:
         Assert.assertEquals("Primary header\r" +
                 "Page 1\r" +
                 "Page 2\r" +
                 "Page 3\r" +
                 "Primary footer", docText);
         break;
     case TxtExportHeadersFootersMode.NONE:
         Assert.assertEquals("Page 1\r" +
                 "Page 2\r" +
                 "Page 3", docText);
         break;
 }
 

Fields

Field	Description
ALL_AT_END	All headers and footers are placed after all section bodies at the very end of a document.
NONE	No headers and footers are exported.
PRIMARY_ONLY	Only primary headers and footers are exported at the beginning and end of each section.
length

Methods

Method	Description
fromName(String txtExportHeadersFootersModeName)
getName(int txtExportHeadersFootersMode)
getValues()
toString(int txtExportHeadersFootersMode)

ALL_AT_END

public static int ALL_AT_END

All headers and footers are placed after all section bodies at the very end of a document.

Remarks:

This mode is similar to Word.

NONE

public static int NONE

No headers and footers are exported.

PRIMARY_ONLY

public static int PRIMARY_ONLY

Only primary headers and footers are exported at the beginning and end of each section.

Remarks:

It is hard to meaningfully output headers and footers to plain text because it is not paginated.

When this mode is used, only primary headers and footers are exported at the beginning and end of each section.

length

public static int length

fromName(String txtExportHeadersFootersModeName)

public static int fromName(String txtExportHeadersFootersModeName)

Parameters:

Parameter	Type	Description
txtExportHeadersFootersModeName	java.lang.String

Returns: int

getName(int txtExportHeadersFootersMode)

public static String getName(int txtExportHeadersFootersMode)

Parameters:

Parameter	Type	Description
txtExportHeadersFootersMode	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int txtExportHeadersFootersMode)

public static String toString(int txtExportHeadersFootersMode)

Parameters:

Parameter	Type	Description
txtExportHeadersFootersMode	int

Returns: java.lang.String