TextFormat (Google Sheets API v4-rev20241008-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.sheets.v4.model.TextFormat

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TextFormat
extends com.google.api.client.json.GenericJson
```
The format of a run of text in a cell. Absent values indicate that the field isn't specified.
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 Sheets 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

TextFormat()

Constructors
Constructor and Description
`TextFormat()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TextFormat`	`clone()`
`Boolean`	`getBold()` True if the text is bold.
`String`	`getFontFamily()` The font family.
`Integer`	`getFontSize()` The size of the font.
`Color`	`getForegroundColor()` The foreground color of the text.
`ColorStyle`	`getForegroundColorStyle()` The foreground color of the text.
`Boolean`	`getItalic()` True if the text is italicized.
`Link`	`getLink()` The link destination of the text, if any.
`Boolean`	`getStrikethrough()` True if the text has a strikethrough.
`Boolean`	`getUnderline()` True if the text is underlined.
`TextFormat`	`set(String fieldName, Object value)`
`TextFormat`	`setBold(Boolean bold)` True if the text is bold.
`TextFormat`	`setFontFamily(String fontFamily)` The font family.
`TextFormat`	`setFontSize(Integer fontSize)` The size of the font.
`TextFormat`	`setForegroundColor(Color foregroundColor)` The foreground color of the text.
`TextFormat`	`setForegroundColorStyle(ColorStyle foregroundColorStyle)` The foreground color of the text.
`TextFormat`	`setItalic(Boolean italic)` True if the text is italicized.
`TextFormat`	`setLink(Link link)` The link destination of the text, if any.
`TextFormat`	`setStrikethrough(Boolean strikethrough)` True if the text has a strikethrough.
`TextFormat`	`setUnderline(Boolean underline)` True if the text is underlined.

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
  - TextFormat
```
public TextFormat()
```
- Method Detail
  - getBold
```
public Boolean getBold()
```
    True if the text is bold.
    
    Returns:
    
    value or null for none
  - setBold
```
public TextFormat setBold(Boolean bold)
```
    True if the text is bold.
    
    Parameters:
    
    bold - bold or null for none
  - getFontFamily
```
public String getFontFamily()
```
    The font family.
    
    Returns:
    
    value or null for none
  - setFontFamily
```
public TextFormat setFontFamily(String fontFamily)
```
    The font family.
    
    Parameters:
    
    fontFamily - fontFamily or null for none
  - getFontSize
```
public Integer getFontSize()
```
    The size of the font.
    
    Returns:
    
    value or null for none
  - setFontSize
```
public TextFormat setFontSize(Integer fontSize)
```
    The size of the font.
    
    Parameters:
    
    fontSize - fontSize or null for none
  - getForegroundColor
```
public Color getForegroundColor()
```
    The foreground color of the text. Deprecated: Use foreground_color_style.
    
    Returns:
    
    value or null for none
  - setForegroundColor
```
public TextFormat setForegroundColor(Color foregroundColor)
```
    The foreground color of the text. Deprecated: Use foreground_color_style.
    
    Parameters:
    
    foregroundColor - foregroundColor or null for none
  - getForegroundColorStyle
```
public ColorStyle getForegroundColorStyle()
```
    The foreground color of the text. If foreground_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setForegroundColorStyle
```
public TextFormat setForegroundColorStyle(ColorStyle foregroundColorStyle)
```
    The foreground color of the text. If foreground_color is also set, this field takes precedence.
    
    Parameters:
    
    foregroundColorStyle - foregroundColorStyle or null for none
  - getItalic
```
public Boolean getItalic()
```
    True if the text is italicized.
    
    Returns:
    
    value or null for none
  - setItalic
```
public TextFormat setItalic(Boolean italic)
```
    True if the text is italicized.
    
    Parameters:
    
    italic - italic or null for none
  - getLink
```
public Link getLink()
```
    The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults.
    
    Returns:
    
    value or null for none
  - setLink
```
public TextFormat setLink(Link link)
```
    The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults.
    
    Parameters:
    
    link - link or null for none
  - getStrikethrough
```
public Boolean getStrikethrough()
```
    True if the text has a strikethrough.
    
    Returns:
    
    value or null for none
  - setStrikethrough
```
public TextFormat setStrikethrough(Boolean strikethrough)
```
    True if the text has a strikethrough.
    
    Parameters:
    
    strikethrough - strikethrough or null for none
  - getUnderline
```
public Boolean getUnderline()
```
    True if the text is underlined.
    
    Returns:
    
    value or null for none
  - setUnderline
```
public TextFormat setUnderline(Boolean underline)
```
    True if the text is underlined.
    
    Parameters:
    
    underline - underline or null for none
  - set
```
public TextFormat set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TextFormat clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TextFormat

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

TextFormat

Method Detail

getBold

setBold

getFontFamily

setFontFamily

getFontSize

setFontSize

getForegroundColor

setForegroundColor

getForegroundColorStyle

setForegroundColorStyle

getItalic

setItalic

getLink

setLink

getStrikethrough

setStrikethrough

getUnderline

setUnderline

set

clone