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

Class InsertTextRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Inserts text 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
InsertTextRequest()

Method Summary

Modifier and Type	Method and Description
InsertTextRequest	clone()
EndOfSegmentLocation	getEndOfSegmentLocation() Inserts the text at the end of a header, footer, footnote or the document body.
Location	getLocation() Inserts the text at a specific index in the document.
String	getText() The text to be inserted.
InsertTextRequest	set(String fieldName, Object value)
InsertTextRequest	setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation) Inserts the text at the end of a header, footer, footnote or the document body.
InsertTextRequest	setLocation(Location location) Inserts the text at a specific index in the document.
InsertTextRequest	setText(String text) The text to be inserted.

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

InsertTextRequest

public InsertTextRequest()

Method Detail

getEndOfSegmentLocation

public EndOfSegmentLocation getEndOfSegmentLocation()

Inserts the text at the end of a header, footer, footnote or the document body.

Returns:

value or null for none

setEndOfSegmentLocation

public InsertTextRequest setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation)

Inserts the text at the end of a header, footer, footnote or the document body.

Parameters:

endOfSegmentLocation - endOfSegmentLocation or null for none

getLocation

public Location getLocation()

Inserts the text at a specific index in the document. Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph.

Returns:

value or null for none

setLocation

public InsertTextRequest setLocation(Location location)

Inserts the text at a specific index in the document. Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph.

Parameters:

location - location or null for none

getText

public String getText()

The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.

Returns:

value or null for none

setText

public InsertTextRequest setText(String text)

The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.

Parameters:

text - text or null for none

set

public InsertTextRequest set(String fieldName,
                             Object value)

Overrides:

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

clone

public InsertTextRequest clone()

Overrides:

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