com.google.api.services.docs.v1.model

Class PageBreak

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.PageBreak

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PageBreak
extends GenericJson

A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page.

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

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
PageBreak()

Method Summary

Modifier and Type	Method and Description
PageBreak	clone()
List<String>	getSuggestedDeletionIds() The suggested deletion IDs.
List<String>	getSuggestedInsertionIds() The suggested insertion IDs.
Map<String,SuggestedTextStyle>	getSuggestedTextStyleChanges() The suggested text style changes to this PageBreak, keyed by suggestion ID.
TextStyle	getTextStyle() The text style of this PageBreak.
PageBreak	set(String fieldName, Object value)
PageBreak	setSuggestedDeletionIds(List<String> suggestedDeletionIds) The suggested deletion IDs.
PageBreak	setSuggestedInsertionIds(List<String> suggestedInsertionIds) The suggested insertion IDs.
PageBreak	setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges) The suggested text style changes to this PageBreak, keyed by suggestion ID.
PageBreak	setTextStyle(TextStyle textStyle) The text style of this PageBreak.

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

PageBreak

public PageBreak()

Method Detail

getSuggestedDeletionIds

public List<String> getSuggestedDeletionIds()

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Returns:

value or null for none

setSuggestedDeletionIds

public PageBreak setSuggestedDeletionIds(List<String> suggestedDeletionIds)

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Parameters:

suggestedDeletionIds - suggestedDeletionIds or null for none

getSuggestedInsertionIds

public List<String> getSuggestedInsertionIds()

The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

Returns:

value or null for none

setSuggestedInsertionIds

public PageBreak setSuggestedInsertionIds(List<String> suggestedInsertionIds)

The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

Parameters:

suggestedInsertionIds - suggestedInsertionIds or null for none

getSuggestedTextStyleChanges

public Map<String,SuggestedTextStyle> getSuggestedTextStyleChanges()

The suggested text style changes to this PageBreak, keyed by suggestion ID.

Returns:

value or null for none

setSuggestedTextStyleChanges

public PageBreak setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges)

The suggested text style changes to this PageBreak, keyed by suggestion ID.

Parameters:

suggestedTextStyleChanges - suggestedTextStyleChanges or null for none

getTextStyle

public TextStyle getTextStyle()

The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted adjacent to it.

Returns:

value or null for none

setTextStyle

public PageBreak setTextStyle(TextStyle textStyle)

The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted adjacent to it.

Parameters:

textStyle - textStyle or null for none

set

public PageBreak set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public PageBreak clone()

Overrides:

clone in class GenericJson