SectionStyle (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.SectionStyle

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class SectionStyle
extends com.google.api.client.json.GenericJson
```
The styling that applies to a section.
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

SectionStyle()

Constructors
Constructor and Description
`SectionStyle()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SectionStyle`	`clone()`
`List<SectionColumnProperties>`	`getColumnProperties()` The section's columns properties.
`String`	`getColumnSeparatorStyle()` The style of column separators.
`String`	`getContentDirection()` The content direction of this section.
`String`	`getDefaultFooterId()` The ID of the default footer.
`String`	`getDefaultHeaderId()` The ID of the default header.
`String`	`getEvenPageFooterId()` The ID of the footer used only for even pages.
`String`	`getEvenPageHeaderId()` The ID of the header used only for even pages.
`String`	`getFirstPageFooterId()` The ID of the footer used only for the first page of the section.
`String`	`getFirstPageHeaderId()` The ID of the header used only for the first page of the section.
`Boolean`	`getFlipPageOrientation()` Optional.
`Dimension`	`getMarginBottom()` The bottom page margin of the section.
`Dimension`	`getMarginFooter()` The footer margin of the section.
`Dimension`	`getMarginHeader()` The header margin of the section.
`Dimension`	`getMarginLeft()` The left page margin of the section.
`Dimension`	`getMarginRight()` The right page margin of the section.
`Dimension`	`getMarginTop()` The top page margin of the section.
`Integer`	`getPageNumberStart()` The page number from which to start counting the number of pages for this section.
`String`	`getSectionType()` Output only.
`Boolean`	`getUseFirstPageHeaderFooter()` Indicates whether to use the first page header / footer IDs for the first page of the section.
`SectionStyle`	`set(String fieldName, Object value)`
`SectionStyle`	`setColumnProperties(List<SectionColumnProperties> columnProperties)` The section's columns properties.
`SectionStyle`	`setColumnSeparatorStyle(String columnSeparatorStyle)` The style of column separators.
`SectionStyle`	`setContentDirection(String contentDirection)` The content direction of this section.
`SectionStyle`	`setDefaultFooterId(String defaultFooterId)` The ID of the default footer.
`SectionStyle`	`setDefaultHeaderId(String defaultHeaderId)` The ID of the default header.
`SectionStyle`	`setEvenPageFooterId(String evenPageFooterId)` The ID of the footer used only for even pages.
`SectionStyle`	`setEvenPageHeaderId(String evenPageHeaderId)` The ID of the header used only for even pages.
`SectionStyle`	`setFirstPageFooterId(String firstPageFooterId)` The ID of the footer used only for the first page of the section.
`SectionStyle`	`setFirstPageHeaderId(String firstPageHeaderId)` The ID of the header used only for the first page of the section.
`SectionStyle`	`setFlipPageOrientation(Boolean flipPageOrientation)` Optional.
`SectionStyle`	`setMarginBottom(Dimension marginBottom)` The bottom page margin of the section.
`SectionStyle`	`setMarginFooter(Dimension marginFooter)` The footer margin of the section.
`SectionStyle`	`setMarginHeader(Dimension marginHeader)` The header margin of the section.
`SectionStyle`	`setMarginLeft(Dimension marginLeft)` The left page margin of the section.
`SectionStyle`	`setMarginRight(Dimension marginRight)` The right page margin of the section.
`SectionStyle`	`setMarginTop(Dimension marginTop)` The top page margin of the section.
`SectionStyle`	`setPageNumberStart(Integer pageNumberStart)` The page number from which to start counting the number of pages for this section.
`SectionStyle`	`setSectionType(String sectionType)` Output only.
`SectionStyle`	`setUseFirstPageHeaderFooter(Boolean useFirstPageHeaderFooter)` Indicates whether to use the first page header / footer IDs for the first page of the section.

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
  - SectionStyle
```
public SectionStyle()
```
- Method Detail
  - getColumnProperties
```
public List<SectionColumnProperties> getColumnProperties()
```
    The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setColumnProperties
```
public SectionStyle setColumnProperties(List<SectionColumnProperties> columnProperties)
```
    The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
    
    Parameters:
    
    columnProperties - columnProperties or null for none
  - getColumnSeparatorStyle
```
public String getColumnSeparatorStyle()
```
    The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setColumnSeparatorStyle
```
public SectionStyle setColumnSeparatorStyle(String columnSeparatorStyle)
```
    The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    columnSeparatorStyle - columnSeparatorStyle or null for none
  - getContentDirection
```
public String getContentDirection()
```
    The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setContentDirection
```
public SectionStyle setContentDirection(String contentDirection)
```
    The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    contentDirection - contentDirection or null for none
  - getDefaultFooterId
```
public String getDefaultFooterId()
```
    The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setDefaultFooterId
```
public SectionStyle setDefaultFooterId(String defaultFooterId)
```
    The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    defaultFooterId - defaultFooterId or null for none
  - getDefaultHeaderId
```
public String getDefaultHeaderId()
```
    The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setDefaultHeaderId
```
public SectionStyle setDefaultHeaderId(String defaultHeaderId)
```
    The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    defaultHeaderId - defaultHeaderId or null for none
  - getEvenPageFooterId
```
public String getEvenPageFooterId()
```
    The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setEvenPageFooterId
```
public SectionStyle setEvenPageFooterId(String evenPageFooterId)
```
    The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    evenPageFooterId - evenPageFooterId or null for none
  - getEvenPageHeaderId
```
public String getEvenPageHeaderId()
```
    The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setEvenPageHeaderId
```
public SectionStyle setEvenPageHeaderId(String evenPageHeaderId)
```
    The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    evenPageHeaderId - evenPageHeaderId or null for none
  - getFirstPageFooterId
```
public String getFirstPageFooterId()
```
    The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setFirstPageFooterId
```
public SectionStyle setFirstPageFooterId(String firstPageFooterId)
```
    The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    firstPageFooterId - firstPageFooterId or null for none
  - getFirstPageHeaderId
```
public String getFirstPageHeaderId()
```
    The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setFirstPageHeaderId
```
public SectionStyle setFirstPageHeaderId(String firstPageHeaderId)
```
    The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    firstPageHeaderId - firstPageHeaderId or null for none
  - getFlipPageOrientation
```
public Boolean getFlipPageOrientation()
```
    Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setFlipPageOrientation
```
public SectionStyle setFlipPageOrientation(Boolean flipPageOrientation)
```
    Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    flipPageOrientation - flipPageOrientation or null for none
  - getMarginBottom
```
public Dimension getMarginBottom()
```
    The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setMarginBottom
```
public SectionStyle setMarginBottom(Dimension marginBottom)
```
    The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    marginBottom - marginBottom or null for none
  - getMarginFooter
```
public Dimension getMarginFooter()
```
    The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setMarginFooter
```
public SectionStyle setMarginFooter(Dimension marginFooter)
```
    The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    marginFooter - marginFooter or null for none
  - getMarginHeader
```
public Dimension getMarginHeader()
```
    The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setMarginHeader
```
public SectionStyle setMarginHeader(Dimension marginHeader)
```
    The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    marginHeader - marginHeader or null for none
  - getMarginLeft
```
public Dimension getMarginLeft()
```
    The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setMarginLeft
```
public SectionStyle setMarginLeft(Dimension marginLeft)
```
    The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    marginLeft - marginLeft or null for none
  - getMarginRight
```
public Dimension getMarginRight()
```
    The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setMarginRight
```
public SectionStyle setMarginRight(Dimension marginRight)
```
    The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    marginRight - marginRight or null for none
  - getMarginTop
```
public Dimension getMarginTop()
```
    The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setMarginTop
```
public SectionStyle setMarginTop(Dimension marginTop)
```
    The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    marginTop - marginTop or null for none
  - getPageNumberStart
```
public Integer getPageNumberStart()
```
    The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setPageNumberStart
```
public SectionStyle setPageNumberStart(Integer pageNumberStart)
```
    The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    pageNumberStart - pageNumberStart or null for none
  - getSectionType
```
public String getSectionType()
```
    Output only. The type of section.
    
    Returns:
    
    value or null for none
  - setSectionType
```
public SectionStyle setSectionType(String sectionType)
```
    Output only. The type of section.
    
    Parameters:
    
    sectionType - sectionType or null for none
  - getUseFirstPageHeaderFooter
```
public Boolean getUseFirstPageHeaderFooter()
```
    Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Returns:
    
    value or null for none
  - setUseFirstPageHeaderFooter
```
public SectionStyle setUseFirstPageHeaderFooter(Boolean useFirstPageHeaderFooter)
```
    Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
    
    Parameters:
    
    useFirstPageHeaderFooter - useFirstPageHeaderFooter or null for none
  - set
```
public SectionStyle set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public SectionStyle clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class SectionStyle

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

SectionStyle

Method Detail

getColumnProperties

setColumnProperties

getColumnSeparatorStyle

setColumnSeparatorStyle

getContentDirection

setContentDirection

getDefaultFooterId

setDefaultFooterId

getDefaultHeaderId

setDefaultHeaderId

getEvenPageFooterId

setEvenPageFooterId

getEvenPageHeaderId

setEvenPageHeaderId

getFirstPageFooterId

setFirstPageFooterId

getFirstPageHeaderId

setFirstPageHeaderId

getFlipPageOrientation

setFlipPageOrientation

getMarginBottom

setMarginBottom

getMarginFooter

setMarginFooter

getMarginHeader

setMarginHeader

getMarginLeft

setMarginLeft

getMarginRight

setMarginRight

getMarginTop

setMarginTop

getPageNumberStart

setPageNumberStart

getSectionType

setSectionType

getUseFirstPageHeaderFooter

setUseFirstPageHeaderFooter

set

clone