com.aspose.words
Class InlineStory

java.lang.Object
  Node
      CompositeNode
          com.aspose.words.InlineStory

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

Comment, Footnote

public abstract class InlineStory 
extends CompositeNode

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");

Comment comment = new Comment(doc, "John Doe", "JD", new Date());
builder.getCurrentParagraph().appendChild(comment);
builder.moveTo(comment.appendChild(new Paragraph(doc)));
builder.write("Comment text.");

Assert.assertEquals(new Date(), comment.getDateTime());

// In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. 
doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Add text, and reference it with a footnote. This footnote will place a small superscript reference
// mark after the text that it references and create an entry below the main body text at the bottom of the page.
// This entry will contain the footnote's reference mark and the reference text,
// which we will pass to the document builder's "InsertFootnote" method.
builder.write("Main body text.");
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

// If this property is set to "true", then our footnote's reference mark
// will be its index among all the section's footnotes.
// This is the first footnote, so the reference mark will be "1".
Assert.assertTrue(footnote.isAuto());

// We can move the document builder inside the footnote to edit its reference text. 
builder.moveTo(footnote.getFirstParagraph());
builder.write(" More text added by a DocumentBuilder.");
builder.moveToDocumentEnd();

Assert.assertEquals(footnote.getParagraphs().get(0).toString(SaveFormat.TEXT).trim(), "Footnote text. More text added by a DocumentBuilder.");

builder.write(" More main body text.");
footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

// We can set a custom reference mark which the footnote will use instead of its index number.
footnote.setReferenceMark("RefMark");

Assert.assertFalse(footnote.isAuto());

// A bookmark with the "IsAuto" flag set to true will still show its real index
// even if previous bookmarks display custom reference marks, so this bookmark's reference mark will be a "3".
builder.write(" More main body text.");
footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

Assert.assertTrue(footnote.isAuto());

doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");

public int getCount()

Gets the number of immediate children of this node.

Example:

Shows how to add, update and delete child nodes in a CompositeNode's collection of children.

Document doc = new Document();

// An empty document, by default, has one paragraph.
Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());

// Composite nodes such as our paragraph can contain other composite and inline nodes as children.
Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
Run paragraphText = new Run(doc, "Initial text. ");
paragraph.appendChild(paragraphText);

// Create three more run nodes.
Run run1 = new Run(doc, "Run 1. ");
Run run2 = new Run(doc, "Run 2. ");
Run run3 = new Run(doc, "Run 3. ");

// The document body will not display these runs until we insert them into a composite node
// that itself is a part of the document's node tree, as we did with the first run.
// We can determine where the text contents of nodes that we insert
// appears in the document by specifying an insertion location relative to another node in the paragraph.
Assert.assertEquals("Initial text.", paragraph.getText().trim());

// Insert the second run into the paragraph in front of the initial run.
paragraph.insertBefore(run2, paragraphText);

Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim());

// Insert the third run after the initial run.
paragraph.insertAfter(run3, paragraphText);

Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim());

// Insert the first run to the start of the paragraph's child nodes collection.
paragraph.prependChild(run1);

Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());

// We can modify the contents of the run by editing and deleting existing child nodes.
((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);

Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());

public int getCustomNodeId() / public void setCustomNodeId(int value)

Specifies custom node identifier.

Default is zero.

This identifier can be set and used arbitrarily. For example, as a key to get external data.

Important note, specified value is not saved to an output file and exists only during the node lifetime.

Example:

Shows how to traverse through a composite node's collection of child nodes.

Document doc = new Document();

// Add two runs and one shape as child nodes to the first paragraph of this document.
Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
paragraph.appendChild(new Run(doc, "Hello world! "));

Shape shape = new Shape(doc, ShapeType.RECTANGLE);
shape.setWidth(200.0);
shape.setHeight(200.0);
// Note that the 'CustomNodeId' is not saved to an output file and exists only during the node lifetime.
shape.setCustomNodeId(100);
shape.setWrapType(WrapType.INLINE);
paragraph.appendChild(shape);

paragraph.appendChild(new Run(doc, "Hello again!"));

// Iterate through the paragraph's collection of immediate children,
// and print any runs or shapes that we find within.
NodeCollection children = paragraph.getChildNodes(NodeType.ANY, false);

Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, false).getCount());

for (Node child : (Iterable<Node>) children)
    switch (child.getNodeType()) {
        case NodeType.RUN:
            System.out.println("Run contents:");
            System.out.println(MessageFormat.format("\t\"{0}\"", child.getText().trim()));
            break;
        case NodeType.SHAPE:
            Shape childShape = (Shape)child;
            System.out.println("Shape:");
            System.out.println(MessageFormat.format("\t{0}, {1}x{2}", childShape.getShapeType(), childShape.getWidth(), childShape.getHeight()));
            break;
    }

public DocumentBase getDocument()

Gets the document to which this node belongs.

The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.

Example:

Shows how to create a node and set its owning document.

Document doc = new Document();
Paragraph para = new Paragraph(doc);
para.appendChild(new Run(doc, "Hello world!"));

// We have not yet appended this paragraph as a child to any composite node.
Assert.assertNull(para.getParentNode());

// If a node is an appropriate child node type of another composite node,
// we can attach it as a child only if both nodes have the same owner document.
// The owner document is the document we passed to the node's constructor.
// We have not attached this paragraph to the document, so the document does not contain its text.
Assert.assertEquals(para.getDocument(), doc);
Assert.assertEquals("", doc.getText().trim());

// Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents.
para.getParagraphFormat().setStyleName("Heading 1");

// Add this node to the document, and then verify its contents.
doc.getFirstSection().getBody().appendChild(para);

Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
Assert.assertEquals("Hello world!", doc.getText().trim());

public Node getFirstChild()

Gets the first child of the node.

If there is no first child node, a null is returned.

Example:

Shows how to use a node's NextSibling property to enumerate through its immediate children.

Document doc = new Document(getMyDir() + "Paragraphs.docx");

for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
    System.out.println(Node.nodeTypeToString(node.getNodeType()));
}

Example:

Shows how to traverse a composite node's tree of child nodes.

public void recurseChildren() throws Exception {
    Document doc = new Document(getMyDir() + "Paragraphs.docx");

    // Any node that can contain child nodes, such as the document itself, is composite.
    Assert.assertTrue(doc.isComposite());

    // Invoke the recursive function that will go through and print all the child nodes of a composite node.
    traverseAllNodes(doc, 0);
}

/// <summary>
/// Recursively traverses a node tree while printing the type of each node
/// with an indent depending on depth as well as the contents of all inline nodes.
/// </summary>
public void traverseAllNodes(CompositeNode parentNode, int depth) {
    for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
        System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));

        // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
        if (childNode.isComposite()) {
            System.out.println();
            traverseAllNodes((CompositeNode) childNode, depth + 1);
        } else if (childNode instanceof Inline) {
            System.out.println(MessageFormat.format(" - \"{0}\"", childNode.getText().trim()));
        } else {
            System.out.println();
        }
    }
}

public Paragraph getFirstParagraph()

Gets the first paragraph in the story.

Example:

Shows how to add a comment to a paragraph.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");

Comment comment = new Comment(doc, "John Doe", "JD", new Date());
builder.getCurrentParagraph().appendChild(comment);
builder.moveTo(comment.appendChild(new Paragraph(doc)));
builder.write("Comment text.");

Assert.assertEquals(new Date(), comment.getDateTime());

// In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. 
doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");

Example:

Shows how to insert and customize footnotes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Add text, and reference it with a footnote. This footnote will place a small superscript reference
// mark after the text that it references and create an entry below the main body text at the bottom of the page.
// This entry will contain the footnote's reference mark and the reference text,
// which we will pass to the document builder's "InsertFootnote" method.
builder.write("Main body text.");
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

// If this property is set to "true", then our footnote's reference mark
// will be its index among all the section's footnotes.
// This is the first footnote, so the reference mark will be "1".
Assert.assertTrue(footnote.isAuto());

// We can move the document builder inside the footnote to edit its reference text. 
builder.moveTo(footnote.getFirstParagraph());
builder.write(" More text added by a DocumentBuilder.");
builder.moveToDocumentEnd();

Assert.assertEquals(footnote.getParagraphs().get(0).toString(SaveFormat.TEXT).trim(), "Footnote text. More text added by a DocumentBuilder.");

builder.write(" More main body text.");
footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

// We can set a custom reference mark which the footnote will use instead of its index number.
footnote.setReferenceMark("RefMark");

Assert.assertFalse(footnote.isAuto());

// A bookmark with the "IsAuto" flag set to true will still show its real index
// even if previous bookmarks display custom reference marks, so this bookmark's reference mark will be a "3".
builder.write(" More main body text.");
footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

Assert.assertTrue(footnote.isAuto());

doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");

public Font getFont()

Provides access to the font formatting of the anchor character of this object.

Example:

Shows how to insert InlineStory nodes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);

// Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell.
Table table = new Table(doc);
table.ensureMinimum();

// We can place a table inside a footnote, which will make it appear at the referencing page's footer.
Assert.assertEquals(footnote.getTables().getCount(), 0);
footnote.appendChild(table);
Assert.assertEquals(footnote.getTables().getCount(), 1);
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);

// An InlineStory has an "EnsureMinimum()" method as well, but in this case,
// it makes sure the last child of the node is a paragraph,
// for us to be able to click and write text easily in Microsoft Word.
footnote.ensureMinimum();
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Edit the appearance of the anchor, which is the small superscript number
// in the main text that points to the footnote.
footnote.getFont().setName("Arial");
footnote.getFont().setColor(Color.GREEN);

// All inline story nodes have their respective story types.
Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);

// A comment is another type of inline story.
Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));

// The parent paragraph of an inline story node will be the one from the main document body.
Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph());

// However, the last paragraph is the one from the comment text contents,
// which will be outside the main document body in a speech bubble.
// A comment will not have any child nodes by default,
// so we can apply the EnsureMinimum() method to place a paragraph here as well.
Assert.assertNull(comment.getLastParagraph());
comment.ensureMinimum();
Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Once we have a paragraph, we can move the builder to do it and write our comment.
builder.moveTo(comment.getLastParagraph());
builder.write("My comment.");

Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);

doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

public boolean hasChildNodes()

Returns true if this node has any child nodes.

Example:

Shows how to combine the rows from two tables into one.

Document doc = new Document(getMyDir() + "Tables.docx");

// Below are two ways of getting a table from a document.
// 1 -  From the "Tables" collection of a Body node:
Table firstTable = doc.getFirstSection().getBody().getTables().get(0);

// 2 -  Using the "GetChild" method:
Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true);

// Append all rows from the current table to the next.
while (secondTable.hasChildNodes())
    firstTable.getRows().add(secondTable.getFirstRow());

// Remove the empty table container.
secondTable.remove();

doc.save(getArtifactsDir() + "Table.CombineTables.docx");

public boolean isComposite()

Returns true as this node can have child nodes.

Example:

Shows how to traverse a composite node's tree of child nodes.

public void recurseChildren() throws Exception {
    Document doc = new Document(getMyDir() + "Paragraphs.docx");

    // Any node that can contain child nodes, such as the document itself, is composite.
    Assert.assertTrue(doc.isComposite());

    // Invoke the recursive function that will go through and print all the child nodes of a composite node.
    traverseAllNodes(doc, 0);
}

/// <summary>
/// Recursively traverses a node tree while printing the type of each node
/// with an indent depending on depth as well as the contents of all inline nodes.
/// </summary>
public void traverseAllNodes(CompositeNode parentNode, int depth) {
    for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
        System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));

        // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
        if (childNode.isComposite()) {
            System.out.println();
            traverseAllNodes((CompositeNode) childNode, depth + 1);
        } else if (childNode instanceof Inline) {
            System.out.println(MessageFormat.format(" - \"{0}\"", childNode.getText().trim()));
        } else {
            System.out.println();
        }
    }
}

public boolean isDeleteRevision()

Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

Example:

Shows how to view revision-related properties of InlineStory nodes.

Document doc = new Document(getMyDir() + "Revision footnotes.docx");

// When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
// is turned on in Microsoft Word, the changes we apply count as revisions.
// When editing a document using Aspose.Words, we can begin tracking revisions by
// invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
// We can either accept revisions to assimilate them into the document
// or reject them to undo and discard the proposed change.
Assert.assertTrue(doc.hasRevisions());

NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
Assert.assertEquals(5, footnotes.getCount());

// Below are five types of revisions that can flag an InlineStory node.
// 1 -  An "insert" revision:
// This revision occurs when we insert text while tracking changes.
Footnote footnote = (Footnote) footnotes.get(2);
Assert.assertTrue(footnote.isInsertRevision());

// 2 -  A "move from" revision:
// When we highlight text in Microsoft Word, and then drag it to a different place in the document
// while tracking changes, two revisions appear.
// The "move from" revision is a copy of the text originally before we moved it.
footnote = (Footnote) footnotes.get(4);
Assert.assertTrue(footnote.isMoveFromRevision());

// 3 -  A "move to" revision:
// The "move to" revision is the text that we moved in its new position in the document.
// "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
// Accepting a move revision deletes the "move from" revision and its text,
// and keeps the text from the "move to" revision.
// Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
footnote = (Footnote) footnotes.get(1);
Assert.assertTrue(footnote.isMoveToRevision());

// 4 -  A "delete" revision:
// This revision occurs when we delete text while tracking changes. When we delete text like this,
// it will stay in the document as a revision until we either accept the revision,
// which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
footnote = (Footnote) footnotes.get(3);
Assert.assertTrue(footnote.isDeleteRevision());

public boolean isInsertRevision()

Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

Example:

Shows how to view revision-related properties of InlineStory nodes.

Document doc = new Document(getMyDir() + "Revision footnotes.docx");

// When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
// is turned on in Microsoft Word, the changes we apply count as revisions.
// When editing a document using Aspose.Words, we can begin tracking revisions by
// invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
// We can either accept revisions to assimilate them into the document
// or reject them to undo and discard the proposed change.
Assert.assertTrue(doc.hasRevisions());

NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
Assert.assertEquals(5, footnotes.getCount());

// Below are five types of revisions that can flag an InlineStory node.
// 1 -  An "insert" revision:
// This revision occurs when we insert text while tracking changes.
Footnote footnote = (Footnote) footnotes.get(2);
Assert.assertTrue(footnote.isInsertRevision());

// 2 -  A "move from" revision:
// When we highlight text in Microsoft Word, and then drag it to a different place in the document
// while tracking changes, two revisions appear.
// The "move from" revision is a copy of the text originally before we moved it.
footnote = (Footnote) footnotes.get(4);
Assert.assertTrue(footnote.isMoveFromRevision());

// 3 -  A "move to" revision:
// The "move to" revision is the text that we moved in its new position in the document.
// "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
// Accepting a move revision deletes the "move from" revision and its text,
// and keeps the text from the "move to" revision.
// Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
footnote = (Footnote) footnotes.get(1);
Assert.assertTrue(footnote.isMoveToRevision());

// 4 -  A "delete" revision:
// This revision occurs when we delete text while tracking changes. When we delete text like this,
// it will stay in the document as a revision until we either accept the revision,
// which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
footnote = (Footnote) footnotes.get(3);
Assert.assertTrue(footnote.isDeleteRevision());

public boolean isMoveFromRevision()

Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

Example:

Shows how to view revision-related properties of InlineStory nodes.

Document doc = new Document(getMyDir() + "Revision footnotes.docx");

// When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
// is turned on in Microsoft Word, the changes we apply count as revisions.
// When editing a document using Aspose.Words, we can begin tracking revisions by
// invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
// We can either accept revisions to assimilate them into the document
// or reject them to undo and discard the proposed change.
Assert.assertTrue(doc.hasRevisions());

NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
Assert.assertEquals(5, footnotes.getCount());

// Below are five types of revisions that can flag an InlineStory node.
// 1 -  An "insert" revision:
// This revision occurs when we insert text while tracking changes.
Footnote footnote = (Footnote) footnotes.get(2);
Assert.assertTrue(footnote.isInsertRevision());

// 2 -  A "move from" revision:
// When we highlight text in Microsoft Word, and then drag it to a different place in the document
// while tracking changes, two revisions appear.
// The "move from" revision is a copy of the text originally before we moved it.
footnote = (Footnote) footnotes.get(4);
Assert.assertTrue(footnote.isMoveFromRevision());

// 3 -  A "move to" revision:
// The "move to" revision is the text that we moved in its new position in the document.
// "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
// Accepting a move revision deletes the "move from" revision and its text,
// and keeps the text from the "move to" revision.
// Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
footnote = (Footnote) footnotes.get(1);
Assert.assertTrue(footnote.isMoveToRevision());

// 4 -  A "delete" revision:
// This revision occurs when we delete text while tracking changes. When we delete text like this,
// it will stay in the document as a revision until we either accept the revision,
// which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
footnote = (Footnote) footnotes.get(3);
Assert.assertTrue(footnote.isDeleteRevision());

public boolean isMoveToRevision()

Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

Example:

Shows how to view revision-related properties of InlineStory nodes.

Document doc = new Document(getMyDir() + "Revision footnotes.docx");

// When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
// is turned on in Microsoft Word, the changes we apply count as revisions.
// When editing a document using Aspose.Words, we can begin tracking revisions by
// invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
// We can either accept revisions to assimilate them into the document
// or reject them to undo and discard the proposed change.
Assert.assertTrue(doc.hasRevisions());

NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
Assert.assertEquals(5, footnotes.getCount());

// Below are five types of revisions that can flag an InlineStory node.
// 1 -  An "insert" revision:
// This revision occurs when we insert text while tracking changes.
Footnote footnote = (Footnote) footnotes.get(2);
Assert.assertTrue(footnote.isInsertRevision());

// 2 -  A "move from" revision:
// When we highlight text in Microsoft Word, and then drag it to a different place in the document
// while tracking changes, two revisions appear.
// The "move from" revision is a copy of the text originally before we moved it.
footnote = (Footnote) footnotes.get(4);
Assert.assertTrue(footnote.isMoveFromRevision());

// 3 -  A "move to" revision:
// The "move to" revision is the text that we moved in its new position in the document.
// "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
// Accepting a move revision deletes the "move from" revision and its text,
// and keeps the text from the "move to" revision.
// Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
footnote = (Footnote) footnotes.get(1);
Assert.assertTrue(footnote.isMoveToRevision());

// 4 -  A "delete" revision:
// This revision occurs when we delete text while tracking changes. When we delete text like this,
// it will stay in the document as a revision until we either accept the revision,
// which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
footnote = (Footnote) footnotes.get(3);
Assert.assertTrue(footnote.isDeleteRevision());

public Node getLastChild()

Gets the last child of the node.

If there is no last child node, a null is returned.

Example:

Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.writeln("Section 1 text.");
builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
builder.writeln("Section 2 text.");

// Both sections are siblings of each other.
Section lastSection = (Section) doc.getLastChild();
Section firstSection = (Section) lastSection.getPreviousSibling();

// Remove a section based on its sibling relationship with another section.
if (lastSection.getPreviousSibling() != null)
    doc.removeChild(firstSection);

// The section we removed was the first one, leaving the document with only the second.
Assert.assertEquals("Section 2 text.", doc.getText().trim());

public Paragraph getLastParagraph()

Gets the last paragraph in the story.

Example:

Shows how to insert InlineStory nodes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);

// Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell.
Table table = new Table(doc);
table.ensureMinimum();

// We can place a table inside a footnote, which will make it appear at the referencing page's footer.
Assert.assertEquals(footnote.getTables().getCount(), 0);
footnote.appendChild(table);
Assert.assertEquals(footnote.getTables().getCount(), 1);
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);

// An InlineStory has an "EnsureMinimum()" method as well, but in this case,
// it makes sure the last child of the node is a paragraph,
// for us to be able to click and write text easily in Microsoft Word.
footnote.ensureMinimum();
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Edit the appearance of the anchor, which is the small superscript number
// in the main text that points to the footnote.
footnote.getFont().setName("Arial");
footnote.getFont().setColor(Color.GREEN);

// All inline story nodes have their respective story types.
Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);

// A comment is another type of inline story.
Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));

// The parent paragraph of an inline story node will be the one from the main document body.
Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph());

// However, the last paragraph is the one from the comment text contents,
// which will be outside the main document body in a speech bubble.
// A comment will not have any child nodes by default,
// so we can apply the EnsureMinimum() method to place a paragraph here as well.
Assert.assertNull(comment.getLastParagraph());
comment.ensureMinimum();
Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Once we have a paragraph, we can move the builder to do it and write our comment.
builder.moveTo(comment.getLastParagraph());
builder.write("My comment.");

Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);

doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

public Node getNextSibling()

Gets the node immediately following this node.

If there is no next node, a null is returned.

Example:

Shows how to use a node's NextSibling property to enumerate through its immediate children.

Document doc = new Document(getMyDir() + "Paragraphs.docx");

for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
    System.out.println(Node.nodeTypeToString(node.getNodeType()));
}

Example:

Shows how to traverse a composite node's tree of child nodes.

public void recurseChildren() throws Exception {
    Document doc = new Document(getMyDir() + "Paragraphs.docx");

    // Any node that can contain child nodes, such as the document itself, is composite.
    Assert.assertTrue(doc.isComposite());

    // Invoke the recursive function that will go through and print all the child nodes of a composite node.
    traverseAllNodes(doc, 0);
}

/// <summary>
/// Recursively traverses a node tree while printing the type of each node
/// with an indent depending on depth as well as the contents of all inline nodes.
/// </summary>
public void traverseAllNodes(CompositeNode parentNode, int depth) {
    for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
        System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));

        // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
        if (childNode.isComposite()) {
            System.out.println();
            traverseAllNodes((CompositeNode) childNode, depth + 1);
        } else if (childNode instanceof Inline) {
            System.out.println(MessageFormat.format(" - \"{0}\"", childNode.getText().trim()));
        } else {
            System.out.println();
        }
    }
}

public abstract int getNodeType()

Gets the type of this node. The value of the property is NodeType integer constant.

Example:

Shows how to use a node's NextSibling property to enumerate through its immediate children.

Document doc = new Document(getMyDir() + "Paragraphs.docx");

for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
    System.out.println(Node.nodeTypeToString(node.getNodeType()));
}

Example:

Shows how to remove all child nodes of a specific type from a composite node.

Document doc = new Document(getMyDir() + "Tables.docx");

Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount());

Node curNode = doc.getFirstSection().getBody().getFirstChild();

while (curNode != null) {
    // Save the next sibling node as a variable in case we want to move to it after deleting this node.
    Node nextNode = curNode.getNextSibling();

    // A section body can contain Paragraph and Table nodes.
    // If the node is a Table, remove it from the parent.
    if (curNode.getNodeType() == NodeType.TABLE) {
        curNode.remove();
    }

    curNode = nextNode;
}

Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());

Example:

Shows how to traverse a composite node's tree of child nodes.

public void recurseChildren() throws Exception {
    Document doc = new Document(getMyDir() + "Paragraphs.docx");

    // Any node that can contain child nodes, such as the document itself, is composite.
    Assert.assertTrue(doc.isComposite());

    // Invoke the recursive function that will go through and print all the child nodes of a composite node.
    traverseAllNodes(doc, 0);
}

/// <summary>
/// Recursively traverses a node tree while printing the type of each node
/// with an indent depending on depth as well as the contents of all inline nodes.
/// </summary>
public void traverseAllNodes(CompositeNode parentNode, int depth) {
    for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
        System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));

        // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
        if (childNode.isComposite()) {
            System.out.println();
            traverseAllNodes((CompositeNode) childNode, depth + 1);
        } else if (childNode instanceof Inline) {
            System.out.println(MessageFormat.format(" - \"{0}\"", childNode.getText().trim()));
        } else {
            System.out.println();
        }
    }
}

public ParagraphCollection getParagraphs()

Gets a collection of paragraphs that are immediate children of the story.

Example:

Shows how to add a comment to a paragraph.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");

Comment comment = new Comment(doc, "John Doe", "JD", new Date());
builder.getCurrentParagraph().appendChild(comment);
builder.moveTo(comment.appendChild(new Paragraph(doc)));
builder.write("Comment text.");

Assert.assertEquals(new Date(), comment.getDateTime());

// In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. 
doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");

Example:

Shows how to insert and customize footnotes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Add text, and reference it with a footnote. This footnote will place a small superscript reference
// mark after the text that it references and create an entry below the main body text at the bottom of the page.
// This entry will contain the footnote's reference mark and the reference text,
// which we will pass to the document builder's "InsertFootnote" method.
builder.write("Main body text.");
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

// If this property is set to "true", then our footnote's reference mark
// will be its index among all the section's footnotes.
// This is the first footnote, so the reference mark will be "1".
Assert.assertTrue(footnote.isAuto());

// We can move the document builder inside the footnote to edit its reference text. 
builder.moveTo(footnote.getFirstParagraph());
builder.write(" More text added by a DocumentBuilder.");
builder.moveToDocumentEnd();

Assert.assertEquals(footnote.getParagraphs().get(0).toString(SaveFormat.TEXT).trim(), "Footnote text. More text added by a DocumentBuilder.");

builder.write(" More main body text.");
footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

// We can set a custom reference mark which the footnote will use instead of its index number.
footnote.setReferenceMark("RefMark");

Assert.assertFalse(footnote.isAuto());

// A bookmark with the "IsAuto" flag set to true will still show its real index
// even if previous bookmarks display custom reference marks, so this bookmark's reference mark will be a "3".
builder.write(" More main body text.");
footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");

Assert.assertTrue(footnote.isAuto());

doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");

public CompositeNode getParentNode()

Gets the immediate parent of this node.

If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.

Example:

Shows how to access a node's parent node.

Document doc = new Document();
Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();

// Append a child Run node to the document's first paragraph.
Run run = new Run(doc, "Hello world!");
para.appendChild(run);

// The paragraph is the parent node of the run node. We can trace this lineage
// all the way to the document node, which is the root of the document's node tree.
Assert.assertEquals(para, run.getParentNode());
Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
Assert.assertEquals(doc.getFirstSection(), doc.getFirstSection().getBody().getParentNode());
Assert.assertEquals(doc, doc.getFirstSection().getParentNode());

Example:

Shows how to create a node and set its owning document.

Document doc = new Document();
Paragraph para = new Paragraph(doc);
para.appendChild(new Run(doc, "Hello world!"));

// We have not yet appended this paragraph as a child to any composite node.
Assert.assertNull(para.getParentNode());

// If a node is an appropriate child node type of another composite node,
// we can attach it as a child only if both nodes have the same owner document.
// The owner document is the document we passed to the node's constructor.
// We have not attached this paragraph to the document, so the document does not contain its text.
Assert.assertEquals(para.getDocument(), doc);
Assert.assertEquals("", doc.getText().trim());

// Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents.
para.getParagraphFormat().setStyleName("Heading 1");

// Add this node to the document, and then verify its contents.
doc.getFirstSection().getBody().appendChild(para);

Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
Assert.assertEquals("Hello world!", doc.getText().trim());

public Paragraph getParentParagraph()

Retrieves the parent Paragraph of this node.

Example:

Shows how to insert InlineStory nodes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);

// Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell.
Table table = new Table(doc);
table.ensureMinimum();

// We can place a table inside a footnote, which will make it appear at the referencing page's footer.
Assert.assertEquals(footnote.getTables().getCount(), 0);
footnote.appendChild(table);
Assert.assertEquals(footnote.getTables().getCount(), 1);
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);

// An InlineStory has an "EnsureMinimum()" method as well, but in this case,
// it makes sure the last child of the node is a paragraph,
// for us to be able to click and write text easily in Microsoft Word.
footnote.ensureMinimum();
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Edit the appearance of the anchor, which is the small superscript number
// in the main text that points to the footnote.
footnote.getFont().setName("Arial");
footnote.getFont().setColor(Color.GREEN);

// All inline story nodes have their respective story types.
Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);

// A comment is another type of inline story.
Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));

// The parent paragraph of an inline story node will be the one from the main document body.
Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph());

// However, the last paragraph is the one from the comment text contents,
// which will be outside the main document body in a speech bubble.
// A comment will not have any child nodes by default,
// so we can apply the EnsureMinimum() method to place a paragraph here as well.
Assert.assertNull(comment.getLastParagraph());
comment.ensureMinimum();
Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Once we have a paragraph, we can move the builder to do it and write our comment.
builder.moveTo(comment.getLastParagraph());
builder.write("My comment.");

Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);

doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

public Node getPreviousSibling()

Gets the node immediately preceding this node.

If there is no preceding node, a null is returned.

Example:

Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.writeln("Section 1 text.");
builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
builder.writeln("Section 2 text.");

// Both sections are siblings of each other.
Section lastSection = (Section) doc.getLastChild();
Section firstSection = (Section) lastSection.getPreviousSibling();

// Remove a section based on its sibling relationship with another section.
if (lastSection.getPreviousSibling() != null)
    doc.removeChild(firstSection);

// The section we removed was the first one, leaving the document with only the second.
Assert.assertEquals("Section 2 text.", doc.getText().trim());

public Range getRange()

Returns a Range object that represents the portion of a document that is contained in this node.

Example:

Shows how to delete all the nodes from a range.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Add text to the first section in the document, and then add another section.
builder.write("Section 1. ");
builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
builder.write("Section 2.");

Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim());

// Remove the first section entirely by removing all the nodes
// within its range, including the section itself.
doc.getSections().get(0).getRange().delete();

Assert.assertEquals(1, doc.getSections().getCount());
Assert.assertEquals("Section 2.", doc.getText().trim());

public abstract int getStoryType()

Returns the type of the story. The value of the property is StoryType integer constant.

Example:

Shows how to insert InlineStory nodes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);

// Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell.
Table table = new Table(doc);
table.ensureMinimum();

// We can place a table inside a footnote, which will make it appear at the referencing page's footer.
Assert.assertEquals(footnote.getTables().getCount(), 0);
footnote.appendChild(table);
Assert.assertEquals(footnote.getTables().getCount(), 1);
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);

// An InlineStory has an "EnsureMinimum()" method as well, but in this case,
// it makes sure the last child of the node is a paragraph,
// for us to be able to click and write text easily in Microsoft Word.
footnote.ensureMinimum();
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Edit the appearance of the anchor, which is the small superscript number
// in the main text that points to the footnote.
footnote.getFont().setName("Arial");
footnote.getFont().setColor(Color.GREEN);

// All inline story nodes have their respective story types.
Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);

// A comment is another type of inline story.
Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));

// The parent paragraph of an inline story node will be the one from the main document body.
Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph());

// However, the last paragraph is the one from the comment text contents,
// which will be outside the main document body in a speech bubble.
// A comment will not have any child nodes by default,
// so we can apply the EnsureMinimum() method to place a paragraph here as well.
Assert.assertNull(comment.getLastParagraph());
comment.ensureMinimum();
Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Once we have a paragraph, we can move the builder to do it and write our comment.
builder.moveTo(comment.getLastParagraph());
builder.write("My comment.");

Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);

doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

public TableCollection getTables()

Gets a collection of tables that are immediate children of the story.

Example:

Shows how to insert InlineStory nodes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);

// Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell.
Table table = new Table(doc);
table.ensureMinimum();

// We can place a table inside a footnote, which will make it appear at the referencing page's footer.
Assert.assertEquals(footnote.getTables().getCount(), 0);
footnote.appendChild(table);
Assert.assertEquals(footnote.getTables().getCount(), 1);
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);

// An InlineStory has an "EnsureMinimum()" method as well, but in this case,
// it makes sure the last child of the node is a paragraph,
// for us to be able to click and write text easily in Microsoft Word.
footnote.ensureMinimum();
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Edit the appearance of the anchor, which is the small superscript number
// in the main text that points to the footnote.
footnote.getFont().setName("Arial");
footnote.getFont().setColor(Color.GREEN);

// All inline story nodes have their respective story types.
Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);

// A comment is another type of inline story.
Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));

// The parent paragraph of an inline story node will be the one from the main document body.
Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph());

// However, the last paragraph is the one from the comment text contents,
// which will be outside the main document body in a speech bubble.
// A comment will not have any child nodes by default,
// so we can apply the EnsureMinimum() method to place a paragraph here as well.
Assert.assertNull(comment.getLastParagraph());
comment.ensureMinimum();
Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Once we have a paragraph, we can move the builder to do it and write our comment.
builder.moveTo(comment.getLastParagraph());
builder.write("My comment.");

Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);

doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

public abstract boolean accept(DocumentVisitor visitor)
                            throws java.lang.Exception

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Example:

Shows how to use a DocumentVisitor implementation to remove all hidden content from a document.

public void removeHiddenContentFromDocument() throws Exception {
    Document doc = new Document(getMyDir() + "Hidden content.docx");
    RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor();

    // Below are three types of fields which can accept a document visitor,
    // which will allow it to visit the accepting node, and then traverse its child nodes in a depth-first manner.
    // 1 -  Paragraph node:
    Paragraph para = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 4, true);
    para.accept(hiddenContentRemover);

    // 2 -  Table node:
    Table table = doc.getFirstSection().getBody().getTables().get(0);
    table.accept(hiddenContentRemover);

    // 3 -  Document node:
    doc.accept(hiddenContentRemover);

    doc.save(getArtifactsDir() + "Font.RemoveHiddenContentFromDocument.docx");
}

/// <summary>
/// Removes all visited nodes marked as "hidden content".
/// </summary>
public static class RemoveHiddenContentVisitor extends DocumentVisitor {
    /// <summary>
    /// Called when a FieldStart node is encountered in the document.
    /// </summary>
    public int visitFieldStart(FieldStart fieldStart) {
        if (fieldStart.getFont().getHidden())
            fieldStart.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a FieldEnd node is encountered in the document.
    /// </summary>
    public int visitFieldEnd(FieldEnd fieldEnd) {
        if (fieldEnd.getFont().getHidden())
            fieldEnd.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a FieldSeparator node is encountered in the document.
    /// </summary>
    public int visitFieldSeparator(FieldSeparator fieldSeparator) {
        if (fieldSeparator.getFont().getHidden())
            fieldSeparator.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Run node is encountered in the document.
    /// </summary>
    public int visitRun(Run run) {
        if (run.getFont().getHidden())
            run.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Paragraph node is encountered in the document.
    /// </summary>
    public int visitParagraphStart(Paragraph paragraph) {
        if (paragraph.getParagraphBreakFont().getHidden())
            paragraph.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a FormField is encountered in the document.
    /// </summary>
    public int visitFormField(FormField formField) {
        if (formField.getFont().getHidden())
            formField.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a GroupShape is encountered in the document.
    /// </summary>
    public int visitGroupShapeStart(GroupShape groupShape) {
        if (groupShape.getFont().getHidden())
            groupShape.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Shape is encountered in the document.
    /// </summary>
    public int visitShapeStart(Shape shape) {
        if (shape.getFont().getHidden())
            shape.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Comment is encountered in the document.
    /// </summary>
    public int visitCommentStart(Comment comment) {
        if (comment.getFont().getHidden())
            comment.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Footnote is encountered in the document.
    /// </summary>
    public int visitFootnoteStart(Footnote footnote) {
        if (footnote.getFont().getHidden())
            footnote.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SpecialCharacter is encountered in the document.
    /// </summary>
    public int visitSpecialChar(SpecialChar specialChar) {
        if (specialChar.getFont().getHidden())
            specialChar.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when visiting of a Table node is ended in the document.
    /// </summary>
    public int visitTableEnd(Table table) {
        // The content inside table cells may have the hidden content flag, but the tables themselves cannot.
        // If this table had nothing but hidden content, this visitor would have removed all of it,
        // and there would be no child nodes left.
        // Thus, we can also treat the table itself as hidden content and remove it.
        // Tables which are empty but do not have hidden content will have cells with empty paragraphs inside,
        // which this visitor will not remove.
        if (!table.hasChildNodes())
            table.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when visiting of a Cell node is ended in the document.
    /// </summary>
    public int visitCellEnd(Cell cell) {
        if (!cell.hasChildNodes() && cell.getParentNode() != null)
            cell.remove();

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when visiting of a Row node is ended in the document.
    /// </summary>
    public int visitRowEnd(Row row) {
        if (!row.hasChildNodes() && row.getParentNode() != null)
            row.remove();

        return VisitorAction.CONTINUE;
    }
}

public abstract int acceptEnd(DocumentVisitor visitor)
                           throws java.lang.Exception

When implemented in a derived class, calls the VisitXXXEnd method of the specified document visitor.

Example:

Shows how to use a document visitor to print a document's node structure.

public void docStructureToText() throws Exception {
    Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
    DocStructurePrinter visitor = new DocStructurePrinter();

    // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
    // and then traverses all the node's children in a depth-first manner.
    // The visitor can read and modify each visited node.
    doc.accept(visitor);

    System.out.println(visitor.getText());
}

/// <summary>
/// Traverses a node's tree of child nodes.
/// Creates a map of this tree in the form of a string.
/// </summary>
public static class DocStructurePrinter extends DocumentVisitor {
    public DocStructurePrinter() {
        mAcceptingNodeChildTree = new StringBuilder();
    }

    public String getText() {
        return mAcceptingNodeChildTree.toString();
    }

    /// <summary>
    /// Called when a Document node is encountered.
    /// </summary>
    public int visitDocumentStart(Document doc) {
        int childNodeCount = doc.getChildNodes(NodeType.ANY, true).getCount();

        indentAndAppendLine("[Document start] Child nodes: " + childNodeCount);
        mDocTraversalDepth++;

        // Allow the visitor to continue visiting other nodes.
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Document node have been visited.
    /// </summary>
    public int visitDocumentEnd(Document doc) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Document end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Section node is encountered in the document.
    /// </summary>
    public int visitSectionStart(final Section section) {
        // Get the index of our section within the document
        NodeCollection docSections = section.getDocument().getChildNodes(NodeType.SECTION, false);
        int sectionIndex = docSections.indexOf(section);

        indentAndAppendLine("[Section start] Section index: " + sectionIndex);
        mDocTraversalDepth++;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Section node have been visited.
    /// </summary>
    public int visitSectionEnd(final Section section) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Section end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Body node is encountered in the document.
    /// </summary>
    public int visitBodyStart(final Body body) {
        int paragraphCount = body.getParagraphs().getCount();
        indentAndAppendLine("[Body start] Paragraphs: " + paragraphCount);
        mDocTraversalDepth++;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Body node have been visited.
    /// </summary>
    public int visitBodyEnd(final Body body) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Body end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Paragraph node is encountered in the document.
    /// </summary>
    public int visitParagraphStart(final Paragraph paragraph) {
        indentAndAppendLine("[Paragraph start]");
        mDocTraversalDepth++;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Paragraph node have been visited.
    /// </summary>
    public int visitParagraphEnd(final Paragraph paragraph) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Paragraph end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Run node is encountered in the document.
    /// </summary>
    public int visitRun(final Run run) {
        indentAndAppendLine("[Run] \"" + run.getText() + "\"");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SubDocument node is encountered in the document.
    /// </summary>
    public int visitSubDocument(final SubDocument subDocument) {
        indentAndAppendLine("[SubDocument]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SubDocument node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)
    {
        indentAndAppendLine("[SdtRangeStart]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SubDocument node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)
    {
        indentAndAppendLine("[SdtRangeEnd]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
    /// </summary>
    /// <param name="text"></param>
    private void indentAndAppendLine(final String text) {
        for (int i = 0; i < mDocTraversalDepth; i++) {
            mAcceptingNodeChildTree.append("|  ");
        }

        mAcceptingNodeChildTree.append(text + "\r\n");
    }

    private int mDocTraversalDepth;
    private final StringBuilder mAcceptingNodeChildTree;
}

public abstract int acceptStart(DocumentVisitor visitor)
                             throws java.lang.Exception

When implemented in a derived class, calls the VisitXXXStart method of the specified document visitor.

Example:

Shows how to use a document visitor to print a document's node structure.

public void docStructureToText() throws Exception {
    Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
    DocStructurePrinter visitor = new DocStructurePrinter();

    // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
    // and then traverses all the node's children in a depth-first manner.
    // The visitor can read and modify each visited node.
    doc.accept(visitor);

    System.out.println(visitor.getText());
}

/// <summary>
/// Traverses a node's tree of child nodes.
/// Creates a map of this tree in the form of a string.
/// </summary>
public static class DocStructurePrinter extends DocumentVisitor {
    public DocStructurePrinter() {
        mAcceptingNodeChildTree = new StringBuilder();
    }

    public String getText() {
        return mAcceptingNodeChildTree.toString();
    }

    /// <summary>
    /// Called when a Document node is encountered.
    /// </summary>
    public int visitDocumentStart(Document doc) {
        int childNodeCount = doc.getChildNodes(NodeType.ANY, true).getCount();

        indentAndAppendLine("[Document start] Child nodes: " + childNodeCount);
        mDocTraversalDepth++;

        // Allow the visitor to continue visiting other nodes.
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Document node have been visited.
    /// </summary>
    public int visitDocumentEnd(Document doc) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Document end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Section node is encountered in the document.
    /// </summary>
    public int visitSectionStart(final Section section) {
        // Get the index of our section within the document
        NodeCollection docSections = section.getDocument().getChildNodes(NodeType.SECTION, false);
        int sectionIndex = docSections.indexOf(section);

        indentAndAppendLine("[Section start] Section index: " + sectionIndex);
        mDocTraversalDepth++;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Section node have been visited.
    /// </summary>
    public int visitSectionEnd(final Section section) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Section end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Body node is encountered in the document.
    /// </summary>
    public int visitBodyStart(final Body body) {
        int paragraphCount = body.getParagraphs().getCount();
        indentAndAppendLine("[Body start] Paragraphs: " + paragraphCount);
        mDocTraversalDepth++;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Body node have been visited.
    /// </summary>
    public int visitBodyEnd(final Body body) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Body end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Paragraph node is encountered in the document.
    /// </summary>
    public int visitParagraphStart(final Paragraph paragraph) {
        indentAndAppendLine("[Paragraph start]");
        mDocTraversalDepth++;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of a Paragraph node have been visited.
    /// </summary>
    public int visitParagraphEnd(final Paragraph paragraph) {
        mDocTraversalDepth--;
        indentAndAppendLine("[Paragraph end]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a Run node is encountered in the document.
    /// </summary>
    public int visitRun(final Run run) {
        indentAndAppendLine("[Run] \"" + run.getText() + "\"");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SubDocument node is encountered in the document.
    /// </summary>
    public int visitSubDocument(final SubDocument subDocument) {
        indentAndAppendLine("[SubDocument]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SubDocument node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)
    {
        indentAndAppendLine("[SdtRangeStart]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when a SubDocument node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)
    {
        indentAndAppendLine("[SdtRangeEnd]");

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
    /// </summary>
    /// <param name="text"></param>
    private void indentAndAppendLine(final String text) {
        for (int i = 0; i < mDocTraversalDepth; i++) {
            mAcceptingNodeChildTree.append("|  ");
        }

        mAcceptingNodeChildTree.append(text + "\r\n");
    }

    private int mDocTraversalDepth;
    private final StringBuilder mAcceptingNodeChildTree;
}

public Node deepClone(boolean isCloneChildren)

Creates a duplicate of the node.

This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

Parameters:

isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.

Returns:

The cloned node.

Example:

Shows how to clone a composite node.

Document doc = new Document();
Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
para.appendChild(new Run(doc, "Hello world!"));

// Below are two ways of cloning a composite node.
// 1 -  Create a clone of a node, and create a clone of each of its child nodes as well.
Node cloneWithChildren = para.deepClone(true);

Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes());
Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());

// 2 -  Create a clone of a node just by itself without any children.
Node cloneWithoutChildren = para.deepClone(false);

Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes());
Assert.assertEquals("", cloneWithoutChildren.getText().trim());

public void ensureMinimum()

If the last child is not a paragraph, creates and appends one empty paragraph.

Example:

Shows how to insert InlineStory nodes.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);

// Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell.
Table table = new Table(doc);
table.ensureMinimum();

// We can place a table inside a footnote, which will make it appear at the referencing page's footer.
Assert.assertEquals(footnote.getTables().getCount(), 0);
footnote.appendChild(table);
Assert.assertEquals(footnote.getTables().getCount(), 1);
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);

// An InlineStory has an "EnsureMinimum()" method as well, but in this case,
// it makes sure the last child of the node is a paragraph,
// for us to be able to click and write text easily in Microsoft Word.
footnote.ensureMinimum();
Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Edit the appearance of the anchor, which is the small superscript number
// in the main text that points to the footnote.
footnote.getFont().setName("Arial");
footnote.getFont().setColor(Color.GREEN);

// All inline story nodes have their respective story types.
Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);

// A comment is another type of inline story.
Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));

// The parent paragraph of an inline story node will be the one from the main document body.
Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph());

// However, the last paragraph is the one from the comment text contents,
// which will be outside the main document body in a speech bubble.
// A comment will not have any child nodes by default,
// so we can apply the EnsureMinimum() method to place a paragraph here as well.
Assert.assertNull(comment.getLastParagraph());
comment.ensureMinimum();
Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);

// Once we have a paragraph, we can move the builder to do it and write our comment.
builder.moveTo(comment.getLastParagraph());
builder.write("My comment.");

Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);

doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

public CompositeNode getAncestor(int ancestorType)

Gets the first ancestor of the specified NodeType.

Parameters:

ancestorType - A NodeType value. The node type of the ancestor to retrieve.

Returns:

The ancestor of the specified type or null if no ancestor of this type was found.

Example:

Shows how to find out if a tables are nested.

public void calculateDepthOfNestedTables() throws Exception {
    Document doc = new Document(getMyDir() + "Nested tables.docx");
    NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
    for (int i = 0; i < tables.getCount(); i++) {
        Table table = (Table) tables.get(i);

        // Find out if any cells in the table have other tables as children.
        int count = getChildTableCount(table);
        System.out.print(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));

        // Find out if the table is nested inside another table, and, if so, at what depth.
        int tableDepth = getNestedDepthOfTable(table);

        if (tableDepth > 0)
            System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
        else
            System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
    }
}

// Calculates what level a table is nested inside other tables.
//
// Returns An integer containing the level the table is nested at.
// 0 = Table is not nested inside any other table
// 1 = Table is nested within one parent table
// 2 = Table is nested within two parent tables etc..
private static int getNestedDepthOfTable(final Table table) {
    int depth = 0;
    Node parent = table.getAncestor(table.getNodeType());

    while (parent != null) {
        depth++;
        parent = parent.getAncestor(Table.class);
    }

    return depth;
}

// Determines if a table contains any immediate child table within its cells.
// Does not recursively traverse through those tables to check for further tables.
//
// Returns true if at least one child cell contains a table.
// Returns false if no cells in the table contains a table.
private static int getChildTableCount(final Table table) {
    int childTableCount = 0;

    for (Row row : table.getRows()) {
        for (Cell cell : row.getCells()) {
            TableCollection childTables = cell.getTables();

            if (childTables.getCount() > 0) childTableCount++;
        }
    }

    return childTableCount;
}

public CompositeNode getAncestor(java.lang.Class ancestorType)

Gets the first ancestor of the specified object type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:

ancestorType - The object type of the ancestor to retrieve.

Returns:

The ancestor of the specified type or null if no ancestor of this type was found.

Example:

Shows how to find out if a tables are nested.

public void calculateDepthOfNestedTables() throws Exception {
    Document doc = new Document(getMyDir() + "Nested tables.docx");
    NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
    for (int i = 0; i < tables.getCount(); i++) {
        Table table = (Table) tables.get(i);

        // Find out if any cells in the table have other tables as children.
        int count = getChildTableCount(table);
        System.out.print(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));

        // Find out if the table is nested inside another table, and, if so, at what depth.
        int tableDepth = getNestedDepthOfTable(table);

        if (tableDepth > 0)
            System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
        else
            System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
    }
}

// Calculates what level a table is nested inside other tables.
//
// Returns An integer containing the level the table is nested at.
// 0 = Table is not nested inside any other table
// 1 = Table is nested within one parent table
// 2 = Table is nested within two parent tables etc..
private static int getNestedDepthOfTable(final Table table) {
    int depth = 0;
    Node parent = table.getAncestor(table.getNodeType());

    while (parent != null) {
        depth++;
        parent = parent.getAncestor(Table.class);
    }

    return depth;
}

// Determines if a table contains any immediate child table within its cells.
// Does not recursively traverse through those tables to check for further tables.
//
// Returns true if at least one child cell contains a table.
// Returns false if no cells in the table contains a table.
private static int getChildTableCount(final Table table) {
    int childTableCount = 0;

    for (Row row : table.getRows()) {
        for (Cell cell : row.getCells()) {
            TableCollection childTables = cell.getTables();

            if (childTables.getCount() > 0) childTableCount++;
        }
    }

    return childTableCount;
}

public Node getChild(int nodeType, int index, boolean isDeep)

Returns an Nth child node that matches the specified type.

If index is out of range, a null is returned.

Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and getChild(int,int,boolean) is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by getChild(int,int,boolean)(NodeType.RUN, 0, false).

Parameters:

nodeType - A NodeType value. Specifies the type of the child node.

index - Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.

isDeep - true to select from all child nodes recursively; false to select only among immediate children. See remarks for more info.

Returns:

The child node that matches the criteria or null if no matching node is found.

Example:

Shows how to traverse through a composite node's collection of child nodes.

Document doc = new Document();

// Add two runs and one shape as child nodes to the first paragraph of this document.
Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
paragraph.appendChild(new Run(doc, "Hello world! "));

Shape shape = new Shape(doc, ShapeType.RECTANGLE);
shape.setWidth(200.0);
shape.setHeight(200.0);
// Note that the 'CustomNodeId' is not saved to an output file and exists only during the node lifetime.
shape.setCustomNodeId(100);
shape.setWrapType(WrapType.INLINE);
paragraph.appendChild(shape);

paragraph.appendChild(new Run(doc, "Hello again!"));

// Iterate through the paragraph's collection of immediate children,
// and print any runs or shapes that we find within.
NodeCollection children = paragraph.getChildNodes(NodeType.ANY, false);

Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, false).getCount());

for (Node child : (Iterable<Node>) children)
    switch (child.getNodeType()) {
        case NodeType.RUN:
            System.out.println("Run contents:");
            System.out.println(MessageFormat.format("\t\"{0}\"", child.getText().trim()));
            break;
        case NodeType.SHAPE:
            Shape childShape = (Shape)child;
            System.out.println("Shape:");
            System.out.println(MessageFormat.format("\t{0}, {1}x{2}", childShape.getShapeType(), childShape.getWidth(), childShape.getHeight()));
            break;
    }

Example:

Shows how to apply the properties of a table's style directly to the table's elements.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Table table = builder.startTable();
builder.insertCell();
builder.write("Hello world!");
builder.endTable();

TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
tableStyle.setRowStripe(3);
tableStyle.setCellSpacing(5.0);
tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
tableStyle.getBorders().setColor(Color.BLUE);
tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);

table.setStyle(tableStyle);

// This method concerns table style properties such as the ones we set above.
doc.expandTableStylesToDirectFormatting();

doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

Returns a live collection of child nodes that match the specified type.

The collection of nodes returned by this method is always live.

A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.

Parameters:

nodeType - A NodeType value. Specifies the type of nodes to select.

isDeep - true to select from all child nodes recursively; false to select only among immediate children.

Returns:

A live collection of child nodes of the specified type.

Example:

Shows how to add, update and delete child nodes in a CompositeNode's collection of children.

Document doc = new Document();

// An empty document, by default, has one paragraph.
Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());

// Composite nodes such as our paragraph can contain other composite and inline nodes as children.
Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
Run paragraphText = new Run(doc, "Initial text. ");
paragraph.appendChild(paragraphText);

// Create three more run nodes.
Run run1 = new Run(doc, "Run 1. ");
Run run2 = new Run(doc, "Run 2. ");
Run run3 = new Run(doc, "Run 3. ");

// The document body will not display these runs until we insert them into a composite node
// that itself is a part of the document's node tree, as we did with the first run.
// We can determine where the text contents of nodes that we insert
// appears in the document by specifying an insertion location relative to another node in the paragraph.
Assert.assertEquals("Initial text.", paragraph.getText().trim());

// Insert the second run into the paragraph in front of the initial run.
paragraph.insertBefore(run2, paragraphText);

Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim());

// Insert the third run after the initial run.
paragraph.insertAfter(run3, paragraphText);

Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim());

// Insert the first run to the start of the paragraph's child nodes collection.
paragraph.prependChild(run1);

Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());

// We can modify the contents of the run by editing and deleting existing child nodes.
((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);

Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());

Example:

Shows how to traverse through a composite node's collection of child nodes.

Document doc = new Document();

// Add two runs and one shape as child nodes to the first paragraph of this document.
Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
paragraph.appendChild(new Run(doc, "Hello world! "));

Shape shape = new Shape(doc, ShapeType.RECTANGLE);
shape.setWidth(200.0);
shape.setHeight(200.0);
// Note that the 'CustomNodeId' is not saved to an output file and exists only during the node lifetime.
shape.setCustomNodeId(100);
shape.setWrapType(WrapType.INLINE);
paragraph.appendChild(shape);

paragraph.appendChild(new Run(doc, "Hello again!"));

// Iterate through the paragraph's collection of immediate children,
// and print any runs or shapes that we find within.
NodeCollection children = paragraph.getChildNodes(NodeType.ANY, false);

Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, false).getCount());

for (Node child : (Iterable<Node>) children)
    switch (child.getNodeType()) {
        case NodeType.RUN:
            System.out.println("Run contents:");
            System.out.println(MessageFormat.format("\t\"{0}\"", child.getText().trim()));
            break;
        case NodeType.SHAPE:
            Shape childShape = (Shape)child;
            System.out.println("Shape:");
            System.out.println(MessageFormat.format("\t{0}, {1}x{2}", childShape.getShapeType(), childShape.getWidth(), childShape.getHeight()));
            break;
    }

Example:

Shows how to extract images from a document, and save them to the local file system as individual files.

Document doc = new Document(getMyDir() + "Images.docx");

// Get the collection of shapes from the document,
// and save the image data of every shape with an image as a file to the local file system.
NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);

int imageIndex = 0;
for (Shape shape : (Iterable<Shape>) shapes) {
    if (shape.hasImage()) {
        // The image data of shapes may contain images of many possible image formats. 
        // We can determine a file extension for each image automatically, based on its format.
        String imageFileName = MessageFormat.format("File.ExtractImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
        shape.getImageData().save(getArtifactsDir() + imageFileName);
        imageIndex++;
    }
}

Example:

Shows how to print all of a document's comments and their replies.

Document doc = new Document(getMyDir() + "Comments.docx");

NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
// If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment.
// Print all top-level comments along with any replies they may have.
for (Comment comment : (Iterable<Comment>) comments) {
    if (comment.getAncestor() == null) {
        System.out.println("Top-level comment:");
        System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}");
        System.out.println("Has {comment.Replies.Count} replies");
        for (Comment commentReply : comment.getReplies()) {
            System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}");
        }
        System.out.println();
    }
}

public java.lang.String getText()

Gets the text of this node and of all its children.

The returned string includes all control and special characters as described in ControlChar.

Example:

Shows how to output all paragraphs in a document that are list items.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.getListFormat().applyNumberDefault();
builder.writeln("Numbered list item 1");
builder.writeln("Numbered list item 2");
builder.writeln("Numbered list item 3");
builder.getListFormat().removeNumbers();

builder.getListFormat().applyBulletDefault();
builder.writeln("Bulleted list item 1");
builder.writeln("Bulleted list item 2");
builder.writeln("Bulleted list item 3");
builder.getListFormat().removeNumbers();

NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true);
for (Paragraph para : (Iterable<Paragraph>) paras) {
    if (para.getListFormat().isListItem()) {
        System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId()));
        System.out.println(para.getText());
    }
}

Example:

Shows the difference between calling the GetText and ToString methods on a node.

Document doc = new Document();

DocumentBuilder builder = new DocumentBuilder(doc);
builder.insertField("MERGEFIELD Field");

// GetText will retrieve the visible text as well as field codes and special characters.
Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());

// ToString will give us the document's appearance if saved to a passed save format.
Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));

public int indexOf(Node child)

Returns the index of the specified child node in the child node array.

Returns -1 if the node is not found in the child nodes.

Example:

Shows how to get the index of a given child node from its parent.

Document doc = new Document(getMyDir() + "Rendering.docx");

Body body = doc.getFirstSection().getBody();

// Retrieve the index of the last paragraph in the body of the first section.
Assert.assertEquals(24, body.getChildNodes(NodeType.ANY, false).indexOf(body.getLastParagraph()));

public java.util.Iterator<Node> iterator()

Provides support for the for each style iteration over the child nodes of this node.

Example:

Shows how to print all of a document's comments and their replies.

Document doc = new Document(getMyDir() + "Comments.docx");

NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
// If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment.
// Print all top-level comments along with any replies they may have.
for (Comment comment : (Iterable<Comment>) comments) {
    if (comment.getAncestor() == null) {
        System.out.println("Top-level comment:");
        System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}");
        System.out.println("Has {comment.Replies.Count} replies");
        for (Comment commentReply : comment.getReplies()) {
            System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}");
        }
        System.out.println();
    }
}

public Node nextPreOrder(Node rootNode)

Gets next node according to the pre-order tree traversal algorithm.

Parameters:

rootNode - The top node (limit) of traversal.

Returns:

Next node in pre-order order. Null if reached the rootNode.

Example:

Shows how to traverse the document's node tree using the pre-order traversal algorithm, and delete any encountered shape with an image.

Document doc = new Document(getMyDir() + "Images.docx");
ArrayList<Shape> shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true));

Assert.assertEquals(9, IterableUtils.countMatches(shapes, s -> {
    try {
        return s.hasImage();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}));

Node curNode = doc;
while (curNode != null) {
    Node nextNode = curNode.nextPreOrder(doc);

    if (curNode.previousPreOrder(doc) != null && nextNode != null)
        Assert.assertEquals(curNode, nextNode.previousPreOrder(doc));

    if (curNode.getNodeType() == NodeType.SHAPE && ((Shape) curNode).hasImage())
        curNode.remove();

    curNode = nextNode;
}

shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true));

Assert.assertEquals(0, IterableUtils.countMatches(shapes, s -> {
    try {
        return s.hasImage();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}));

public Node previousPreOrder(Node rootNode)

Gets the previous node according to the pre-order tree traversal algorithm.

Parameters:

rootNode - The top node (limit) of traversal.

Returns:

Previous node in pre-order order. Null if reached the rootNode.

Example:

Shows how to traverse the document's node tree using the pre-order traversal algorithm, and delete any encountered shape with an image.

Document doc = new Document(getMyDir() + "Images.docx");
ArrayList<Shape> shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true));

Assert.assertEquals(9, IterableUtils.countMatches(shapes, s -> {
    try {
        return s.hasImage();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}));

Node curNode = doc;
while (curNode != null) {
    Node nextNode = curNode.nextPreOrder(doc);

    if (curNode.previousPreOrder(doc) != null && nextNode != null)
        Assert.assertEquals(curNode, nextNode.previousPreOrder(doc));

    if (curNode.getNodeType() == NodeType.SHAPE && ((Shape) curNode).hasImage())
        curNode.remove();

    curNode = nextNode;
}

shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true));

Assert.assertEquals(0, IterableUtils.countMatches(shapes, s -> {
    try {
        return s.hasImage();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}));

public void remove()

Removes itself from the parent.

Example:

Shows how to delete all shapes with images from a document.

Document doc = new Document(getMyDir() + "Images.docx");
ArrayList<Shape> shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true));

Assert.assertEquals(9, IterableUtils.countMatches(shapes, s -> {
    try {
        return s.hasImage();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}));

for (Shape shape : shapes)
    if (shape.hasImage())
        shape.remove();

shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true));

Assert.assertEquals(0, IterableUtils.countMatches(shapes, s -> {
    try {
        return s.hasImage();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}));

Example:

Shows how to remove all child nodes of a specific type from a composite node.

Document doc = new Document(getMyDir() + "Tables.docx");

Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount());

Node curNode = doc.getFirstSection().getBody().getFirstChild();

while (curNode != null) {
    // Save the next sibling node as a variable in case we want to move to it after deleting this node.
    Node nextNode = curNode.getNextSibling();

    // A section body can contain Paragraph and Table nodes.
    // If the node is a Table, remove it from the parent.
    if (curNode.getNodeType() == NodeType.TABLE) {
        curNode.remove();
    }

    curNode = nextNode;
}

Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());

public void removeAllChildren()

Removes all the child nodes of the current node.

Example:

Shows how to construct an Aspose.Words document by hand.

Document doc = new Document();

// A blank document contains one section, one body and one paragraph.
// Call the "RemoveAllChildren" method to remove all those nodes,
// and end up with a document node with no children.
doc.removeAllChildren();

// This document now has no composite child nodes that we can add content to.
// If we wish to edit it, we will need to repopulate its node collection.
// First, create a new section, and then append it as a child to the root document node.
Section section = new Section(doc);
doc.appendChild(section);

// Set some page setup properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);

// A section needs a body, which will contain and display all its contents
// on the page between the section's header and footer.
Body body = new Body(doc);
section.appendChild(body);

// Create a paragraph, set some formatting properties, and then append it as a child to the body.
Paragraph para = new Paragraph(doc);

para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);

body.appendChild(para);

// Finally, add some content to do the document. Create a run,
// set its appearance and contents, and then append it as a child to the paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);

Assert.assertEquals("Hello World!", doc.getText().trim());

doc.save(getArtifactsDir() + "Section.CreateManually.docx");

public void removeSmartTags()

Removes all SmartTag descendant nodes of the current node.

This method does not remove the content of the smart tags.

Example:

Shows how to create smart tags.

public void create() throws Exception {
    Document doc = new Document();

    // A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
    // such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
    SmartTag smartTag = new SmartTag(doc);

    // Smart tags are composite nodes that contain their recognized text in its entirety.
    // Add contents to this smart tag manually.
    smartTag.appendChild(new Run(doc, "May 29, 2019"));

    // Microsoft Word may recognize the above contents as being a date.
    // Smart tags use the "Element" property to reflect the type of data they contain.
    smartTag.setElement("date");

    // Some smart tag types process their contents further into custom XML properties.
    smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
    smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
    smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));

    // Set the smart tag's URI to the default value.
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));

    // Create another smart tag for a stock ticker.
    smartTag = new SmartTag(doc);
    smartTag.setElement("stockticker");
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    smartTag.appendChild(new Run(doc, "MSFT"));

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));

    // Print all the smart tags in our document using a document visitor.
    doc.accept(new SmartTagPrinter());

    // Older versions of Microsoft Word support smart tags.
    doc.save(getArtifactsDir() + "SmartTag.Create.doc");

    // Use the "RemoveSmartTags" method to remove all smart tags from a document.
    Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

    doc.removeSmartTags();

    Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
}

/// <summary>
/// Prints visited smart tags and their contents.
/// </summary>
private static class SmartTagPrinter extends DocumentVisitor {
    /// <summary>
    /// Called when a SmartTag node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagStart(SmartTag smartTag) {
        System.out.println("Smart tag type: {smartTag.Element}");
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when the visiting of a SmartTag node is ended.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagEnd(SmartTag smartTag) {
        System.out.println("\tContents: \"{smartTag.ToString(SaveFormat.Text)}\"");

        if (smartTag.getProperties().getCount() == 0) {
            System.out.println("\tContains no properties");
        } else {
            System.out.println("\tProperties: ");
            String[] properties = new String[smartTag.getProperties().getCount()];
            int index = 0;

            for (CustomXmlProperty cxp : smartTag.getProperties())
                properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());

            System.out.println(StringUtils.join(properties, ", "));
        }

        return VisitorAction.CONTINUE;
    }
}

Example:

Removes all smart tags from descendant nodes of a composite node.

Document doc = new Document(getMyDir() + "Smart tags.doc");

Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

doc.removeSmartTags();

Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

public NodeList selectNodes(java.lang.String xpath)

Selects a list of nodes matching the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:

xpath - The XPath expression.

Returns:

A list of nodes matching the XPath query.

Example:

Shows how to select certain nodes by using an XPath expression.

Document doc = new Document(getMyDir() + "Tables.docx");

// This expression will extract all paragraph nodes,
// which are descendants of any table node in the document.
NodeList nodeList = doc.selectNodes("//Table//Paragraph");

// Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table.
int index = 0;

Iterator<Node> e = nodeList.iterator();
while (e.hasNext()) {
    Node currentNode = e.next();
    System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
}

// This expression will select any paragraphs that are direct children of any Body node in the document.
nodeList = doc.selectNodes("//Body/Paragraph");

// We can treat the list as an array.
Assert.assertEquals(nodeList.toArray().length, 4);

// Use SelectSingleNode to select the first result of the same expression as above.
Node node = doc.selectSingleNode("//Body/Paragraph");

Assert.assertEquals(Paragraph.class, node.getClass());

Example:

Shows how to use an XPath expression to test whether a node is inside a field.

Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");

// The NodeList that results from this XPath expression will contain all nodes we find inside a field.
// However, FieldStart and FieldEnd nodes can be on the list if there are nested fields in the path.
// Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs.
NodeList resultList =
        doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
Run[] runs = Arrays.stream(resultList.toArray()).filter(n -> n.getNodeType() == NodeType.RUN).toArray(Run[]::new);
Run run = runs[0];

// Check if the specified run is one of the nodes that are inside the field.
System.out.println(MessageFormat.format("Contents of the first Run node that''s part of a field: {0}", run.getText().trim()));

public Node selectSingleNode(java.lang.String xpath)

Selects the first Node that matches the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:

xpath - The XPath expression.

Returns:

The first Node that matches the XPath query or null if no matching node is found.

Example:

Shows how to select certain nodes by using an XPath expression.

Document doc = new Document(getMyDir() + "Tables.docx");

// This expression will extract all paragraph nodes,
// which are descendants of any table node in the document.
NodeList nodeList = doc.selectNodes("//Table//Paragraph");

// Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table.
int index = 0;

Iterator<Node> e = nodeList.iterator();
while (e.hasNext()) {
    Node currentNode = e.next();
    System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
}

// This expression will select any paragraphs that are direct children of any Body node in the document.
nodeList = doc.selectNodes("//Body/Paragraph");

// We can treat the list as an array.
Assert.assertEquals(nodeList.toArray().length, 4);

// Use SelectSingleNode to select the first result of the same expression as above.
Node node = doc.selectSingleNode("//Body/Paragraph");

Assert.assertEquals(Paragraph.class, node.getClass());

public java.lang.String toString(SaveOptions saveOptions)
               throws java.lang.Exception

Exports the content of the node into a string using the specified save options.

Parameters:

saveOptions - Specifies the options that control how the node is saved.

Returns:

The content of the node in the specified format.

Example:

Exports the content of a node to String in HTML format.

Document doc = new Document(getMyDir() + "Document.docx");

Node node = doc.getLastSection().getBody().getLastParagraph();

// When we call the ToString method using the html SaveFormat overload,
// it converts the node's contents to their raw html representation.
Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
        "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
        "</p>", node.toString(SaveFormat.HTML));

// We can also modify the result of this conversion using a SaveOptions object.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setExportRelativeFontSize(true);

Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
        "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
        "</p>", node.toString(saveOptions));

public java.lang.String toString(int saveFormat)
               throws java.lang.Exception

Exports the content of the node into a string in the specified format.

Returns:

The content of the node in the specified format.

Parameters:

saveFormat - A SaveFormat value.

Example:

Shows how to extract the list labels of all paragraphs that are list items.

Document doc = new Document(getMyDir() + "Rendering.docx");
doc.updateListLabels();
int listParaCount = 1;

for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
    // Find if we have the paragraph list. In our document, our list uses plain Arabic numbers,
    // which start at three and ends at six.
    if (paragraph.getListFormat().isListItem()) {
        System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount));

        // This is the text we get when getting when we output this node to text format.
        // This text output will omit list labels. Trim any paragraph formatting characters. 
        String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
        System.out.println("Exported Text: " + paragraphText);

        ListLabel label = paragraph.getListLabel();

        // This gets the position of the paragraph in the current level of the list. If we have a list with multiple levels,
        // this will tell us what position it is on that level.
        System.out.println("\tNumerical Id: {label.LabelValue}");

        // Combine them together to include the list label with the text in the output.
        System.out.println("\tList label combined with text: {label.LabelString} {paragraphText}");
    }

}

Example:

Exports the content of a node to String in HTML format.

Document doc = new Document(getMyDir() + "Document.docx");

Node node = doc.getLastSection().getBody().getLastParagraph();

// When we call the ToString method using the html SaveFormat overload,
// it converts the node's contents to their raw html representation.
Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
        "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
        "</p>", node.toString(SaveFormat.HTML));

// We can also modify the result of this conversion using a SaveOptions object.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setExportRelativeFontSize(true);

Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
        "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
        "</p>", node.toString(saveOptions));

Example:

Shows the difference between calling the GetText and ToString methods on a node.

Document doc = new Document();

DocumentBuilder builder = new DocumentBuilder(doc);
builder.insertField("MERGEFIELD Field");

// GetText will retrieve the visible text as well as field codes and special characters.
Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());

// ToString will give us the document's appearance if saved to a passed save format.
Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));