java.lang.ObjectField
com.aspose.words.FieldToa
public class FieldToa
Example:
public void fieldTOA() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a TOA field, which will list all the TA entries in the document,
// displaying long citations and page numbers for each
FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false);
// Set the entry category for our table
// For a TA field to be included in this table, it will have to have a matching entry category
fieldToa.setEntryCategory("1");
// Moreover, the Table of Authorities category at index 1 is "Cases",
// which will show up as the title of our table if we set this variable to true
fieldToa.setUseHeading(true);
// We can further filter TA fields by designating a named bookmark that they have to be inside of
fieldToa.setBookmarkName("MyBookmark");
// By default, a dotted line page-wide tab appears between the TA field's citation and its page number
// We can replace it with any text we put in this attribute, even preserving the tab if we use tab character
fieldToa.setEntrySeparator(" \t p.");
// If we have multiple TA entries that share the same long citation,
// all their respective page numbers will show up on one row,
// and the page numbers separated by a string specified here
fieldToa.setPageNumberListSeparator(" & p. ");
// To reduce clutter, we can set this to true to get our table to display the word "passim"
// if there would be 5 or more page numbers in one row
fieldToa.setUsePassim(true);
// One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers
fieldToa.setPageRangeSeparator(" to ");
// The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable
fieldToa.setRemoveEntryFormatting(true);
builder.getFont().setColor(Color.GREEN);
builder.getFont().setName("Arial Black");
Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f");
builder.insertBreak(BreakType.PAGE_BREAK);
// We will insert a TA entry using a document builder
// This entry is outside the bookmark specified by our table, so it won't be displayed
FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1");
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\"");
// This entry is inside the bookmark,
// but the entry category doesn't match that of the table, so it will also be omitted
builder.startBookmark("MyBookmark");
fieldTA = insertToaEntry(builder, "2", "Source 2");
// This entry will appear in the table
fieldTA = insertToaEntry(builder, "1", "Source 3");
// Short citations aren't displayed by a TOA table,
// but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference
fieldTA.setShortCitation("S.3");
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3");
// The page number can be made to appear bold and/or italic
// This will still be displayed if our table is set to ignore formatting
fieldTA = insertToaEntry(builder, "1", "Source 2");
fieldTA.isBold(true);
fieldTA.isItalic(true);
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i");
// We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on
// Note that this entry refers to the same source as the one above, so they will share one row in our table,
// displaying the page number of the entry above as well as the page range of this entry,
// with the table's page list and page number range separators between page numbers
fieldTA = insertToaEntry(builder, "1", "Source 3");
fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark");
builder.startBookmark("MyMultiPageBookmark");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertBreak(BreakType.PAGE_BREAK);
builder.endBookmark("MyMultiPageBookmark");
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark");
// Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it
for (int i = 0; i < 5; i++) {
insertToaEntry(builder, "1", "Source 4");
}
builder.endBookmark("MyBookmark");
doc.updateFields();
doc.save(getArtifactsDir() + "Field.TOA.TA.docx");
}
/// <summary>
/// Get a builder to insert a TA field, specifying its long citation and category,
/// then insert a page break and return the field we created.
/// </summary>
private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception {
FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false);
field.setEntryCategory(entryCategory);
field.setLongCitation(longCitation);
builder.insertBreak(BreakType.PAGE_BREAK);
return field;
}
Constructor Summary |
---|
FieldToa()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getBookmarkName() | |
void | setBookmarkName(java.lang.String value) | |
Gets or sets the name of the bookmark that marks the portion of the document used to build the table. | ||
java.lang.String | getDisplayResult() | → inherited from Field |
Gets the text that represents the displayed field result. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
java.lang.String | getEntryCategory() | |
void | setEntryCategory(java.lang.String value) | |
Gets or sets the integral category for entries included in the table. | ||
java.lang.String | getEntrySeparator() | |
void | setEntrySeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate a table of authorities entry and its page number. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | isDirty() | → inherited from Field |
void | isDirty(boolean value) | |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getPageNumberListSeparator() | |
void | setPageNumberListSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate two page numbers in a page number list. | ||
java.lang.String | getPageRangeSeparator() | |
void | setPageRangeSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate the start and end of a page range. | ||
boolean | getRemoveEntryFormatting() | |
void | setRemoveEntryFormatting(boolean value) | |
Gets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities. | ||
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
Gets or sets text that is between the field separator and field end. | ||
FieldSeparator | getSeparator() | → inherited from Field |
Gets the node that represents the field separator. Can be null. | ||
java.lang.String | getSequenceName() | |
void | setSequenceName(java.lang.String value) | |
Gets or sets the name of a sequence whose number is included with the page number. | ||
java.lang.String | getSequenceSeparator() | |
void | setSequenceSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate sequence numbers and page numbers. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. | ||
boolean | getUseHeading() | |
void | setUseHeading(boolean value) | |
Gets or sets whether to include the category heading for the entries in a table of authorities. | ||
boolean | getUsePassim() | |
void | setUsePassim(boolean value) | |
Gets or sets whether to replace five or more different page references to the same authority with "passim", which is used to indicate that a word or passage occurs frequently in the work cited. |
Method Summary | ||
---|---|---|
java.lang.String | getFieldCode() | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. | ||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). | ||
Node | remove() | → inherited from Field |
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null. | ||
boolean | unlink() | → inherited from Field |
Performs the field unlink. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. | ||
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldToa()
Property Getters/Setters Detail |
---|
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getDisplayResult | → inherited from Field |
public java.lang.String getDisplayResult() |
Example:
Shows how to get the text that represents the displayed field result.Document document = new Document(getMyDir() + "Various fields.docx"); FieldCollection fields = document.getRange().getFields(); Assert.assertEquals("111", fields.get(0).getDisplayResult()); Assert.assertEquals("222", fields.get(1).getDisplayResult()); Assert.assertEquals("Multi\rLine\rText", fields.get(2).getDisplayResult()); Assert.assertEquals("%", fields.get(3).getDisplayResult()); Assert.assertEquals("Macro Button Text", fields.get(4).getDisplayResult()); Assert.assertEquals("", fields.get(5).getDisplayResult()); // Method must be called to obtain correct value for the "FieldListNum", "FieldAutoNum", // "FieldAutoNumOut" and "FieldAutoNumLgl" fields document.updateListLabels(); Assert.assertEquals("1)", fields.get(5).getDisplayResult());
getEnd | → inherited from Field |
public FieldEnd getEnd() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getEntryCategory/setEntryCategory | |
public java.lang.String getEntryCategory() / public void setEntryCategory(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getEntrySeparator/setEntrySeparator | |
public java.lang.String getEntrySeparator() / public void setEntrySeparator(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getFormat | → inherited from Field |
public FieldFormat getFormat() |
Example:
Shows how to format fields.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Use a document builder to insert field with no format Field field = builder.insertField("= 2 + 3"); // We can format our field here instead of in the field code FieldFormat format = field.getFormat(); format.setNumericFormat("$###.00"); field.update(); Assert.assertEquals("$ 5.00", field.getResult()); // Apply a date/time format field = builder.insertField("DATE"); format = field.getFormat(); format.setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}"); // Apply 2 general formats at the same time field = builder.insertField("= 25 + 33"); format = field.getFormat(); format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN); format.getGeneralFormats().add(GeneralFormat.UPPER); field.update(); int index = 0; Iterator<Integer> generalFormatEnumerator = format.getGeneralFormats().iterator(); while (generalFormatEnumerator.hasNext()) { System.out.println(MessageFormat.format("General format index {0}: {1}", index++, generalFormatEnumerator.toString())); } Assert.assertEquals("LVIII", field.getResult()); Assert.assertEquals(2, format.getGeneralFormats().getCount()); Assert.assertEquals(format.getGeneralFormats().get(0), GeneralFormat.LOWERCASE_ROMAN); // Removing field formats format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN); format.getGeneralFormats().removeAt(0); Assert.assertEquals(format.getGeneralFormats().getCount(), 0); field.update(); // Our field has no general formats left and is back to default form Assert.assertEquals(field.getResult(), "58");
isDirty/isDirty | → inherited from Field |
public boolean isDirty() / public void isDirty(boolean value) |
Example:
Shows how to use special property for updating field result.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Give the document's built in property "Author" a value and display it with a field doc.getBuiltInDocumentProperties().setAuthor("John Doe"); FieldAuthor field = (FieldAuthor) builder.insertField(FieldType.FIELD_AUTHOR, true); Assert.assertFalse(field.isDirty()); Assert.assertEquals("John Doe", field.getResult()); // Update the "Author" property doc.getBuiltInDocumentProperties().setAuthor("John & Jane Doe"); // AUTHOR is one of the field types whose fields do not update according to their source values in real time, // and need to be updated manually beforehand every time an accurate value is required Assert.assertEquals("John Doe", field.getResult()); // Since the field's value is out of date, we can mark it as "Dirty" field.isDirty(true); OutputStream docStream = new FileOutputStream(getArtifactsDir() + "Filed.UpdateDirtyFields.docx"); try { doc.save(docStream, SaveFormat.DOCX); // Re-open the document from the stream while using a LoadOptions object to specify // whether to update all fields marked as "Dirty" in the process, so they can display accurate values immediately LoadOptions options = new LoadOptions(); options.setUpdateDirtyFields(doUpdateDirtyFields); doc = new Document(String.valueOf(docStream), options); Assert.assertEquals("John & Jane Doe", doc.getBuiltInDocumentProperties().getAuthor()); field = (FieldAuthor) doc.getRange().getFields().get(0); if (doUpdateDirtyFields) { Assert.assertEquals("John & Jane Doe", field.getResult()); Assert.assertFalse(field.isDirty()); } else { Assert.assertEquals("John Doe", field.getResult()); Assert.assertTrue(field.isDirty()); } } finally { if (docStream != null) docStream.close(); }
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
Example:
Demonstrates how to retrieve the field class from an existing FieldStart node in the document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true); field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); FieldChar fieldStart = field.getStart(); Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType()); Assert.assertEquals(false, fieldStart.isDirty()); Assert.assertEquals(false, fieldStart.isLocked()); // Retrieve the facade object which represents the field in the document field = (FieldDate) fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode()); // This updates only this field in the document field.update();
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
Example:
Shows how to insert a field and work with its locale.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a DATE field and print the date it will display, formatted according to your thread's current culture Field field = builder.insertField("DATE"); System.out.println(MessageFormat.format("Today's date, as displayed in the \"{0}\" culture: {1}", Locale.getDefault().getDisplayName(), field.getResult())); Assert.assertEquals(1033, field.getLocaleId()); // We can get the field to display a date in a different format if we change the current thread's culture // If we want to avoid making such an all encompassing change, // we can set this option to get the document's fields to get their culture from themselves // Then, we can change a field's LocaleId and it will display its result in any culture we choose doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE); field.setLocaleId(1031); field.update(); System.out.println(MessageFormat.format("Today's date, as displayed according to the \"{0}\" culture: {1}", field.getLocaleId(), field.getResult()));
getPageNumberListSeparator/setPageNumberListSeparator | |
public java.lang.String getPageNumberListSeparator() / public void setPageNumberListSeparator(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getPageRangeSeparator/setPageRangeSeparator | |
public java.lang.String getPageRangeSeparator() / public void setPageRangeSeparator(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getRemoveEntryFormatting/setRemoveEntryFormatting | |
public boolean getRemoveEntryFormatting() / public void setRemoveEntryFormatting(boolean value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getSequenceName/setSequenceName | |
public java.lang.String getSequenceName() / public void setSequenceName(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getSequenceSeparator/setSequenceSeparator | |
public java.lang.String getSequenceSeparator() / public void setSequenceSeparator(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getStart | → inherited from Field |
public FieldStart getStart() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getType | → inherited from Field |
public int getType() |
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
getUseHeading/setUseHeading | |
public boolean getUseHeading() / public void setUseHeading(boolean value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getUsePassim/setUsePassim | |
public boolean getUsePassim() / public void setUsePassim(boolean value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
Example:
Shows how to get text between field start and field separator (or field end if there is no separator).// Open a document which contains a MERGEFIELD inside an IF field Document doc = new Document(getMyDir() + "Nested fields.docx"); // Get the outer IF field and print its full field code FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0); System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}"); // All inner nested fields are printed by default Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true)); // Print the field code again but this time without the inner MERGEFIELD System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
includeChildFieldCodes
- True
if child field codes should be included.
Example:
Shows how to get text between field start and field separator (or field end if there is no separator).// Open a document which contains a MERGEFIELD inside an IF field Document doc = new Document(getMyDir() + "Nested fields.docx"); // Get the outer IF field and print its full field code FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0); System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}"); // All inner nested fields are printed by default Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true)); // Print the field code again but this time without the inner MERGEFIELD System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");
remove | → inherited from Field |
public Node remove() throws java.lang.Exception |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
unlink | → inherited from Field |
public boolean unlink() throws java.lang.Exception |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
Example:
Shows how to unlink specific field.Document doc = new Document(getMyDir() + "Linked fields.docx"); doc.getRange().getFields().get(1).unlink();
update | → inherited from Field |
public void update() throws java.lang.Exception |
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
update | → inherited from Field |
public void update(boolean ignoreMergeFormat) throws java.lang.Exception |
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.
Example:
Shows a way to update a field ignoring the MERGEFORMAT switch.LoadOptions loadOptions = new LoadOptions(); { loadOptions.setPreserveIncludePictureField(true); } Document doc = new Document(getMyDir() + "Field sample - INCLUDEPICTURE.docx", loadOptions); for (Field field : doc.getRange().getFields()) { if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) { FieldIncludePicture includePicture = (FieldIncludePicture) field; includePicture.setSourceFullName(getImageDir() + "Transparent background logo.png"); includePicture.update(true); doc.updateFields(); doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");