ParagraphStyle (Google Docs API v1-rev20251110-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.docs.v1.model.ParagraphStyle

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class ParagraphStyle
extends com.google.api.client.json.GenericJson
```
Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Docs API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ParagraphStyle()

Constructors
Constructor and Description
`ParagraphStyle()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParagraphStyle`	`clone()`
`String`	`getAlignment()` The text alignment for this paragraph.
`Boolean`	`getAvoidWidowAndOrphan()` Whether to avoid widows and orphans for the paragraph.
`ParagraphBorder`	`getBorderBetween()` The border between this paragraph and the next and previous paragraphs.
`ParagraphBorder`	`getBorderBottom()` The border at the bottom of this paragraph.
`ParagraphBorder`	`getBorderLeft()` The border to the left of this paragraph.
`ParagraphBorder`	`getBorderRight()` The border to the right of this paragraph.
`ParagraphBorder`	`getBorderTop()` The border at the top of this paragraph.
`String`	`getDirection()` The text direction of this paragraph.
`String`	`getHeadingId()` The heading ID of the paragraph.
`Dimension`	`getIndentEnd()` The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction.
`Dimension`	`getIndentFirstLine()` The amount of indentation for the first line of the paragraph.
`Dimension`	`getIndentStart()` The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction.
`Boolean`	`getKeepLinesTogether()` Whether all lines of the paragraph should be laid out on the same page or column if possible.
`Boolean`	`getKeepWithNext()` Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible.
`Float`	`getLineSpacing()` The amount of space between lines, as a percentage of normal, where normal is represented as 100.0.
`String`	`getNamedStyleType()` The named style type of the paragraph.
`Boolean`	`getPageBreakBefore()` Whether the current paragraph should always start at the beginning of a page.
`Shading`	`getShading()` The shading of the paragraph.
`Dimension`	`getSpaceAbove()` The amount of extra space above the paragraph.
`Dimension`	`getSpaceBelow()` The amount of extra space below the paragraph.
`String`	`getSpacingMode()` The spacing mode for the paragraph.
`List<TabStop>`	`getTabStops()` A list of the tab stops for this paragraph.
`ParagraphStyle`	`set(String fieldName, Object value)`
`ParagraphStyle`	`setAlignment(String alignment)` The text alignment for this paragraph.
`ParagraphStyle`	`setAvoidWidowAndOrphan(Boolean avoidWidowAndOrphan)` Whether to avoid widows and orphans for the paragraph.
`ParagraphStyle`	`setBorderBetween(ParagraphBorder borderBetween)` The border between this paragraph and the next and previous paragraphs.
`ParagraphStyle`	`setBorderBottom(ParagraphBorder borderBottom)` The border at the bottom of this paragraph.
`ParagraphStyle`	`setBorderLeft(ParagraphBorder borderLeft)` The border to the left of this paragraph.
`ParagraphStyle`	`setBorderRight(ParagraphBorder borderRight)` The border to the right of this paragraph.
`ParagraphStyle`	`setBorderTop(ParagraphBorder borderTop)` The border at the top of this paragraph.
`ParagraphStyle`	`setDirection(String direction)` The text direction of this paragraph.
`ParagraphStyle`	`setHeadingId(String headingId)` The heading ID of the paragraph.
`ParagraphStyle`	`setIndentEnd(Dimension indentEnd)` The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction.
`ParagraphStyle`	`setIndentFirstLine(Dimension indentFirstLine)` The amount of indentation for the first line of the paragraph.
`ParagraphStyle`	`setIndentStart(Dimension indentStart)` The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction.
`ParagraphStyle`	`setKeepLinesTogether(Boolean keepLinesTogether)` Whether all lines of the paragraph should be laid out on the same page or column if possible.
`ParagraphStyle`	`setKeepWithNext(Boolean keepWithNext)` Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible.
`ParagraphStyle`	`setLineSpacing(Float lineSpacing)` The amount of space between lines, as a percentage of normal, where normal is represented as 100.0.
`ParagraphStyle`	`setNamedStyleType(String namedStyleType)` The named style type of the paragraph.
`ParagraphStyle`	`setPageBreakBefore(Boolean pageBreakBefore)` Whether the current paragraph should always start at the beginning of a page.
`ParagraphStyle`	`setShading(Shading shading)` The shading of the paragraph.
`ParagraphStyle`	`setSpaceAbove(Dimension spaceAbove)` The amount of extra space above the paragraph.
`ParagraphStyle`	`setSpaceBelow(Dimension spaceBelow)` The amount of extra space below the paragraph.
`ParagraphStyle`	`setSpacingMode(String spacingMode)` The spacing mode for the paragraph.
`ParagraphStyle`	`setTabStops(List<TabStop> tabStops)` A list of the tab stops for this paragraph.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ParagraphStyle
```
public ParagraphStyle()
```
- Method Detail
  - getAlignment
```
public String getAlignment()
```
    The text alignment for this paragraph.
    
    Returns:
    
    value or null for none
  - setAlignment
```
public ParagraphStyle setAlignment(String alignment)
```
    The text alignment for this paragraph.
    
    Parameters:
    
    alignment - alignment or null for none
  - getAvoidWidowAndOrphan
```
public Boolean getAvoidWidowAndOrphan()
```
    Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setAvoidWidowAndOrphan
```
public ParagraphStyle setAvoidWidowAndOrphan(Boolean avoidWidowAndOrphan)
```
    Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
    
    Parameters:
    
    avoidWidowAndOrphan - avoidWidowAndOrphan or null for none
  - getBorderBetween
```
public ParagraphBorder getBorderBetween()
```
    The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Returns:
    
    value or null for none
  - setBorderBetween
```
public ParagraphStyle setBorderBetween(ParagraphBorder borderBetween)
```
    The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Parameters:
    
    borderBetween - borderBetween or null for none
  - getBorderBottom
```
public ParagraphBorder getBorderBottom()
```
    The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Returns:
    
    value or null for none
  - setBorderBottom
```
public ParagraphStyle setBorderBottom(ParagraphBorder borderBottom)
```
    The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Parameters:
    
    borderBottom - borderBottom or null for none
  - getBorderLeft
```
public ParagraphBorder getBorderLeft()
```
    The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Returns:
    
    value or null for none
  - setBorderLeft
```
public ParagraphStyle setBorderLeft(ParagraphBorder borderLeft)
```
    The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Parameters:
    
    borderLeft - borderLeft or null for none
  - getBorderRight
```
public ParagraphBorder getBorderRight()
```
    The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Returns:
    
    value or null for none
  - setBorderRight
```
public ParagraphStyle setBorderRight(ParagraphBorder borderRight)
```
    The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Parameters:
    
    borderRight - borderRight or null for none
  - getBorderTop
```
public ParagraphBorder getBorderTop()
```
    The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Returns:
    
    value or null for none
  - setBorderTop
```
public ParagraphStyle setBorderTop(ParagraphBorder borderTop)
```
    The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
    
    Parameters:
    
    borderTop - borderTop or null for none
  - getDirection
```
public String getDirection()
```
    The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
    
    Returns:
    
    value or null for none
  - setDirection
```
public ParagraphStyle setDirection(String direction)
```
    The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
    
    Parameters:
    
    direction - direction or null for none
  - getHeadingId
```
public String getHeadingId()
```
    The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
    
    Returns:
    
    value or null for none
  - setHeadingId
```
public ParagraphStyle setHeadingId(String headingId)
```
    The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
    
    Parameters:
    
    headingId - headingId or null for none
  - getIndentEnd
```
public Dimension getIndentEnd()
```
    The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setIndentEnd
```
public ParagraphStyle setIndentEnd(Dimension indentEnd)
```
    The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
    
    Parameters:
    
    indentEnd - indentEnd or null for none
  - getIndentFirstLine
```
public Dimension getIndentFirstLine()
```
    The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setIndentFirstLine
```
public ParagraphStyle setIndentFirstLine(Dimension indentFirstLine)
```
    The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
    
    Parameters:
    
    indentFirstLine - indentFirstLine or null for none
  - getIndentStart
```
public Dimension getIndentStart()
```
    The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setIndentStart
```
public ParagraphStyle setIndentStart(Dimension indentStart)
```
    The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
    
    Parameters:
    
    indentStart - indentStart or null for none
  - getKeepLinesTogether
```
public Boolean getKeepLinesTogether()
```
    Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setKeepLinesTogether
```
public ParagraphStyle setKeepLinesTogether(Boolean keepLinesTogether)
```
    Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
    
    Parameters:
    
    keepLinesTogether - keepLinesTogether or null for none
  - getKeepWithNext
```
public Boolean getKeepWithNext()
```
    Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setKeepWithNext
```
public ParagraphStyle setKeepWithNext(Boolean keepWithNext)
```
    Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
    
    Parameters:
    
    keepWithNext - keepWithNext or null for none
  - getLineSpacing
```
public Float getLineSpacing()
```
    The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setLineSpacing
```
public ParagraphStyle setLineSpacing(Float lineSpacing)
```
    The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
    
    Parameters:
    
    lineSpacing - lineSpacing or null for none
  - getNamedStyleType
```
public String getNamedStyleType()
```
    The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
    
    Returns:
    
    value or null for none
  - setNamedStyleType
```
public ParagraphStyle setNamedStyleType(String namedStyleType)
```
    The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
    
    Parameters:
    
    namedStyleType - namedStyleType or null for none
  - getPageBreakBefore
```
public Boolean getPageBreakBefore()
```
    Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setPageBreakBefore
```
public ParagraphStyle setPageBreakBefore(Boolean pageBreakBefore)
```
    Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
    
    Parameters:
    
    pageBreakBefore - pageBreakBefore or null for none
  - getShading
```
public Shading getShading()
```
    The shading of the paragraph. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setShading
```
public ParagraphStyle setShading(Shading shading)
```
    The shading of the paragraph. If unset, the value is inherited from the parent.
    
    Parameters:
    
    shading - shading or null for none
  - getSpaceAbove
```
public Dimension getSpaceAbove()
```
    The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setSpaceAbove
```
public ParagraphStyle setSpaceAbove(Dimension spaceAbove)
```
    The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
    
    Parameters:
    
    spaceAbove - spaceAbove or null for none
  - getSpaceBelow
```
public Dimension getSpaceBelow()
```
    The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
    
    Returns:
    
    value or null for none
  - setSpaceBelow
```
public ParagraphStyle setSpaceBelow(Dimension spaceBelow)
```
    The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
    
    Parameters:
    
    spaceBelow - spaceBelow or null for none
  - getSpacingMode
```
public String getSpacingMode()
```
    The spacing mode for the paragraph.
    
    Returns:
    
    value or null for none
  - setSpacingMode
```
public ParagraphStyle setSpacingMode(String spacingMode)
```
    The spacing mode for the paragraph.
    
    Parameters:
    
    spacingMode - spacingMode or null for none
  - getTabStops
```
public List<TabStop> getTabStops()
```
    A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
    
    Returns:
    
    value or null for none
  - setTabStops
```
public ParagraphStyle setTabStops(List<TabStop> tabStops)
```
    A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
    
    Parameters:
    
    tabStops - tabStops or null for none
  - set
```
public ParagraphStyle set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ParagraphStyle clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class ParagraphStyle

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ParagraphStyle

Method Detail

getAlignment

setAlignment

getAvoidWidowAndOrphan

setAvoidWidowAndOrphan

getBorderBetween

setBorderBetween

getBorderBottom

setBorderBottom

getBorderLeft

setBorderLeft

getBorderRight

setBorderRight

getBorderTop

setBorderTop

getDirection

setDirection

getHeadingId

setHeadingId

getIndentEnd

setIndentEnd

getIndentFirstLine

setIndentFirstLine

getIndentStart

setIndentStart

getKeepLinesTogether

setKeepLinesTogether

getKeepWithNext

setKeepWithNext

getLineSpacing

setLineSpacing

getNamedStyleType

setNamedStyleType

getPageBreakBefore

setPageBreakBefore

getShading

setShading

getSpaceAbove

setSpaceAbove

getSpaceBelow

setSpaceBelow

getSpacingMode

setSpacingMode

getTabStops

setTabStops

set

clone