com.aspose.words
Class Inline

java.lang.Object
  extended by Node
      extended by com.aspose.words.Inline
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
Run, SpecialChar

public abstract class Inline 
extends Node

Base class for inline-level nodes that can have character formatting associated with them, but cannot have child nodes of their own.

A class derived from Inline can be a child of Paragraph.


Property Getters/Setters Summary
DocumentBasegetDocument()→ inherited from Node
           Gets the document to which this node belongs.
FontgetFont()
           Provides access to the font formatting of this object.
booleanisComposite()→ inherited from Node
           Returns true if this node can contain other nodes.
booleanisDeleteRevision()
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisFormatRevision()
           Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
abstract intgetNodeType()→ inherited from Node
           Gets the type of this node. The value of the property is NodeType integer constant.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()
           Retrieves the parent Paragraph of this node.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
 
Method Summary
abstract booleanaccept(DocumentVisitor visitor)→ inherited from Node
           Accepts a visitor.
voidclearRunAttrs()
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)→ inherited from Node
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)
          Reserved for internal use.
CompositeNodegetAncestor(int ancestorType)→ inherited from Node
           Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified object type.
aspose.obfuscated.typegetDeleteRevision()
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)
          Reserved for internal use.
intgetDirectRunAttrsCount()
          Reserved for internal use.
DocumentBasegetDocument_IInline()
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)
          Reserved for internal use.
aspose.obfuscated.typegetInsertRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()
          Reserved for internal use.
ParagraphgetParentParagraph_IInline()
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()
          Reserved for internal use.
java.lang.StringgetText()→ inherited from Node
           Gets the text of this node and of all its children.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidremoveRunAttr(int key)
          Reserved for internal use.
voidsetDeleteRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)
          Reserved for internal use.
java.lang.StringtoString(int saveFormat)→ inherited from Node
           Exports the content of the node into a string in the specified format.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

getDocument

→ inherited from Node
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.


getFont

public Font getFont()
Provides access to the font formatting of this object.

isComposite

→ inherited from Node
public boolean isComposite()
Returns true if this node can contain other nodes. This method returns false as Node cannot have child nodes.

isDeleteRevision

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

isFormatRevision

public boolean isFormatRevision()
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.

isInsertRevision

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

getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

→ inherited from Node
public abstract int getNodeType()
Gets the type of this node. The value of the property is NodeType integer constant.

getParentNode

→ inherited from Node
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.


getParentParagraph

public Paragraph getParentParagraph()
Retrieves the parent Paragraph of this node.

getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

→ inherited from Node
public Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

Method Detail

accept

→ inherited from Node
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.

clearRunAttrs

public void clearRunAttrs()
Reserved for internal use.

deepClone

→ inherited from Node
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.

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int fontAttr)
Reserved for internal use.

getAncestor

→ inherited from Node
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.

getAncestor

→ inherited from Node
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.

getDeleteRevision

public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

getDirectRunAttrsCount

public int getDirectRunAttrsCount()
Reserved for internal use.

getDocument_IInline

public DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getInsertRevision

public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getParentParagraph_IInline

public Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getText

→ inherited from Node
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.


nextPreOrder

→ inherited from Node
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.

previousPreOrder

→ inherited from Node
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.

remove

→ inherited from Node
public void remove()
Removes itself from the parent.

removeRunAttr

public void removeRunAttr(int key)
Reserved for internal use.

setDeleteRevision

public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

setRunPr_IInline

public void setRunPr_IInline(aspose.obfuscated.type value)
Reserved for internal use.

toString

→ inherited from Node
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.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from getText() which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
#Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ParagraphBreak, #Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.