public class TxtExportHeadersFootersMode
extends java.lang.Object
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;
}
| Modifier and Type | Field and Description |
|---|---|
static int |
ALL_AT_END
All headers and footers are placed after all section bodies at the very end of a document.
|
static int |
length |
static int |
NONE
No headers and footers are exported.
|
static int |
PRIMARY_ONLY
Only primary headers and footers are exported at the beginning and end of each section.
|
| Modifier and Type | Method and Description |
|---|---|
static int |
fromName(java.lang.String txtExportHeadersFootersModeName) |
static java.lang.String |
getName(int txtExportHeadersFootersMode) |
static int[] |
getValues() |
static java.lang.String |
toString(int txtExportHeadersFootersMode) |
public static int NONE
public static int PRIMARY_ONLY
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.
public static int ALL_AT_END
Remarks:
This mode is similar to Word.
public static int length
public static java.lang.String getName(int txtExportHeadersFootersMode)
public static java.lang.String toString(int txtExportHeadersFootersMode)
public static int fromName(java.lang.String txtExportHeadersFootersModeName)
public static int[] getValues()