The styles of text that apply to entire paragraphs.
Read methods in this class return null if the corresponding TextRange spans
multiple paragraphs, and those paragraphs have different values for the read method being called.
To avoid this, query for paragraph styles using the TextRange returned by the Paragraph.getRange() method.
Methods
| Method | Return type | Brief description |
|---|---|---|
getIndentEnd() | Number | Returns the text end indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text. |
getIndentFirstLine() | Number | Returns the indentation for the first line of paragraphs in the TextRange in points, or
null if there are multiple paragraph styles on the given text. |
getIndentStart() | Number | Returns the text start indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text. |
getLineSpacing() | Number | Returns the line spacing, or null if there are multiple paragraph styles on the given
text. |
getParagraphAlignment() | ParagraphAlignment | Returns the ParagraphAlignment of paragraphs in the TextRange, or null
if there are multiple paragraph styles on the given text. |
getSpaceAbove() | Number | Returns the extra space above paragraphs in the TextRange in points, or null if
there are multiple paragraph styles on the given text. |
getSpaceBelow() | Number | Returns the extra space below paragraphs in the TextRange in points, or null if
there are multiple paragraph styles on the given text. |
getSpacingMode() | SpacingMode | Returns the SpacingMode for paragraphs in the TextRange, or null if
there are multiple paragraph styles on the given text. |
getTextDirection() | TextDirection | Returns the TextDirection for paragraphs in the TextRange, or null if
there are multiple paragraph styles on the given text. |
setIndentEnd(indent) | ParagraphStyle | Sets the text end indentation for paragraphs in the TextRange in points. |
setIndentFirstLine(indent) | ParagraphStyle | Sets the indentation for the first line of paragraphs in the TextRange in points. |
setIndentStart(indent) | ParagraphStyle | Sets the text start indentation for paragraphs in the TextRange in points. |
setLineSpacing(spacing) | ParagraphStyle | Sets the line spacing. |
setParagraphAlignment(alignment) | ParagraphStyle | Sets the ParagraphAlignment of paragraphs in the TextRange. |
setSpaceAbove(space) | ParagraphStyle | Sets the extra space above paragraphs in the TextRange in points. |
setSpaceBelow(space) | ParagraphStyle | Sets the extra space below paragraphs in the TextRange in points. |
setSpacingMode(mode) | ParagraphStyle | Sets the SpacingMode for paragraphs in the TextRange. |
setTextDirection(direction) | ParagraphStyle | Sets the TextDirection for paragraphs in the TextRange. |
Detailed documentation
getIndentEnd()
Returns the text end indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
The side that corresponds to the end of the text is based on the current text direction.
Return
Number
getIndentFirstLine()
Returns the indentation for the first line of paragraphs in the TextRange in points, or
null if there are multiple paragraph styles on the given text.
Return
Number
getIndentStart()
Returns the text start indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
The side that corresponds to the start of the text is based on the current text direction.
Return
Number
getLineSpacing()
Returns the line spacing, or null if there are multiple paragraph styles on the given
text.
This is a value that corresponds to the space between lines, as a percentage of normal. Normal is represented as 100.0.
Return
Number
getParagraphAlignment()
Returns the ParagraphAlignment of paragraphs in the TextRange, or null
if there are multiple paragraph styles on the given text.
Return
getSpaceAbove()
Returns the extra space above paragraphs in the TextRange in points, or null if
there are multiple paragraph styles on the given text.
Return
Number
getSpaceBelow()
Returns the extra space below paragraphs in the TextRange in points, or null if
there are multiple paragraph styles on the given text.
Return
Number
getSpacingMode()
Returns the SpacingMode for paragraphs in the TextRange, or null if
there are multiple paragraph styles on the given text.
Return
getTextDirection()
Returns the TextDirection for paragraphs in the TextRange, or null if
there are multiple paragraph styles on the given text.
Return
setIndentEnd(indent)
Sets the text end indentation for paragraphs in the TextRange in points.
The side that corresponds to the end of the text is based on the current text direction.
Parameters
| Name | Type | Description |
|---|---|---|
indent | Number |
Return
setIndentFirstLine(indent)
Sets the indentation for the first line of paragraphs in the TextRange in points.
Parameters
| Name | Type | Description |
|---|---|---|
indent | Number |
Return
setIndentStart(indent)
Sets the text start indentation for paragraphs in the TextRange in points.
The side that corresponds to the start of the text is based on the current text direction.
Parameters
| Name | Type | Description |
|---|---|---|
indent | Number |
Return
setLineSpacing(spacing)
Sets the line spacing.
This is a value that corresponds to the space between lines, as a percentage of normal. Normal is represented as 100.0.
Parameters
| Name | Type | Description |
|---|---|---|
spacing | Number |
Return
setParagraphAlignment(alignment)
Sets the ParagraphAlignment of paragraphs in the TextRange.
Parameters
| Name | Type | Description |
|---|---|---|
alignment | ParagraphAlignment |
Return
setSpaceAbove(space)
Sets the extra space above paragraphs in the TextRange in points.
Parameters
| Name | Type | Description |
|---|---|---|
space | Number |
Return
setSpaceBelow(space)
Sets the extra space below paragraphs in the TextRange in points.
Parameters
| Name | Type | Description |
|---|---|---|
space | Number |
Return
setSpacingMode(mode)
Sets the SpacingMode for paragraphs in the TextRange.
Parameters
| Name | Type | Description |
|---|---|---|
mode | SpacingMode |
Return
setTextDirection(direction)
Sets the TextDirection for paragraphs in the TextRange.
Parameters
| Name | Type | Description |
|---|---|---|
direction | TextDirection |
Need help? Visit our