CellFormat (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.CellFormat

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class CellFormat
extends com.google.api.client.json.GenericJson
```
The format of a cell.
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

CellFormat()

Constructors
Constructor and Description
`CellFormat()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CellFormat`	`clone()`
`Color`	`getBackgroundColor()` The background color of the cell.
`ColorStyle`	`getBackgroundColorStyle()` The background color of the cell.
`Borders`	`getBorders()` The borders of the cell.
`String`	`getHorizontalAlignment()` The horizontal alignment of the value in the cell.
`String`	`getHyperlinkDisplayType()` If one exists, how a hyperlink should be displayed in the cell.
`NumberFormat`	`getNumberFormat()` A format describing how number values should be represented to the user.
`Padding`	`getPadding()` The padding of the cell.
`String`	`getTextDirection()` The direction of the text in the cell.
`TextFormat`	`getTextFormat()` The format of the text in the cell (unless overridden by a format run).
`TextRotation`	`getTextRotation()` The rotation applied to text in the cell.
`String`	`getVerticalAlignment()` The vertical alignment of the value in the cell.
`String`	`getWrapStrategy()` The wrap strategy for the value in the cell.
`CellFormat`	`set(String fieldName, Object value)`
`CellFormat`	`setBackgroundColor(Color backgroundColor)` The background color of the cell.
`CellFormat`	`setBackgroundColorStyle(ColorStyle backgroundColorStyle)` The background color of the cell.
`CellFormat`	`setBorders(Borders borders)` The borders of the cell.
`CellFormat`	`setHorizontalAlignment(String horizontalAlignment)` The horizontal alignment of the value in the cell.
`CellFormat`	`setHyperlinkDisplayType(String hyperlinkDisplayType)` If one exists, how a hyperlink should be displayed in the cell.
`CellFormat`	`setNumberFormat(NumberFormat numberFormat)` A format describing how number values should be represented to the user.
`CellFormat`	`setPadding(Padding padding)` The padding of the cell.
`CellFormat`	`setTextDirection(String textDirection)` The direction of the text in the cell.
`CellFormat`	`setTextFormat(TextFormat textFormat)` The format of the text in the cell (unless overridden by a format run).
`CellFormat`	`setTextRotation(TextRotation textRotation)` The rotation applied to text in the cell.
`CellFormat`	`setVerticalAlignment(String verticalAlignment)` The vertical alignment of the value in the cell.
`CellFormat`	`setWrapStrategy(String wrapStrategy)` The wrap strategy for the value in the cell.

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
  - CellFormat
```
public CellFormat()
```
- Method Detail
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    The background color of the cell. Deprecated: Use background_color_style.
    
    Returns:
    
    value or null for none
  - setBackgroundColor
```
public CellFormat setBackgroundColor(Color backgroundColor)
```
    The background color of the cell. Deprecated: Use background_color_style.
    
    Parameters:
    
    backgroundColor - backgroundColor or null for none
  - getBackgroundColorStyle
```
public ColorStyle getBackgroundColorStyle()
```
    The background color of the cell. If background_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setBackgroundColorStyle
```
public CellFormat setBackgroundColorStyle(ColorStyle backgroundColorStyle)
```
    The background color of the cell. If background_color is also set, this field takes precedence.
    
    Parameters:
    
    backgroundColorStyle - backgroundColorStyle or null for none
  - getBorders
```
public Borders getBorders()
```
    The borders of the cell.
    
    Returns:
    
    value or null for none
  - setBorders
```
public CellFormat setBorders(Borders borders)
```
    The borders of the cell.
    
    Parameters:
    
    borders - borders or null for none
  - getHorizontalAlignment
```
public String getHorizontalAlignment()
```
    The horizontal alignment of the value in the cell.
    
    Returns:
    
    value or null for none
  - setHorizontalAlignment
```
public CellFormat setHorizontalAlignment(String horizontalAlignment)
```
    The horizontal alignment of the value in the cell.
    
    Parameters:
    
    horizontalAlignment - horizontalAlignment or null for none
  - getHyperlinkDisplayType
```
public String getHyperlinkDisplayType()
```
    If one exists, how a hyperlink should be displayed in the cell.
    
    Returns:
    
    value or null for none
  - setHyperlinkDisplayType
```
public CellFormat setHyperlinkDisplayType(String hyperlinkDisplayType)
```
    If one exists, how a hyperlink should be displayed in the cell.
    
    Parameters:
    
    hyperlinkDisplayType - hyperlinkDisplayType or null for none
  - getNumberFormat
```
public NumberFormat getNumberFormat()
```
    A format describing how number values should be represented to the user.
    
    Returns:
    
    value or null for none
  - setNumberFormat
```
public CellFormat setNumberFormat(NumberFormat numberFormat)
```
    A format describing how number values should be represented to the user.
    
    Parameters:
    
    numberFormat - numberFormat or null for none
  - getPadding
```
public Padding getPadding()
```
    The padding of the cell.
    
    Returns:
    
    value or null for none
  - setPadding
```
public CellFormat setPadding(Padding padding)
```
    The padding of the cell.
    
    Parameters:
    
    padding - padding or null for none
  - getTextDirection
```
public String getTextDirection()
```
    The direction of the text in the cell.
    
    Returns:
    
    value or null for none
  - setTextDirection
```
public CellFormat setTextDirection(String textDirection)
```
    The direction of the text in the cell.
    
    Parameters:
    
    textDirection - textDirection or null for none
  - getTextFormat
```
public TextFormat getTextFormat()
```
    The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
    
    Returns:
    
    value or null for none
  - setTextFormat
```
public CellFormat setTextFormat(TextFormat textFormat)
```
    The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
    
    Parameters:
    
    textFormat - textFormat or null for none
  - getTextRotation
```
public TextRotation getTextRotation()
```
    The rotation applied to text in the cell.
    
    Returns:
    
    value or null for none
  - setTextRotation
```
public CellFormat setTextRotation(TextRotation textRotation)
```
    The rotation applied to text in the cell.
    
    Parameters:
    
    textRotation - textRotation or null for none
  - getVerticalAlignment
```
public String getVerticalAlignment()
```
    The vertical alignment of the value in the cell.
    
    Returns:
    
    value or null for none
  - setVerticalAlignment
```
public CellFormat setVerticalAlignment(String verticalAlignment)
```
    The vertical alignment of the value in the cell.
    
    Parameters:
    
    verticalAlignment - verticalAlignment or null for none
  - getWrapStrategy
```
public String getWrapStrategy()
```
    The wrap strategy for the value in the cell.
    
    Returns:
    
    value or null for none
  - setWrapStrategy
```
public CellFormat setWrapStrategy(String wrapStrategy)
```
    The wrap strategy for the value in the cell.
    
    Parameters:
    
    wrapStrategy - wrapStrategy or null for none
  - set
```
public CellFormat set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CellFormat clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class CellFormat

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

CellFormat

Method Detail

getBackgroundColor

setBackgroundColor

getBackgroundColorStyle

setBackgroundColorStyle

getBorders

setBorders

getHorizontalAlignment

setHorizontalAlignment

getHyperlinkDisplayType

setHyperlinkDisplayType

getNumberFormat

setNumberFormat

getPadding

setPadding

getTextDirection

setTextDirection

getTextFormat

setTextFormat

getTextRotation

setTextRotation

getVerticalAlignment

setVerticalAlignment

getWrapStrategy

setWrapStrategy

set

clone