Paragraph (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Node
- - com.aspose.words.CompositeNode
  - - com.aspose.words.Paragraph

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable
```
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 complete list of child nodes that can occur inside a paragraph consists of BookmarkStart, BookmarkEnd, FieldStart, FieldSeparator, FieldEnd, FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, SmartTag.

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

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`Paragraph(DocumentBase doc)` Initializes a new instance of the Paragraph class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(DocumentVisitor visitor)` Accepts a visitor.
`Field`	`appendField(int fieldType, boolean updateField)`
`Field`	`appendField(java.lang.String fieldCode)` Appends a Word field to this paragraph.
`Field`	`appendField(java.lang.String fieldCode, java.lang.String fieldValue)` Appends a Word field to this paragraph.
`void`	`clearParaAttrs()`
`void`	`clearRunAttrs()`
`java.lang.Object`	`fetchInheritedParaAttr(int key)`
`java.lang.Object`	`fetchInheritedRunAttr(int key)`
`java.lang.Object`	`fetchParaAttr(int key)`
`boolean`	`getBreakIsStyleSeparator()` True if this paragraph break is a Style Separator.
`java.lang.Object`	`getDirectParaAttr(int key)`
`java.lang.Object`	`getDirectParaAttr(int key, int revisionsView)`
`java.lang.Object`	`getDirectRunAttr(int key)`
`TabStop[]`	`getEffectiveTabStops()` Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists.
`FrameFormat`	`getFrameFormat()` Provides access to the paragraph formatting properties.
`ListFormat`	`getListFormat()` Provides access to the list formatting properties of the paragraph.
`ListLabel`	`getListLabel()` Gets a `getListLabel()` object that provides access to list numbering value and formatting for this paragraph.
`int`	`getNodeType()` Returns NodeType.Paragraph.
`Font`	`getParagraphBreakFont()` Provides access to the font formatting of the paragraph break character.
`ParagraphFormat`	`getParagraphFormat()` Provides access to the paragraph formatting properties.
`Section`	`getParentSection()` Retrieves the parent `Section` of the paragraph.
`Story`	`getParentStory()` Retrieves the parent section-level story that can be `Body` or `HeaderFooter`.
`RunCollection`	`getRuns()` Provides access to the typed collection of pieces of text inside the paragraph.
`java.lang.String`	`getText()` Gets the text of this paragraph including the end of paragraph character.
`Field`	`insertField(int fieldType, boolean updateField, Node refNode, boolean isAfter)`
`Field`	`insertField(java.lang.String fieldCode, Node refNode, boolean isAfter)` Inserts a Word field into this paragraph.
`Field`	`insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter)` Inserts a Word field into this paragraph.
`boolean`	`isDeleteRevision()` Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
`boolean`	`isEndOfCell()` True if this paragraph is the last paragraph in a `Cell`; false otherwise.
`boolean`	`isEndOfDocument()` True if this paragraph is the last paragraph in the last section of the document.
`boolean`	`isEndOfHeaderFooter()` True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise.
`boolean`	`isEndOfSection()` True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.
`boolean`	`isFormatRevision()` Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
`boolean`	`isInCell()` True if this paragraph is an immediate child of `Cell`; false otherwise.
`boolean`	`isInsertRevision()` Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
`boolean`	`isListItem()` True when the paragraph is an item in a bulleted or numbered list in original revision.
`boolean`	`isMoveFromRevision()` Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
`boolean`	`isMoveToRevision()` Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
`int`	`joinRunsWithSameFormatting()` Joins runs with the same formatting in the paragraph.
`void`	`removeMoveRevisions()`
`void`	`removeParaAttr(int key)`
`void`	`removeRunAttr(int key)`
`void`	`setParaAttr(int key, java.lang.Object value)`
`void`	`setRunAttr(int key, java.lang.Object value)`

Methods inherited from class com.aspose.words.CompositeNode
acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node
dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, 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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Paragraph
```
public Paragraph(DocumentBase 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.
- Method Detail
  - getNodeType
```
public int getNodeType()
```
    Returns NodeType.Paragraph.
    
    Specified by:
    
    getNodeType in class Node
    
    Returns:
    
    NodeType.Paragraph. The returned value is one of NodeType constants.
  - getParentStory
```
public Story getParentStory()
```
    Retrieves the parent section-level story that can be Body or HeaderFooter.
    
    Returns:
    
    The corresponding Story value.
  - getParentSection
```
public Section getParentSection()
```
    Retrieves the parent Section of the paragraph.
    
    Returns:
    
    The corresponding Section value.
  - isInCell
```
public boolean isInCell()
```
    True if this paragraph is an immediate child of Cell; false otherwise.
    
    Returns:
    
    The corresponding boolean value.
  - isEndOfCell
```
public boolean isEndOfCell()
```
    True if this paragraph is the last paragraph in a Cell; false otherwise.
    
    Returns:
    
    The corresponding boolean value.
  - getBreakIsStyleSeparator
```
public boolean getBreakIsStyleSeparator()
```
    True if this paragraph break is a Style Separator. A style separator allows one paragraph to consist of parts that have different paragraph styles.
    
    Returns:
    
    The corresponding boolean value.
  - isEndOfSection
```
public boolean isEndOfSection()
```
    True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.
    
    Returns:
    
    The corresponding boolean value.
  - isEndOfHeaderFooter
```
public boolean isEndOfHeaderFooter()
```
    True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise.
    
    Returns:
    
    The corresponding boolean value.
  - isEndOfDocument
```
public boolean isEndOfDocument()
```
    True if this paragraph is the last paragraph in the last section of the document.
    
    Returns:
    
    The corresponding boolean value.
  - getParagraphFormat
```
public ParagraphFormat getParagraphFormat()
```
    Provides access to the paragraph formatting properties.
    
    Returns:
    
    The corresponding ParagraphFormat value.
  - getListFormat
```
public ListFormat getListFormat()
```
    Provides access to the list formatting properties of the paragraph.
    
    Returns:
    
    The corresponding ListFormat value.
  - getFrameFormat
```
public FrameFormat getFrameFormat()
```
    Provides access to the paragraph formatting properties.
    
    Returns:
    
    The corresponding FrameFormat value.
  - getListLabel
```
public ListLabel getListLabel()
```
    Gets a getListLabel() object that provides access to list numbering value and formatting for this paragraph.
    
    Returns:
    
    A getListLabel() object that provides access to list numbering value and formatting for this paragraph.
  - getRuns
```
public RunCollection getRuns()
```
    Provides access to the typed collection of pieces of text inside the paragraph.
    
    Returns:
    
    The corresponding RunCollection value.
  - getParagraphBreakFont
```
public Font getParagraphBreakFont()
```
    Provides access to the font formatting of the paragraph break character.
    
    Returns:
    
    The corresponding Font value.
  - isInsertRevision
```
public boolean isInsertRevision()
```
    Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    True if this object was inserted 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.
    
    Returns:
    
    True if this object was deleted in Microsoft Word while change tracking was enabled.
  - isMoveFromRevision
```
public boolean isMoveFromRevision()
```
    Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
  - isMoveToRevision
```
public boolean isMoveToRevision()
```
    Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    true if this object was moved (inserted) 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.
    
    Returns:
    
    True if formatting of the object was changed in Microsoft Word while change tracking was enabled.
  - 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.
    
    Specified by:
    
    accept in class Node
    
    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.
    
    Throws:
    
    java.lang.Exception
  - 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:
    - If the paragraph is the last paragraph of Body, then ControlChar.SECTION_BREAK (\x000c) is appended.
    - If the paragraph is the last paragraph of Cell, then ControlChar.CELL (\x0007) is appended.
    - For all other paragraphs ControlChar.PARAGRAPH_BREAK (\r) is appended.
    The returned string includes all control and special characters as described in ControlChar.
    Overrides:
    
    getText in class CompositeNode
  - getDirectParaAttr
```
public java.lang.Object getDirectParaAttr(int key)
```
  - getDirectParaAttr
```
public java.lang.Object getDirectParaAttr(int key,
                                          int revisionsView)
```
  - fetchInheritedParaAttr
```
public java.lang.Object fetchInheritedParaAttr(int key)
```
  - fetchParaAttr
```
public java.lang.Object fetchParaAttr(int key)
```
  - setParaAttr
```
public void setParaAttr(int key,
                        java.lang.Object value)
```
  - removeParaAttr
```
public void removeParaAttr(int key)
```
  - clearParaAttrs
```
public void clearParaAttrs()
```
  - getDirectRunAttr
```
public java.lang.Object getDirectRunAttr(int key)
```
  - fetchInheritedRunAttr
```
public java.lang.Object fetchInheritedRunAttr(int key)
```
  - setRunAttr
```
public void setRunAttr(int key,
                       java.lang.Object value)
```
  - removeRunAttr
```
public void removeRunAttr(int key)
```
  - clearRunAttrs
```
public void clearRunAttrs()
```
  - removeMoveRevisions
```
public void removeMoveRevisions()
```
  - isListItem
```
public boolean isListItem()
```
    True when the paragraph is an item in a bulleted or numbered list in original revision.
    
    Returns:
    
    The corresponding boolean value.
  - getEffectiveTabStops
```
public TabStop[] getEffectiveTabStops()
```
    Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists.
  - joinRunsWithSameFormatting
```
public int joinRunsWithSameFormatting()
```
    Joins runs with the same formatting in the paragraph.
    
    Returns:
    
    Number of joins performed. When N adjacent runs are being joined they count as N - 1 joins.
  - appendField
```
public Field appendField(int fieldType,
                         boolean updateField)
                  throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - appendField
```
public Field appendField(java.lang.String fieldCode)
                  throws java.lang.Exception
```
    Appends a Word field to this paragraph. Appends a field to this paragraph.
    
    Parameters:
    
    fieldCode - The field code to append (without curly braces).
    
    Returns:
    
    A Field object that represents the appended field.
    
    Throws:
    
    java.lang.Exception
  - appendField
```
public Field appendField(java.lang.String fieldCode,
                         java.lang.String fieldValue)
```
    Appends a Word field to this paragraph. Appends a field to this paragraph.
    
    Parameters:
    
    fieldCode - The field code to append (without curly braces).
    
    fieldValue - The field value to append. Pass null for fields that do not have a value.
    
    Returns:
    
    A Field object that represents the appended field.
  - insertField
```
public Field insertField(int fieldType,
                         boolean updateField,
                         Node refNode,
                         boolean isAfter)
                  throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - insertField
```
public Field insertField(java.lang.String fieldCode,
                         Node refNode,
                         boolean isAfter)
                  throws java.lang.Exception
```
    Inserts a Word field into this paragraph. Inserts a field into this paragraph.
    
    Parameters:
    
    fieldCode - The field code to insert (without curly braces).
    
    refNode - Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).
    
    isAfter - Whether to insert the field after or before reference node.
    
    Returns:
    
    A Field object that represents the inserted field.
    
    Throws:
    
    java.lang.Exception
  - insertField
```
public Field insertField(java.lang.String fieldCode,
                         java.lang.String fieldValue,
                         Node refNode,
                         boolean isAfter)
```
    Inserts a Word field into this paragraph. Inserts a field into this paragraph.
    
    Parameters:
    
    fieldCode - The field code to insert (without curly braces).
    
    fieldValue - The field value to insert. Pass null for fields that do not have a value.
    
    refNode - Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).
    
    isAfter - Whether to insert the field after or before reference node.
    
    Returns:
    
    A Field object that represents the inserted field.

Class Paragraph

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.CompositeNode

Methods inherited from class com.aspose.words.Node

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Paragraph

Method Detail

getNodeType

getParentStory

getParentSection

isInCell

isEndOfCell

getBreakIsStyleSeparator

isEndOfSection

isEndOfHeaderFooter

isEndOfDocument

getParagraphFormat

getListFormat

getFrameFormat

getListLabel

getRuns

getParagraphBreakFont

isInsertRevision

isDeleteRevision

isMoveFromRevision

isMoveToRevision

isFormatRevision

accept

getText

getDirectParaAttr

getDirectParaAttr

fetchInheritedParaAttr

fetchParaAttr

setParaAttr

removeParaAttr

clearParaAttrs

getDirectRunAttr

fetchInheritedRunAttr

setRunAttr

removeRunAttr

clearRunAttrs

removeMoveRevisions

isListItem

getEffectiveTabStops

joinRunsWithSameFormatting

appendField

appendField

appendField

insertField

insertField

insertField