com.aspose.words

Class AbsolutePositionTab

java.lang.Object

com.aspose.words.Node

com.aspose.words.Inline

com.aspose.words.SpecialChar

com.aspose.words.AbsolutePositionTab

All Implemented Interfaces:

java.lang.Cloneable

public class AbsolutePositionTab
extends SpecialChar

An absolute position tab is a character which is used to advance the position on the current line of text when displaying this WordprocessingML content.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

Examples:

Shows how to process absolute position tab characters with a document visitor.

 
 public void documentToTxt() throws Exception {
     Document doc = new Document(getMyDir() + "Absolute position tab.docx");

     // Extract the text contents of our document by accepting this custom document visitor.
     DocTextExtractor myDocTextExtractor = new DocTextExtractor();
     Section fisrtSection = doc.getFirstSection();
     fisrtSection.getBody().accept(myDocTextExtractor);
     // Visit only start of the document body.
     fisrtSection.getBody().acceptStart(myDocTextExtractor);
     // Visit only end of the document body.
     fisrtSection.getBody().acceptEnd(myDocTextExtractor);

     // The absolute position tab, which has no equivalent in string form, has been explicitly converted to a tab character.
     Assert.assertEquals("Before AbsolutePositionTab\tAfter AbsolutePositionTab", myDocTextExtractor.getText());

     // An AbsolutePositionTab can accept a DocumentVisitor by itself too.
     AbsolutePositionTab absPositionTab = (AbsolutePositionTab) doc.getFirstSection().getBody().getFirstParagraph().getChild(NodeType.SPECIAL_CHAR, 0, true);

     myDocTextExtractor = new DocTextExtractor();
     absPositionTab.accept(myDocTextExtractor);

     Assert.assertEquals("\t", myDocTextExtractor.getText());
 }

 /// <summary>
 /// Collects the text contents of all runs in the visited document. Replaces all absolute tab characters with ordinary tabs.
 /// </summary>
 public static class DocTextExtractor extends DocumentVisitor {
     public DocTextExtractor() {
         mBuilder = new StringBuilder();
     }

     /// <summary>
     /// Called when a Run node is encountered in the document.
     /// </summary>
     public int visitRun(final Run run) {
         appendText(run.getText());
         return VisitorAction.CONTINUE;
     }

     /// <summary>
     /// Called when an AbsolutePositionTab node is encountered in the document.
     /// </summary>
     public int visitAbsolutePositionTab(final AbsolutePositionTab tab) {
         mBuilder.append("\t");

         return VisitorAction.CONTINUE;
     }

     /// <summary>
     /// Adds text to the current output. Honors the enabled/disabled output flag.
     /// </summary>
     public void appendText(final String text) {
         mBuilder.append(text);
     }

     /// <summary>
     /// Plain text of the document that was accumulated by the visitor.
     /// </summary>
     public String getText() {
         return mBuilder.toString();
     }

     private final StringBuilder mBuilder;
 }
 
 

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.

Methods inherited from class com.aspose.words.SpecialChar

getNodeType, getText

Methods inherited from class com.aspose.words.Inline

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttr, getDocument_IInline, getFont, getParentParagraph_IInline, getParentParagraph, isDeleteRevision, isFormatRevision, isInsertRevision, isMoveFromRevision, isMoveToRevision, removeMoveRevisions, removeRunAttr, setRunAttr

Methods inherited from class com.aspose.words.Node

deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, isComposite, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

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

Accepts a visitor.

Remarks:

Calls DocumentVisitor.visitAbsolutePositionTab(com.aspose.words.AbsolutePositionTab).

For more info see the Visitor design pattern.

Examples:

Shows how to process absolute position tab characters with a document visitor.

 
 public void documentToTxt() throws Exception {
     Document doc = new Document(getMyDir() + "Absolute position tab.docx");

     // Extract the text contents of our document by accepting this custom document visitor.
     DocTextExtractor myDocTextExtractor = new DocTextExtractor();
     Section fisrtSection = doc.getFirstSection();
     fisrtSection.getBody().accept(myDocTextExtractor);
     // Visit only start of the document body.
     fisrtSection.getBody().acceptStart(myDocTextExtractor);
     // Visit only end of the document body.
     fisrtSection.getBody().acceptEnd(myDocTextExtractor);

     // The absolute position tab, which has no equivalent in string form, has been explicitly converted to a tab character.
     Assert.assertEquals("Before AbsolutePositionTab\tAfter AbsolutePositionTab", myDocTextExtractor.getText());

     // An AbsolutePositionTab can accept a DocumentVisitor by itself too.
     AbsolutePositionTab absPositionTab = (AbsolutePositionTab) doc.getFirstSection().getBody().getFirstParagraph().getChild(NodeType.SPECIAL_CHAR, 0, true);

     myDocTextExtractor = new DocTextExtractor();
     absPositionTab.accept(myDocTextExtractor);

     Assert.assertEquals("\t", myDocTextExtractor.getText());
 }

 /// <summary>
 /// Collects the text contents of all runs in the visited document. Replaces all absolute tab characters with ordinary tabs.
 /// </summary>
 public static class DocTextExtractor extends DocumentVisitor {
     public DocTextExtractor() {
         mBuilder = new StringBuilder();
     }

     /// <summary>
     /// Called when a Run node is encountered in the document.
     /// </summary>
     public int visitRun(final Run run) {
         appendText(run.getText());
         return VisitorAction.CONTINUE;
     }

     /// <summary>
     /// Called when an AbsolutePositionTab node is encountered in the document.
     /// </summary>
     public int visitAbsolutePositionTab(final AbsolutePositionTab tab) {
         mBuilder.append("\t");

         return VisitorAction.CONTINUE;
     }

     /// <summary>
     /// Adds text to the current output. Honors the enabled/disabled output flag.
     /// </summary>
     public void appendText(final String text) {
         mBuilder.append(text);
     }

     /// <summary>
     /// Plain text of the document that was accumulated by the visitor.
     /// </summary>
     public String getText() {
         return mBuilder.toString();
     }

     private final StringBuilder mBuilder;
 }
 
 

Overrides:

accept in class SpecialChar

Parameters:

visitor - The visitor that will visit the node.

Returns:

false if the visitor requested the enumeration to stop.

Throws:

java.lang.Exception