ParagraphFormat (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.ParagraphFormat

public class ParagraphFormat
extends java.lang.Object

Represents all the formatting for a paragraph.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFormatting()` Resets to default paragraph formatting.
`java.lang.Object`	`fetchInheritedBorderAttr(int key)`
`java.lang.Object`	`fetchInheritedShadingAttr(int key)`
`boolean`	`getAddSpaceBetweenFarEastAndAlpha()` Gets a flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
`boolean`	`getAddSpaceBetweenFarEastAndDigit()` Gets a flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
`int`	`getAlignment()` Gets text alignment for the paragraph.
`boolean`	`getBidi()` Gets whether this is a right-to-left paragraph.
`BorderCollection`	`getBorders()` Gets collection of borders of the paragraph.
`double`	`getCharacterUnitFirstLineIndent()` Gets the value (in characters) for the first-line or hanging indent.
`double`	`getCharacterUnitLeftIndent()` Gets the left indent value (in characters) for the specified paragraphs.
`double`	`getCharacterUnitRightIndent()` Gets the right indent value (in characters) for the specified paragraphs.
`java.lang.Object`	`getDirectBorderAttr(int key)`
`int`	`getDropCapPosition()` Gets the position for a drop cap text.
`boolean`	`getFarEastLineBreakControl()` Gets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
`double`	`getFirstLineIndent()` Gets the value (in points) for a first line or hanging indent.
`boolean`	`getHangingPunctuation()` Gets a flag indicating whether hanging punctuation is enabled for the current paragraph.
`boolean`	`getKeepTogether()` True if all lines in the paragraph are to remain on the same page.
`boolean`	`getKeepWithNext()` True if the paragraph is to remains on the same page as the paragraph that follows it.
`double`	`getLeftIndent()` Gets the value (in points) that represents the left indent for paragraph.
`double`	`getLineSpacing()` Gets the line spacing (in points) for the paragraph.
`int`	`getLineSpacingRule()` Gets the line spacing for the paragraph.
`int`	`getLinesToDrop()` Gets the number of lines of the paragraph text used to calculate the drop cap height.
`double`	`getLineUnitAfter()` Gets the amount of spacing (in gridlines) after the paragraphs.
`double`	`getLineUnitBefore()` Gets the amount of spacing (in gridlines) before the paragraphs.
`boolean`	`getNoSpaceBetweenParagraphsOfSameStyle()` When true, `getSpaceBefore()` / `setSpaceBefore(double)` and `getSpaceAfter()` / `setSpaceAfter(double)` will be ignored between the paragraphs of the same style.
`int`	`getOutlineLevel()` Specifies the outline level of the paragraph in the document.
`boolean`	`getPageBreakBefore()` True if a page break is forced before the paragraph.
`double`	`getRightIndent()` Gets the value (in points) that represents the right indent for paragraph.
`Shading`	`getShading()` Returns a Shading object that refers to the shading formatting for the paragraph.
`boolean`	`getSnapToGrid()` Specifies whether the current paragraph should use the document grid lines per page settings when laying out the contents in the paragraph.
`double`	`getSpaceAfter()` Gets the amount of spacing (in points) after the paragraph.
`boolean`	`getSpaceAfterAuto()` True if the amount of spacing after the paragraph is set automatically.
`double`	`getSpaceBefore()` Gets the amount of spacing (in points) before the paragraph.
`boolean`	`getSpaceBeforeAuto()` True if the amount of spacing before the paragraph is set automatically.
`Style`	`getStyle()` Gets the paragraph style applied to this formatting.
`int`	`getStyleIdentifier()` Gets the locale independent style identifier of the paragraph style applied to this formatting.
`java.lang.String`	`getStyleName()` Gets the name of the paragraph style applied to this formatting.
`boolean`	`getSuppressAutoHyphens()` Specifies whether the current paragraph should be exempted from any hyphenation which is applied in the document settings.
`boolean`	`getSuppressLineNumbers()` Specifies whether the current paragraph's lines should be exempted from line numbering which is applied in the parent section.
`TabStopCollection`	`getTabStops()` Gets the collection of custom tab stops defined for this object.
`boolean`	`getWidowControl()` True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
`boolean`	`getWordWrap()` If this property is false, Latin text in the middle of a word can be wrapped for the current paragraph.
`boolean`	`isHeading()` True when the paragraph style is one of the built-in Heading styles.
`boolean`	`isListItem()` True when the paragraph is an item in a bulleted or numbered list.
`void`	`setAddSpaceBetweenFarEastAndAlpha(boolean value)` Sets a flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
`void`	`setAddSpaceBetweenFarEastAndDigit(boolean value)` Sets a flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
`void`	`setAlignment(int value)` Sets text alignment for the paragraph.
`void`	`setBidi(boolean value)` Sets whether this is a right-to-left paragraph.
`void`	`setBorderAttr(int key, java.lang.Object value)`
`void`	`setCharacterUnitFirstLineIndent(double value)` Sets the value (in characters) for the first-line or hanging indent.
`void`	`setCharacterUnitLeftIndent(double value)` Sets the left indent value (in characters) for the specified paragraphs.
`void`	`setCharacterUnitRightIndent(double value)` Sets the right indent value (in characters) for the specified paragraphs.
`void`	`setDropCapPosition(int value)` Sets the position for a drop cap text.
`void`	`setFarEastLineBreakControl(boolean value)` Sets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
`void`	`setFirstLineIndent(double value)` Sets the value (in points) for a first line or hanging indent.
`void`	`setHangingPunctuation(boolean value)` Sets a flag indicating whether hanging punctuation is enabled for the current paragraph.
`void`	`setKeepTogether(boolean value)` True if all lines in the paragraph are to remain on the same page.
`void`	`setKeepWithNext(boolean value)` True if the paragraph is to remains on the same page as the paragraph that follows it.
`void`	`setLeftIndent(double value)` Sets the value (in points) that represents the left indent for paragraph.
`void`	`setLineSpacing(double value)` Sets the line spacing (in points) for the paragraph.
`void`	`setLineSpacingRule(int value)` Sets the line spacing for the paragraph.
`void`	`setLinesToDrop(int value)` Sets the number of lines of the paragraph text used to calculate the drop cap height.
`void`	`setLineUnitAfter(double value)` Sets the amount of spacing (in gridlines) after the paragraphs.
`void`	`setLineUnitBefore(double value)` Sets the amount of spacing (in gridlines) before the paragraphs.
`void`	`setNoSpaceBetweenParagraphsOfSameStyle(boolean value)` When true, `getSpaceBefore()` / `setSpaceBefore(double)` and `getSpaceAfter()` / `setSpaceAfter(double)` will be ignored between the paragraphs of the same style.
`void`	`setOutlineLevel(int value)` Specifies the outline level of the paragraph in the document.
`void`	`setPageBreakBefore(boolean value)` True if a page break is forced before the paragraph.
`void`	`setRightIndent(double value)` Sets the value (in points) that represents the right indent for paragraph.
`void`	`setSnapToGrid(boolean value)` Specifies whether the current paragraph should use the document grid lines per page settings when laying out the contents in the paragraph.
`void`	`setSpaceAfter(double value)` Sets the amount of spacing (in points) after the paragraph.
`void`	`setSpaceAfterAuto(boolean value)` True if the amount of spacing after the paragraph is set automatically.
`void`	`setSpaceBefore(double value)` Sets the amount of spacing (in points) before the paragraph.
`void`	`setSpaceBeforeAuto(boolean value)` True if the amount of spacing before the paragraph is set automatically.
`void`	`setStyle(Style value)` Sets the paragraph style applied to this formatting.
`void`	`setStyleIdentifier(int value)` Sets the locale independent style identifier of the paragraph style applied to this formatting.
`void`	`setStyleName(java.lang.String value)` Sets the name of the paragraph style applied to this formatting.
`void`	`setSuppressAutoHyphens(boolean value)` Specifies whether the current paragraph should be exempted from any hyphenation which is applied in the document settings.
`void`	`setSuppressLineNumbers(boolean value)` Specifies whether the current paragraph's lines should be exempted from line numbering which is applied in the parent section.
`void`	`setWidowControl(boolean value)` True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
`void`	`setWordWrap(boolean value)` If this property is false, Latin text in the middle of a word can be wrapped for the current paragraph.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - clearFormatting
```
public void clearFormatting()
```
    Resets to default paragraph formatting. Default paragraph formatting is Normal style, left aligned, no indentation, no spacing, no borders and no shading.
  - getAlignment
```
public int getAlignment()
```
    Gets text alignment for the paragraph.
    
    Returns:
    
    Text alignment for the paragraph. The returned value is one of ParagraphAlignment constants.
  - setAlignment
```
public void setAlignment(int value)
```
    Sets text alignment for the paragraph.
    
    Parameters:
    
    value - Text alignment for the paragraph. The value must be one of ParagraphAlignment constants.
  - getNoSpaceBetweenParagraphsOfSameStyle
```
public boolean getNoSpaceBetweenParagraphsOfSameStyle()
```
    When true, getSpaceBefore() / setSpaceBefore(double) and getSpaceAfter() / setSpaceAfter(double) will be ignored between the paragraphs of the same style.
    This setting only takes affect when applied to a paragraph style. If applied to a paragraph directly, it has no effect.
    
    Returns:
    
    The corresponding boolean value.
  - setNoSpaceBetweenParagraphsOfSameStyle
```
public void setNoSpaceBetweenParagraphsOfSameStyle(boolean value)
```
    When true, getSpaceBefore() / setSpaceBefore(double) and getSpaceAfter() / setSpaceAfter(double) will be ignored between the paragraphs of the same style.
    This setting only takes affect when applied to a paragraph style. If applied to a paragraph directly, it has no effect.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getKeepTogether
```
public boolean getKeepTogether()
```
    True if all lines in the paragraph are to remain on the same page.
    
    Returns:
    
    The corresponding boolean value.
  - setKeepTogether
```
public void setKeepTogether(boolean value)
```
    True if all lines in the paragraph are to remain on the same page.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getKeepWithNext
```
public boolean getKeepWithNext()
```
    True if the paragraph is to remains on the same page as the paragraph that follows it.
    
    Returns:
    
    The corresponding boolean value.
  - setKeepWithNext
```
public void setKeepWithNext(boolean value)
```
    True if the paragraph is to remains on the same page as the paragraph that follows it.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getPageBreakBefore
```
public boolean getPageBreakBefore()
```
    True if a page break is forced before the paragraph.
    
    Returns:
    
    The corresponding boolean value.
  - setPageBreakBefore
```
public void setPageBreakBefore(boolean value)
```
    True if a page break is forced before the paragraph.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSuppressLineNumbers
```
public boolean getSuppressLineNumbers()
```
    Specifies whether the current paragraph's lines should be exempted from line numbering which is applied in the parent section.
    
    Returns:
    
    The corresponding boolean value.
  - setSuppressLineNumbers
```
public void setSuppressLineNumbers(boolean value)
```
    Specifies whether the current paragraph's lines should be exempted from line numbering which is applied in the parent section.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSuppressAutoHyphens
```
public boolean getSuppressAutoHyphens()
```
    Specifies whether the current paragraph should be exempted from any hyphenation which is applied in the document settings.
    
    Returns:
    
    The corresponding boolean value.
  - setSuppressAutoHyphens
```
public void setSuppressAutoHyphens(boolean value)
```
    Specifies whether the current paragraph should be exempted from any hyphenation which is applied in the document settings.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getWidowControl
```
public boolean getWidowControl()
```
    True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
    
    Returns:
    
    The corresponding boolean value.
  - setWidowControl
```
public void setWidowControl(boolean value)
```
    True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getAddSpaceBetweenFarEastAndAlpha
```
public boolean getAddSpaceBetweenFarEastAndAlpha()
```
    Gets a flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
    
    Returns:
    
    A flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
  - setAddSpaceBetweenFarEastAndAlpha
```
public void setAddSpaceBetweenFarEastAndAlpha(boolean value)
```
    Sets a flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
    
    Parameters:
    
    value - A flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
  - getAddSpaceBetweenFarEastAndDigit
```
public boolean getAddSpaceBetweenFarEastAndDigit()
```
    Gets a flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
    
    Returns:
    
    A flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
  - setAddSpaceBetweenFarEastAndDigit
```
public void setAddSpaceBetweenFarEastAndDigit(boolean value)
```
    Sets a flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
    
    Parameters:
    
    value - A flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
  - getFarEastLineBreakControl
```
public boolean getFarEastLineBreakControl()
```
    Gets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
    
    Returns:
    
    A flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
  - setFarEastLineBreakControl
```
public void setFarEastLineBreakControl(boolean value)
```
    Sets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
    
    Parameters:
    
    value - A flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
  - getWordWrap
```
public boolean getWordWrap()
```
    If this property is false, Latin text in the middle of a word can be wrapped for the current paragraph. Otherwise Latin text is wrapped by whole words.
    
    Returns:
    
    The corresponding boolean value.
  - setWordWrap
```
public void setWordWrap(boolean value)
```
    If this property is false, Latin text in the middle of a word can be wrapped for the current paragraph. Otherwise Latin text is wrapped by whole words.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getHangingPunctuation
```
public boolean getHangingPunctuation()
```
    Gets a flag indicating whether hanging punctuation is enabled for the current paragraph.
    
    Returns:
    
    A flag indicating whether hanging punctuation is enabled for the current paragraph.
  - setHangingPunctuation
```
public void setHangingPunctuation(boolean value)
```
    Sets a flag indicating whether hanging punctuation is enabled for the current paragraph.
    
    Parameters:
    
    value - A flag indicating whether hanging punctuation is enabled for the current paragraph.
  - getBidi
```
public boolean getBidi()
```
    Gets whether this is a right-to-left paragraph.
    When true, the runs and other inline objects in this paragraph are laid out right to left.
    
    Returns:
    
    Whether this is a right-to-left paragraph.
  - setBidi
```
public void setBidi(boolean value)
```
    Sets whether this is a right-to-left paragraph.
    When true, the runs and other inline objects in this paragraph are laid out right to left.
    
    Parameters:
    
    value - Whether this is a right-to-left paragraph.
  - getLeftIndent
```
public double getLeftIndent()
```
    Gets the value (in points) that represents the left indent for paragraph.
    
    Returns:
    
    The value (in points) that represents the left indent for paragraph.
  - setLeftIndent
```
public void setLeftIndent(double value)
```
    Sets the value (in points) that represents the left indent for paragraph.
    
    Parameters:
    
    value - The value (in points) that represents the left indent for paragraph.
  - getCharacterUnitLeftIndent
```
public double getCharacterUnitLeftIndent()
```
    Gets the left indent value (in characters) for the specified paragraphs.
    
    Returns:
    
    The left indent value (in characters) for the specified paragraphs.
  - setCharacterUnitLeftIndent
```
public void setCharacterUnitLeftIndent(double value)
```
    Sets the left indent value (in characters) for the specified paragraphs.
    
    Parameters:
    
    value - The left indent value (in characters) for the specified paragraphs.
  - getRightIndent
```
public double getRightIndent()
```
    Gets the value (in points) that represents the right indent for paragraph.
    
    Returns:
    
    The value (in points) that represents the right indent for paragraph.
  - setRightIndent
```
public void setRightIndent(double value)
```
    Sets the value (in points) that represents the right indent for paragraph.
    
    Parameters:
    
    value - The value (in points) that represents the right indent for paragraph.
  - getCharacterUnitRightIndent
```
public double getCharacterUnitRightIndent()
```
    Gets the right indent value (in characters) for the specified paragraphs.
    
    Returns:
    
    The right indent value (in characters) for the specified paragraphs.
  - setCharacterUnitRightIndent
```
public void setCharacterUnitRightIndent(double value)
```
    Sets the right indent value (in characters) for the specified paragraphs.
    
    Parameters:
    
    value - The right indent value (in characters) for the specified paragraphs.
  - getFirstLineIndent
```
public double getFirstLineIndent()
```
    Gets the value (in points) for a first line or hanging indent.
    Use positive values to set the first-line indent, and negative values to set the hanging indent.
    
    Returns:
    
    The value (in points) for a first line or hanging indent.
  - setFirstLineIndent
```
public void setFirstLineIndent(double value)
```
    Sets the value (in points) for a first line or hanging indent.
    Use positive values to set the first-line indent, and negative values to set the hanging indent.
    
    Parameters:
    
    value - The value (in points) for a first line or hanging indent.
  - getCharacterUnitFirstLineIndent
```
public double getCharacterUnitFirstLineIndent()
```
    Gets the value (in characters) for the first-line or hanging indent.
    Use positive values to set the first-line indent, and negative values to set the hanging indent.
    
    Returns:
    
    The value (in characters) for the first-line or hanging indent.
  - setCharacterUnitFirstLineIndent
```
public void setCharacterUnitFirstLineIndent(double value)
```
    Sets the value (in characters) for the first-line or hanging indent.
    Use positive values to set the first-line indent, and negative values to set the hanging indent.
    
    Parameters:
    
    value - The value (in characters) for the first-line or hanging indent.
  - getSpaceBeforeAuto
```
public boolean getSpaceBeforeAuto()
```
    True if the amount of spacing before the paragraph is set automatically.
    When set to true, overrides the effect of getSpaceBefore() / setSpaceBefore(double).
    
    When you set paragraph Space Before and Space After to Auto, Microsoft Word adds 14 points spacing between paragraphs automatically according to the following rules:
    - Normally, spacing is added after all paragraphs.
    - In a bulleted or numbered list, spacing is added only after the last item in the list. Spacing is not added between the list items.
    - In a nested bulleted or numbered list spacing is not added.
    - Spacing is normally added after a table.
    - Spacing is not added after a table if it is the last block in a table cell.
    - Spacing is not added after the last paragraph in a table cell.
    Returns:
    
    The corresponding boolean value.
  - setSpaceBeforeAuto
```
public void setSpaceBeforeAuto(boolean value)
```
    True if the amount of spacing before the paragraph is set automatically.
    When set to true, overrides the effect of getSpaceBefore() / setSpaceBefore(double).
    
    When you set paragraph Space Before and Space After to Auto, Microsoft Word adds 14 points spacing between paragraphs automatically according to the following rules:
    - Normally, spacing is added after all paragraphs.
    - In a bulleted or numbered list, spacing is added only after the last item in the list. Spacing is not added between the list items.
    - In a nested bulleted or numbered list spacing is not added.
    - Spacing is normally added after a table.
    - Spacing is not added after a table if it is the last block in a table cell.
    - Spacing is not added after the last paragraph in a table cell.
    Parameters:
    
    value - The corresponding boolean value.
  - getSpaceAfterAuto
```
public boolean getSpaceAfterAuto()
```
    True if the amount of spacing after the paragraph is set automatically.
    When set to true, overrides the effect of getSpaceAfter() / setSpaceAfter(double).
    
    When you set paragraph Space Before and Space After to Auto, Microsoft Word adds 14 points spacing between paragraphs automatically according to the following rules:
    - Normally, spacing is added after all paragraphs.
    - In a bulleted or numbered list, spacing is added only after the last item in the list. Spacing is not added between the list items.
    - In a nested bulleted or numbered list spacing is not added.
    - Spacing is normally added after a table.
    - Spacing is not added after a table if it is the last block in a table cell.
    - Spacing is not added after the last paragraph in a table cell.
    Returns:
    
    The corresponding boolean value.
  - setSpaceAfterAuto
```
public void setSpaceAfterAuto(boolean value)
```
    True if the amount of spacing after the paragraph is set automatically.
    When set to true, overrides the effect of getSpaceAfter() / setSpaceAfter(double).
    
    When you set paragraph Space Before and Space After to Auto, Microsoft Word adds 14 points spacing between paragraphs automatically according to the following rules:
    - Normally, spacing is added after all paragraphs.
    - In a bulleted or numbered list, spacing is added only after the last item in the list. Spacing is not added between the list items.
    - In a nested bulleted or numbered list spacing is not added.
    - Spacing is normally added after a table.
    - Spacing is not added after a table if it is the last block in a table cell.
    - Spacing is not added after the last paragraph in a table cell.
    Parameters:
    
    value - The corresponding boolean value.
  - getSpaceBefore
```
public double getSpaceBefore()
```
    Gets the amount of spacing (in points) before the paragraph.
    Has no effect when getSpaceBeforeAuto() / setSpaceBeforeAuto(boolean) is true.
    
    Valid values range from 0 to 1584 inclusive.
    
    Returns:
    
    The amount of spacing (in points) before the paragraph.
    
    Throws:
    
    java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.
  - setSpaceBefore
```
public void setSpaceBefore(double value)
```
    Sets the amount of spacing (in points) before the paragraph.
    Has no effect when getSpaceBeforeAuto() / setSpaceBeforeAuto(boolean) is true.
    
    Valid values range from 0 to 1584 inclusive.
    
    Parameters:
    
    value - The amount of spacing (in points) before the paragraph.
    
    Throws:
    
    java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.
  - getLineUnitBefore
```
public double getLineUnitBefore()
```
    Gets the amount of spacing (in gridlines) before the paragraphs.
    
    Returns:
    
    The amount of spacing (in gridlines) before the paragraphs.
  - setLineUnitBefore
```
public void setLineUnitBefore(double value)
```
    Sets the amount of spacing (in gridlines) before the paragraphs.
    
    Parameters:
    
    value - The amount of spacing (in gridlines) before the paragraphs.
  - getSpaceAfter
```
public double getSpaceAfter()
```
    Gets the amount of spacing (in points) after the paragraph.
    Has no effect when getSpaceAfterAuto() / setSpaceAfterAuto(boolean) is true.
    
    Valid values range from 0 to 1584 inclusive.
    
    Returns:
    
    The amount of spacing (in points) after the paragraph.
    
    Throws:
    
    java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.
  - setSpaceAfter
```
public void setSpaceAfter(double value)
```
    Sets the amount of spacing (in points) after the paragraph.
    Has no effect when getSpaceAfterAuto() / setSpaceAfterAuto(boolean) is true.
    
    Valid values range from 0 to 1584 inclusive.
    
    Parameters:
    
    value - The amount of spacing (in points) after the paragraph.
    
    Throws:
    
    java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.
  - getLineUnitAfter
```
public double getLineUnitAfter()
```
    Gets the amount of spacing (in gridlines) after the paragraphs.
    
    Returns:
    
    The amount of spacing (in gridlines) after the paragraphs.
  - setLineUnitAfter
```
public void setLineUnitAfter(double value)
```
    Sets the amount of spacing (in gridlines) after the paragraphs.
    
    Parameters:
    
    value - The amount of spacing (in gridlines) after the paragraphs.
  - getLineSpacingRule
```
public int getLineSpacingRule()
```
    Gets the line spacing for the paragraph.
    
    Returns:
    
    The line spacing for the paragraph. The returned value is one of LineSpacingRule constants.
  - setLineSpacingRule
```
public void setLineSpacingRule(int value)
```
    Sets the line spacing for the paragraph.
    
    Parameters:
    
    value - The line spacing for the paragraph. The value must be one of LineSpacingRule constants.
  - getLineSpacing
```
public double getLineSpacing()
```
    Gets the line spacing (in points) for the paragraph.
    When LineSpacingRule property is set to AtLeast, the line spacing can be greater than or equal to, but never less than the specified LineSpacing value.
    
    When LineSpacingRule property is set to Exactly, the line spacing never changes from the specified LineSpacing value, even if a larger font is used within the paragraph.
    
    Returns:
    
    The line spacing (in points) for the paragraph.
  - setLineSpacing
```
public void setLineSpacing(double value)
```
    Sets the line spacing (in points) for the paragraph.
    When LineSpacingRule property is set to AtLeast, the line spacing can be greater than or equal to, but never less than the specified LineSpacing value.
    
    When LineSpacingRule property is set to Exactly, the line spacing never changes from the specified LineSpacing value, even if a larger font is used within the paragraph.
    
    Parameters:
    
    value - The line spacing (in points) for the paragraph.
  - isHeading
```
public boolean isHeading()
```
    True when the paragraph style is one of the built-in Heading styles.
    
    Returns:
    
    The corresponding boolean value.
  - isListItem
```
public boolean isListItem()
```
    True when the paragraph is an item in a bulleted or numbered list.
    
    Returns:
    
    The corresponding boolean value.
  - getOutlineLevel
```
public int getOutlineLevel()
```
    Specifies the outline level of the paragraph in the document.
    
    Returns:
    
    The corresponding int value. The returned value is one of OutlineLevel constants.
  - setOutlineLevel
```
public void setOutlineLevel(int value)
```
    Specifies the outline level of the paragraph in the document.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of OutlineLevel constants.
  - getLinesToDrop
```
public int getLinesToDrop()
```
    Gets the number of lines of the paragraph text used to calculate the drop cap height.
    
    Returns:
    
    The number of lines of the paragraph text used to calculate the drop cap height.
  - setLinesToDrop
```
public void setLinesToDrop(int value)
```
    Sets the number of lines of the paragraph text used to calculate the drop cap height.
    
    Parameters:
    
    value - The number of lines of the paragraph text used to calculate the drop cap height.
  - getDropCapPosition
```
public int getDropCapPosition()
```
    Gets the position for a drop cap text.
    
    Returns:
    
    The position for a drop cap text. The returned value is one of DropCapPosition constants.
  - setDropCapPosition
```
public void setDropCapPosition(int value)
```
    Sets the position for a drop cap text.
    
    Parameters:
    
    value - The position for a drop cap text. The value must be one of DropCapPosition constants.
  - getShading
```
public Shading getShading()
```
    Returns a Shading object that refers to the shading formatting for the paragraph.
    
    Returns:
    
    A Shading object that refers to the shading formatting for the paragraph.
  - getBorders
```
public BorderCollection getBorders()
```
    Gets collection of borders of the paragraph.
    
    Returns:
    
    Collection of borders of the paragraph.
  - getStyle
```
public Style getStyle()
```
    Gets the paragraph style applied to this formatting.
    
    Returns:
    
    The paragraph style applied to this formatting.
  - setStyle
```
public void setStyle(Style value)
```
    Sets the paragraph style applied to this formatting.
    
    Parameters:
    
    value - The paragraph style applied to this formatting.
  - getStyleName
```
public java.lang.String getStyleName()
```
    Gets the name of the paragraph style applied to this formatting.
    
    Returns:
    
    The name of the paragraph style applied to this formatting.
  - setStyleName
```
public void setStyleName(java.lang.String value)
```
    Sets the name of the paragraph style applied to this formatting.
    
    Parameters:
    
    value - The name of the paragraph style applied to this formatting.
  - getStyleIdentifier
```
public int getStyleIdentifier()
```
    Gets the locale independent style identifier of the paragraph style applied to this formatting.
    
    Returns:
    
    The locale independent style identifier of the paragraph style applied to this formatting. The returned value is one of StyleIdentifier constants.
  - setStyleIdentifier
```
public void setStyleIdentifier(int value)
```
    Sets the locale independent style identifier of the paragraph style applied to this formatting.
    
    Parameters:
    
    value - The locale independent style identifier of the paragraph style applied to this formatting. The value must be one of StyleIdentifier constants.
  - getSnapToGrid
```
public boolean getSnapToGrid()
```
    Specifies whether the current paragraph should use the document grid lines per page settings when laying out the contents in the paragraph.
    
    Returns:
    
    The corresponding boolean value.
  - setSnapToGrid
```
public void setSnapToGrid(boolean value)
```
    Specifies whether the current paragraph should use the document grid lines per page settings when laying out the contents in the paragraph.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getTabStops
```
public TabStopCollection getTabStops()
```
    Gets the collection of custom tab stops defined for this object.
    
    Returns:
    
    The collection of custom tab stops defined for this object.
  - getDirectBorderAttr
```
public java.lang.Object getDirectBorderAttr(int key)
```
  - fetchInheritedBorderAttr
```
public java.lang.Object fetchInheritedBorderAttr(int key)
```
  - setBorderAttr
```
public void setBorderAttr(int key,
                          java.lang.Object value)
```
  - fetchInheritedShadingAttr
```
public java.lang.Object fetchInheritedShadingAttr(int key)
```

Class ParagraphFormat

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clearFormatting

getAlignment

setAlignment

getNoSpaceBetweenParagraphsOfSameStyle

setNoSpaceBetweenParagraphsOfSameStyle

getKeepTogether

setKeepTogether

getKeepWithNext

setKeepWithNext

getPageBreakBefore

setPageBreakBefore

getSuppressLineNumbers

setSuppressLineNumbers

getSuppressAutoHyphens

setSuppressAutoHyphens

getWidowControl

setWidowControl

getAddSpaceBetweenFarEastAndAlpha

setAddSpaceBetweenFarEastAndAlpha

getAddSpaceBetweenFarEastAndDigit

setAddSpaceBetweenFarEastAndDigit

getFarEastLineBreakControl

setFarEastLineBreakControl

getWordWrap

setWordWrap

getHangingPunctuation

setHangingPunctuation

getBidi

setBidi

getLeftIndent

setLeftIndent

getCharacterUnitLeftIndent

setCharacterUnitLeftIndent

getRightIndent

setRightIndent

getCharacterUnitRightIndent

setCharacterUnitRightIndent

getFirstLineIndent

setFirstLineIndent

getCharacterUnitFirstLineIndent

setCharacterUnitFirstLineIndent

getSpaceBeforeAuto

setSpaceBeforeAuto

getSpaceAfterAuto

setSpaceAfterAuto

getSpaceBefore

setSpaceBefore

getLineUnitBefore

setLineUnitBefore

getSpaceAfter

setSpaceAfter

getLineUnitAfter

setLineUnitAfter

getLineSpacingRule

setLineSpacingRule

getLineSpacing

setLineSpacing

isHeading

isListItem

getOutlineLevel

setOutlineLevel

getLinesToDrop

setLinesToDrop

getDropCapPosition

setDropCapPosition

getShading

getBorders

getStyle

setStyle

getStyleName

setStyleName

getStyleIdentifier

setStyleIdentifier

getSnapToGrid

setSnapToGrid

getTabStops