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

Class InsertPageBreakRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class InsertPageBreakRequest
extends com.google.api.client.json.GenericJson

Inserts a page break followed by a newline at the specified location.

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

Method Summary

Modifier and Type	Method and Description
InsertPageBreakRequest	clone()
EndOfSegmentLocation	getEndOfSegmentLocation() Inserts the page break at the end of the document body.
Location	getLocation() Inserts the page break at a specific index in the document.
InsertPageBreakRequest	set(String fieldName, Object value)
InsertPageBreakRequest	setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation) Inserts the page break at the end of the document body.
InsertPageBreakRequest	setLocation(Location location) Inserts the page break at a specific index in the document.

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

InsertPageBreakRequest

public InsertPageBreakRequest()

Method Detail

getEndOfSegmentLocation

public EndOfSegmentLocation getEndOfSegmentLocation()

Inserts the page break at the end of the document body. Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty.

Returns:

value or null for none

setEndOfSegmentLocation

public InsertPageBreakRequest setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation)

Inserts the page break at the end of the document body. Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty.

Parameters:

endOfSegmentLocation - endOfSegmentLocation or null for none

getLocation

public Location getLocation()

Inserts the page break at a specific index in the document. The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty.

Returns:

value or null for none

setLocation

public InsertPageBreakRequest setLocation(Location location)

Inserts the page break at a specific index in the document. The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty.

Parameters:

location - location or null for none

set

public InsertPageBreakRequest set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public InsertPageBreakRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson