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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class DocumentStyle
extends com.google.api.client.json.GenericJson
```
The style of the document.
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

DocumentStyle()

Constructors
Constructor and Description
`DocumentStyle()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentStyle`	`clone()`
`Background`	`getBackground()` The background of the document.
`String`	`getDefaultFooterId()` The ID of the default footer.
`String`	`getDefaultHeaderId()` The ID of the default header.
`DocumentFormat`	`getDocumentFormat()` Specifies document-level format settings, such as the document mode (pages vs pageless).
`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.
`String`	`getFirstPageHeaderId()` The ID of the header used only for the first page.
`Boolean`	`getFlipPageOrientation()` Optional.
`Dimension`	`getMarginBottom()` The bottom page margin.
`Dimension`	`getMarginFooter()` The amount of space between the bottom of the page and the contents of the footer.
`Dimension`	`getMarginHeader()` The amount of space between the top of the page and the contents of the header.
`Dimension`	`getMarginLeft()` The left page margin.
`Dimension`	`getMarginRight()` The right page margin.
`Dimension`	`getMarginTop()` The top page margin.
`Integer`	`getPageNumberStart()` The page number from which to start counting the number of pages.
`Size`	`getPageSize()` The size of a page in the document.
`Boolean`	`getUseCustomHeaderFooterMargins()` Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected.
`Boolean`	`getUseEvenPageHeaderFooter()` Indicates whether to use the even page header / footer IDs for the even pages.
`Boolean`	`getUseFirstPageHeaderFooter()` Indicates whether to use the first page header / footer IDs for the first page.
`DocumentStyle`	`set(String fieldName, Object value)`
`DocumentStyle`	`setBackground(Background background)` The background of the document.
`DocumentStyle`	`setDefaultFooterId(String defaultFooterId)` The ID of the default footer.
`DocumentStyle`	`setDefaultHeaderId(String defaultHeaderId)` The ID of the default header.
`DocumentStyle`	`setDocumentFormat(DocumentFormat documentFormat)` Specifies document-level format settings, such as the document mode (pages vs pageless).
`DocumentStyle`	`setEvenPageFooterId(String evenPageFooterId)` The ID of the footer used only for even pages.
`DocumentStyle`	`setEvenPageHeaderId(String evenPageHeaderId)` The ID of the header used only for even pages.
`DocumentStyle`	`setFirstPageFooterId(String firstPageFooterId)` The ID of the footer used only for the first page.
`DocumentStyle`	`setFirstPageHeaderId(String firstPageHeaderId)` The ID of the header used only for the first page.
`DocumentStyle`	`setFlipPageOrientation(Boolean flipPageOrientation)` Optional.
`DocumentStyle`	`setMarginBottom(Dimension marginBottom)` The bottom page margin.
`DocumentStyle`	`setMarginFooter(Dimension marginFooter)` The amount of space between the bottom of the page and the contents of the footer.
`DocumentStyle`	`setMarginHeader(Dimension marginHeader)` The amount of space between the top of the page and the contents of the header.
`DocumentStyle`	`setMarginLeft(Dimension marginLeft)` The left page margin.
`DocumentStyle`	`setMarginRight(Dimension marginRight)` The right page margin.
`DocumentStyle`	`setMarginTop(Dimension marginTop)` The top page margin.
`DocumentStyle`	`setPageNumberStart(Integer pageNumberStart)` The page number from which to start counting the number of pages.
`DocumentStyle`	`setPageSize(Size pageSize)` The size of a page in the document.
`DocumentStyle`	`setUseCustomHeaderFooterMargins(Boolean useCustomHeaderFooterMargins)` Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected.
`DocumentStyle`	`setUseEvenPageHeaderFooter(Boolean useEvenPageHeaderFooter)` Indicates whether to use the even page header / footer IDs for the even pages.
`DocumentStyle`	`setUseFirstPageHeaderFooter(Boolean useFirstPageHeaderFooter)` Indicates whether to use the first page header / footer IDs for the first page.

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
  - DocumentStyle
```
public DocumentStyle()
```
- Method Detail
  - getBackground
```
public Background getBackground()
```
    The background of the document. Documents cannot have a transparent background color.
    
    Returns:
    
    value or null for none
  - setBackground
```
public DocumentStyle setBackground(Background background)
```
    The background of the document. Documents cannot have a transparent background color.
    
    Parameters:
    
    background - background or null for none
  - getDefaultFooterId
```
public String getDefaultFooterId()
```
    The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setDefaultFooterId
```
public DocumentStyle setDefaultFooterId(String defaultFooterId)
```
    The ID of the default footer. If not set, there's no default footer. 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 not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setDefaultHeaderId
```
public DocumentStyle setDefaultHeaderId(String defaultHeaderId)
```
    The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    defaultHeaderId - defaultHeaderId or null for none
  - getDocumentFormat
```
public DocumentFormat getDocumentFormat()
```
    Specifies document-level format settings, such as the document mode (pages vs pageless).
    
    Returns:
    
    value or null for none
  - setDocumentFormat
```
public DocumentStyle setDocumentFormat(DocumentFormat documentFormat)
```
    Specifies document-level format settings, such as the document mode (pages vs pageless).
    
    Parameters:
    
    documentFormat - documentFormat or null for none
  - getEvenPageFooterId
```
public String getEvenPageFooterId()
```
    The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setEvenPageFooterId
```
public DocumentStyle setEvenPageFooterId(String evenPageFooterId)
```
    The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. 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. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setEvenPageHeaderId
```
public DocumentStyle setEvenPageHeaderId(String evenPageHeaderId)
```
    The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. 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. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setFirstPageFooterId
```
public DocumentStyle setFirstPageFooterId(String firstPageFooterId)
```
    The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. 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. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setFirstPageHeaderId
```
public DocumentStyle setFirstPageHeaderId(String firstPageHeaderId)
```
    The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. 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 the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setFlipPageOrientation
```
public DocumentStyle setFlipPageOrientation(Boolean flipPageOrientation)
```
    Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    flipPageOrientation - flipPageOrientation or null for none
  - getMarginBottom
```
public Dimension getMarginBottom()
```
    The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setMarginBottom
```
public DocumentStyle setMarginBottom(Dimension marginBottom)
```
    The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    marginBottom - marginBottom or null for none
  - getMarginFooter
```
public Dimension getMarginFooter()
```
    The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setMarginFooter
```
public DocumentStyle setMarginFooter(Dimension marginFooter)
```
    The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    marginFooter - marginFooter or null for none
  - getMarginHeader
```
public Dimension getMarginHeader()
```
    The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setMarginHeader
```
public DocumentStyle setMarginHeader(Dimension marginHeader)
```
    The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    marginHeader - marginHeader or null for none
  - getMarginLeft
```
public Dimension getMarginLeft()
```
    The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setMarginLeft
```
public DocumentStyle setMarginLeft(Dimension marginLeft)
```
    The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    marginLeft - marginLeft or null for none
  - getMarginRight
```
public Dimension getMarginRight()
```
    The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setMarginRight
```
public DocumentStyle setMarginRight(Dimension marginRight)
```
    The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    marginRight - marginRight or null for none
  - getMarginTop
```
public Dimension getMarginTop()
```
    The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setMarginTop
```
public DocumentStyle setMarginTop(Dimension marginTop)
```
    The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    marginTop - marginTop or null for none
  - getPageNumberStart
```
public Integer getPageNumberStart()
```
    The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setPageNumberStart
```
public DocumentStyle setPageNumberStart(Integer pageNumberStart)
```
    The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    pageNumberStart - pageNumberStart or null for none
  - getPageSize
```
public Size getPageSize()
```
    The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setPageSize
```
public DocumentStyle setPageSize(Size pageSize)
```
    The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    pageSize - pageSize or null for none
  - getUseCustomHeaderFooterMargins
```
public Boolean getUseCustomHeaderFooterMargins()
```
    Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Returns:
    
    value or null for none
  - setUseCustomHeaderFooterMargins
```
public DocumentStyle setUseCustomHeaderFooterMargins(Boolean useCustomHeaderFooterMargins)
```
    Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
    
    Parameters:
    
    useCustomHeaderFooterMargins - useCustomHeaderFooterMargins or null for none
  - getUseEvenPageHeaderFooter
```
public Boolean getUseEvenPageHeaderFooter()
```
    Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setUseEvenPageHeaderFooter
```
public DocumentStyle setUseEvenPageHeaderFooter(Boolean useEvenPageHeaderFooter)
```
    Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    useEvenPageHeaderFooter - useEvenPageHeaderFooter or null for none
  - getUseFirstPageHeaderFooter
```
public Boolean getUseFirstPageHeaderFooter()
```
    Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Returns:
    
    value or null for none
  - setUseFirstPageHeaderFooter
```
public DocumentStyle setUseFirstPageHeaderFooter(Boolean useFirstPageHeaderFooter)
```
    Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.
    
    Parameters:
    
    useFirstPageHeaderFooter - useFirstPageHeaderFooter or null for none
  - set
```
public DocumentStyle set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public DocumentStyle clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class DocumentStyle

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

DocumentStyle

Method Detail

getBackground

setBackground

getDefaultFooterId

setDefaultFooterId

getDefaultHeaderId

setDefaultHeaderId

getDocumentFormat

setDocumentFormat

getEvenPageFooterId

setEvenPageFooterId

getEvenPageHeaderId

setEvenPageHeaderId

getFirstPageFooterId

setFirstPageFooterId

getFirstPageHeaderId

setFirstPageHeaderId

getFlipPageOrientation

setFlipPageOrientation

getMarginBottom

setMarginBottom

getMarginFooter

setMarginFooter

getMarginHeader

setMarginHeader

getMarginLeft

setMarginLeft

getMarginRight

setMarginRight

getMarginTop

setMarginTop

getPageNumberStart

setPageNumberStart

getPageSize

setPageSize

getUseCustomHeaderFooterMargins

setUseCustomHeaderFooterMargins

getUseEvenPageHeaderFooter

setUseEvenPageHeaderFooter

getUseFirstPageHeaderFooter

setUseFirstPageHeaderFooter

set

clone