TextStyle (Google Slides API v1-rev20240305-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.slides.v1.model.TextStyle

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TextStyle
extends com.google.api.client.json.GenericJson
```
Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor.
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 Slides 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

TextStyle()

Constructors
Constructor and Description
`TextStyle()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TextStyle`	`clone()`
`OptionalColor`	`getBackgroundColor()` The background color of the text.
`String`	`getBaselineOffset()` The text's vertical offset from its normal position.
`Boolean`	`getBold()` Whether or not the text is rendered as bold.
`String`	`getFontFamily()` The font family of the text.
`Dimension`	`getFontSize()` The size of the text's font.
`OptionalColor`	`getForegroundColor()` The color of the text itself.
`Boolean`	`getItalic()` Whether or not the text is italicized.
`Link`	`getLink()` The hyperlink destination of the text.
`Boolean`	`getSmallCaps()` Whether or not the text is in small capital letters.
`Boolean`	`getStrikethrough()` Whether or not the text is struck through.
`Boolean`	`getUnderline()` Whether or not the text is underlined.
`WeightedFontFamily`	`getWeightedFontFamily()` The font family and rendered weight of the text.
`TextStyle`	`set(String fieldName, Object value)`
`TextStyle`	`setBackgroundColor(OptionalColor backgroundColor)` The background color of the text.
`TextStyle`	`setBaselineOffset(String baselineOffset)` The text's vertical offset from its normal position.
`TextStyle`	`setBold(Boolean bold)` Whether or not the text is rendered as bold.
`TextStyle`	`setFontFamily(String fontFamily)` The font family of the text.
`TextStyle`	`setFontSize(Dimension fontSize)` The size of the text's font.
`TextStyle`	`setForegroundColor(OptionalColor foregroundColor)` The color of the text itself.
`TextStyle`	`setItalic(Boolean italic)` Whether or not the text is italicized.
`TextStyle`	`setLink(Link link)` The hyperlink destination of the text.
`TextStyle`	`setSmallCaps(Boolean smallCaps)` Whether or not the text is in small capital letters.
`TextStyle`	`setStrikethrough(Boolean strikethrough)` Whether or not the text is struck through.
`TextStyle`	`setUnderline(Boolean underline)` Whether or not the text is underlined.
`TextStyle`	`setWeightedFontFamily(WeightedFontFamily weightedFontFamily)` The font family and rendered weight of the text.

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
  - TextStyle
```
public TextStyle()
```
- Method Detail
  - getBackgroundColor
```
public OptionalColor getBackgroundColor()
```
    The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set.
    
    Returns:
    
    value or null for none
  - setBackgroundColor
```
public TextStyle setBackgroundColor(OptionalColor backgroundColor)
```
    The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set.
    
    Parameters:
    
    backgroundColor - backgroundColor or null for none
  - getBaselineOffset
```
public String getBaselineOffset()
```
    The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field.
    
    Returns:
    
    value or null for none
  - setBaselineOffset
```
public TextStyle setBaselineOffset(String baselineOffset)
```
    The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field.
    
    Parameters:
    
    baselineOffset - baselineOffset or null for none
  - getBold
```
public Boolean getBold()
```
    Whether or not the text is rendered as bold.
    
    Returns:
    
    value or null for none
  - setBold
```
public TextStyle setBold(Boolean bold)
```
    Whether or not the text is rendered as bold.
    
    Parameters:
    
    bold - bold or null for none
  - getFontFamily
```
public String getFontFamily()
```
    The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used.
    
    Returns:
    
    value or null for none
  - setFontFamily
```
public TextStyle setFontFamily(String fontFamily)
```
    The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used.
    
    Parameters:
    
    fontFamily - fontFamily or null for none
  - getFontSize
```
public Dimension getFontSize()
```
    The size of the text's font. When read, the `font_size` will specified in points.
    
    Returns:
    
    value or null for none
  - setFontSize
```
public TextStyle setFontSize(Dimension fontSize)
```
    The size of the text's font. When read, the `font_size` will specified in points.
    
    Parameters:
    
    fontSize - fontSize or null for none
  - getForegroundColor
```
public OptionalColor getForegroundColor()
```
    The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set.
    
    Returns:
    
    value or null for none
  - setForegroundColor
```
public TextStyle setForegroundColor(OptionalColor foregroundColor)
```
    The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set.
    
    Parameters:
    
    foregroundColor - foregroundColor or null for none
  - getItalic
```
public Boolean getItalic()
```
    Whether or not the text is italicized.
    
    Returns:
    
    value or null for none
  - setItalic
```
public TextStyle setItalic(Boolean italic)
```
    Whether or not the text is italicized.
    
    Parameters:
    
    italic - italic or null for none
  - getLink
```
public Link getLink()
```
    The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK 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. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
    
    Returns:
    
    value or null for none
  - setLink
```
public TextStyle setLink(Link link)
```
    The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK 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. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
    
    Parameters:
    
    link - link or null for none
  - getSmallCaps
```
public Boolean getSmallCaps()
```
    Whether or not the text is in small capital letters.
    
    Returns:
    
    value or null for none
  - setSmallCaps
```
public TextStyle setSmallCaps(Boolean smallCaps)
```
    Whether or not the text is in small capital letters.
    
    Parameters:
    
    smallCaps - smallCaps or null for none
  - getStrikethrough
```
public Boolean getStrikethrough()
```
    Whether or not the text is struck through.
    
    Returns:
    
    value or null for none
  - setStrikethrough
```
public TextStyle setStrikethrough(Boolean strikethrough)
```
    Whether or not the text is struck through.
    
    Parameters:
    
    strikethrough - strikethrough or null for none
  - getUnderline
```
public Boolean getUnderline()
```
    Whether or not the text is underlined.
    
    Returns:
    
    value or null for none
  - setUnderline
```
public TextStyle setUnderline(Boolean underline)
```
    Whether or not the text is underlined.
    
    Parameters:
    
    underline - underline or null for none
  - getWeightedFontFamily
```
public WeightedFontFamily getWeightedFontFamily()
```
    The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
    
    Returns:
    
    value or null for none
  - setWeightedFontFamily
```
public TextStyle setWeightedFontFamily(WeightedFontFamily weightedFontFamily)
```
    The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
    
    Parameters:
    
    weightedFontFamily - weightedFontFamily or null for none
  - set
```
public TextStyle set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TextStyle clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TextStyle

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

TextStyle

Method Detail

getBackgroundColor

setBackgroundColor

getBaselineOffset

setBaselineOffset

getBold

setBold

getFontFamily

setFontFamily

getFontSize

setFontSize

getForegroundColor

setForegroundColor

getItalic

setItalic

getLink

setLink

getSmallCaps

setSmallCaps

getStrikethrough

setStrikethrough

getUnderline

setUnderline

getWeightedFontFamily

setWeightedFontFamily

set

clone