ASPOSE home

com.aspose.words
Class Paragraph

java.lang.Object
  extended by Node
      extended by CompositeNode
          extended by com.aspose.words.Paragraph
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable

public class Paragraph
extends CompositeNode

Represents a paragraph of text.

Paragraph is a block-level node and can be a child of classes derived from Story or InlineStory.

Paragraph can contain any number of inline-level nodes and bookmarks. The inline nodes include all classes derived from Inline and InlineStory.

The complete list of child nodes that can occur inside a paragraph consists of Run, BookmarkStart, BookmarkEnd, Shape, GroupShape, Footnote, Comment, FieldStart, FieldSeparator, FieldEnd, SpecialChar.

A valid paragraph in Microsoft Word always ends with a paragraph break character and a minimal valid paragraph consists just of a paragraph break. The Paragraph class automatically appends the appropriate paragraph break character at the end and this character is not part of the child nodes of the Paragraph, therefore a Paragraph can be empty.

Do not include the end of paragraph ControlChar.PARAGRAPH_BREAK or end of cell ControlChar.CELL characters inside the text of the paragraph as it might make the paragraph invalid when the document is opened in Microsoft Word.


Constructor Summary
Paragraph(Document doc)
           Initializes a new instance of the Paragraph class.
 
Property Getters/Setters Summary
NodeCollectiongetChildNodes()→ inherited from CompositeNode
           Gets all immediate child nodes of this node.
intgetCount()→ inherited from CompositeNode
           Gets the number of immediate children of this node.
DocumentgetDocument()→ inherited from Node
           Gets the document to which this node belongs.
NodegetFirstChild()→ inherited from CompositeNode
           Gets the first child of the node.
booleanhasChildNodes()→ inherited from CompositeNode
           Returns true if this node has any child nodes.
booleanisComposite()→ inherited from CompositeNode
           Returns true as this node can have child nodes.
booleanisDeleteRevision()
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisEndOfCell()
           True if this paragraph is the last paragraph in a Cell; false otherwise.
booleanisEndOfDocument()
           True if this paragraph is the last paragraph in the last section of the document.
booleanisEndOfSection()
           True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.
booleanisInCell()
           True if this paragraph is an immediate child of Cell; false otherwise.
booleanisInsertRevision()
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisListItem()
           True when the paragraph is an item in a bulleted or numbered list.
NodegetLastChild()→ inherited from CompositeNode
           Gets the last child of the node.
ListFormatgetListFormat()
           Provides access to the list formatting properties of the paragraph.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
intgetNodeType()
           Returns NodeType.Paragraph. The value of the property is NodeType integer constant.
FontgetParagraphBreakFont()
           Provides access to the font formatting of the paragraph break character.
ParagraphFormatgetParagraphFormat()
           Provides access to the paragraph formatting properties.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
SectiongetParentSection()
           Retrieves the parent Section of the paragraph.
StorygetParentStory()
           Retrieves the parent section-level story that can be Body or HeaderFooter.
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.
RunsgetRuns()
           Provides access to the typed collection of pieces of text inside the paragraph.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
NodeappendChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the end of the list of child nodes for this node.
voidclearParaAttrs()
          Reserved for internal use.
voidclearRunAttrs()
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedParaAttr(int key)
          Reserved for internal use.
java.lang.ObjectfetchInheritedRunAttr(int key)
          Reserved for internal use.
NodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified type.
NodegetChild(int nodeType, int index, boolean isDeep)→ inherited from CompositeNode
           Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)→ inherited from CompositeNode
           Returns a live collection of child nodes that match the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep, boolean isLive)→ inherited from CompositeNode
           Returns a "live" or "snapshot" collection of child node that match the specified type.
java.lang.ObjectgetDirectParaAttr(int key)
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int key)
          Reserved for internal use.
Aspose.Words.ParaPrgetParaPr()
          Reserved for internal use.
Aspose.Words.RunPrgetRunPr()
          Reserved for internal use.
java.lang.StringgetText()
           Gets the text of this paragraph including the end of paragraph character.
intindexOf(Node child)→ inherited from CompositeNode
           Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately before the specified reference node.
java.util.Iteratoriterator()→ inherited from CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the beginning of the list of child nodes for this node.
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.
voidremoveAllChildren()→ inherited from CompositeNode
           Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)→ inherited from CompositeNode
           Removes the specified child node.
NodeListselectNodes(java.lang.String xpath)→ inherited from CompositeNode
           Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)→ inherited from CompositeNode
           Selects the first Node that matches the XPath expression.
voidsetParaAttr(int key, java.lang.Object value)
          Reserved for internal use.
voidsetRunAttr(int key, java.lang.Object value)
          Reserved for internal use.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in TXT (plain text) format.
 

Constructor Detail

Paragraph

public Paragraph(Document doc)
Initializes a new instance of the Paragraph class.

When Paragraph is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Paragraph to the document use InsertAfter or InsertBefore on the story where you want the paragraph inserted.

Parameters:
doc - The owner document.

Property Getters/Setters Detail

getNodeType

public int getNodeType()
Returns NodeType.Paragraph. The value of the property is NodeType integer constant.

getParentStory

public Story getParentStory()
Retrieves the parent section-level story that can be Body or HeaderFooter.

getParentSection

public Section getParentSection()
Retrieves the parent Section of the paragraph.

isInCell

public boolean isInCell()
True if this paragraph is an immediate child of Cell; false otherwise.

isEndOfCell

public boolean isEndOfCell()
True if this paragraph is the last paragraph in a Cell; false otherwise.

isEndOfSection

public boolean isEndOfSection()
True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.

isEndOfDocument

public boolean isEndOfDocument()
True if this paragraph is the last paragraph in the last section of the document.

getParagraphFormat

public ParagraphFormat getParagraphFormat()
Provides access to the paragraph formatting properties.

getListFormat

public ListFormat getListFormat()
Provides access to the list formatting properties of the paragraph.

getRuns

public Runs getRuns()
Provides access to the typed collection of pieces of text inside the paragraph.

getParagraphBreakFont

public Font getParagraphBreakFont()
Provides access to the font formatting of the paragraph break character.

isInsertRevision

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

isDeleteRevision

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

isListItem

public boolean isListItem()
True when the paragraph is an item in a bulleted or numbered list.

isComposite

→ inherited from CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

hasChildNodes

→ inherited from CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

If there are no child nodes, this property returns an empty collection.

ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false).


getFirstChild

→ inherited from CompositeNode
public Node getFirstChild()
Gets the first child of the node. If there is no first child node, a null is returned.

getLastChild

→ inherited from CompositeNode
public Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

getCount

→ inherited from CompositeNode
public int getCount()
Gets the number of immediate children of this node.

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.


getDocument

→ inherited from Node
public Document 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 yed added to the tree, or if it has been removed from the tree.


getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node.

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

Note: Calculating the value of this property iterates from the first child node of ParenNode to this node.

getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next 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

iterator

→ inherited from CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

getText

public java.lang.String getText()
Gets the text of this paragraph including the end of paragraph character.

The text of all child nodes is concatenated and the end of paragraph character is appended as follows:

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


accept

public 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.

Calls DocumentVisitor.VisitParagraphStart, then calls Accept for all child nodes of the paragraph and calls DocumentVisitor.VisitParagraphEnd at the end.
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.

deepClone

public Node deepClone(boolean isCloneChildren)
              throws java.lang.Exception
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.

getChildNodes

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

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes(int nodeType, boolean isDeep, boolean isLive)
Returns a "live" or "snapshot" collection of child node that match the specified type.

Snapshot collections require less resources than live collections because a snapshot collection of nodes is not updated when the document is changed.

Snapshot collections are useful for tasks, that do not require immediate update of the collection when the document is changed. For example, select all shapes and delete them is more efficient using a snapshot collection.

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.
isLive - True to return a live collection; false to return a snapshot collection.
Returns:
A collection of child nodes of the specified type.

getChild

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

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.
Returns:
The child node that matches the criteria or null if no matching node is found.

selectNodes

→ inherited from CompositeNode
public NodeList selectNodes(java.lang.String xpath)
                    throws org.jaxen.JaxenException
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.

selectSingleNode

→ inherited from CompositeNode
public Node selectSingleNode(java.lang.String xpath)
                     throws org.jaxen.JaxenException
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.

appendChild

→ inherited from CompositeNode
public Node appendChild(Node newChild)
                throws java.lang.Exception
Adds the specified node to the end of the list of child nodes for this node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use Document.importNode(com.aspose.words.Node, boolean) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The node to add.
Returns:
The node added.

prependChild

→ inherited from CompositeNode
public Node prependChild(Node newChild)
                 throws java.lang.Exception
Adds the specified node to the beginning of the list of child nodes for this node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use Document.importNode(com.aspose.words.Node, boolean) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The node to add.
Returns:
The node added.

insertAfter

→ inherited from CompositeNode
public Node insertAfter(Node newChild, Node refChild)
                throws java.lang.Exception
Inserts the specified node immediately after the specified reference node.

If refChild is null, inserts newChild at the beginning of the list of child nodes.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use Document.importNode(com.aspose.words.Node, boolean) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newNode is placed after the refNode.
Returns:
The inserted node.

insertBefore

→ inherited from CompositeNode
public Node insertBefore(Node newChild, Node refChild)
                 throws java.lang.Exception
Inserts the specified node immediately before the specified reference node.

If refChild is null, inserts newChild at the end of the list of child nodes.

Note: InsertBefore could be slower than InsertAfter because it needs to iterate over all nodes from the first child to the reference node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use Document.importNode(com.aspose.words.Node, boolean) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newChild is placed before this node.
Returns:
The inserted node.

removeChild

→ inherited from CompositeNode
public Node removeChild(Node oldChild)
                throws java.lang.Exception
Removes the specified child node.

The parent of oldChild is set to null after the node is removed.

Parameters:
oldChild - The node to remove.
Returns:
The removed node.

removeAllChildren

→ inherited from CompositeNode
public void removeAllChildren()
                      throws java.lang.Exception
Removes all the child nodes of the current node.

indexOf

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

getAncestor

→ inherited from Node
public Node getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified type.

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

Parameters:
ancestorType - The type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

remove

→ inherited from Node
public void remove()
           throws java.lang.Exception
Removes itself from the parent.

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.

toTxt

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

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

Returns:
The content of the node in plain text format.

getRunPr

public Aspose.Words.RunPr getRunPr()
Reserved for internal use.

getParaPr

public Aspose.Words.ParaPr getParaPr()
Reserved for internal use.

clearRunAttrs

public void clearRunAttrs()
Reserved for internal use.

setRunAttr

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

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int key)
                            throws java.lang.Exception
Reserved for internal use.

getDirectRunAttr

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

clearParaAttrs

public void clearParaAttrs()
Reserved for internal use.

setParaAttr

public void setParaAttr(int key, java.lang.Object value)
Reserved for internal use.

fetchInheritedParaAttr

public java.lang.Object fetchInheritedParaAttr(int key)
                             throws java.lang.Exception
Reserved for internal use.

getDirectParaAttr

public java.lang.Object getDirectParaAttr(int key)
                        throws java.lang.Exception
Reserved for internal use.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home