File: CellFormat.java

package info (click to toggle)
google-api-services-sheets-java 1.32.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,008 kB
  • sloc: java: 12,826; xml: 161; makefile: 2
file content (336 lines) | stat: -rw-r--r-- 9,582 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.sheets.v4.model;

/**
 * The format of a cell.
 *
 * <p> 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:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class CellFormat extends com.google.api.client.json.GenericJson {

  /**
   * The background color of the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Color backgroundColor;

  /**
   * The background color of the cell. If background_color is also set, this field takes precedence.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ColorStyle backgroundColorStyle;

  /**
   * The borders of the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Borders borders;

  /**
   * The horizontal alignment of the value in the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String horizontalAlignment;

  /**
   * How a hyperlink, if it exists, should be displayed in the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String hyperlinkDisplayType;

  /**
   * A format describing how number values should be represented to the user.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private NumberFormat numberFormat;

  /**
   * The padding of the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Padding padding;

  /**
   * The direction of the text in the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String textDirection;

  /**
   * The format of the text in the cell (unless overridden by a format run). Setting a cell-level
   * link here will clear the cell's existing links. Setting the link field in a TextFormatRun will
   * take precedence over the cell-level link.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TextFormat textFormat;

  /**
   * The rotation applied to text in a cell
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TextRotation textRotation;

  /**
   * The vertical alignment of the value in the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String verticalAlignment;

  /**
   * The wrap strategy for the value in the cell.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String wrapStrategy;

  /**
   * The background color of the cell.
   * @return value or {@code null} for none
   */
  public Color getBackgroundColor() {
    return backgroundColor;
  }

  /**
   * The background color of the cell.
   * @param backgroundColor backgroundColor or {@code null} for none
   */
  public CellFormat setBackgroundColor(Color backgroundColor) {
    this.backgroundColor = backgroundColor;
    return this;
  }

  /**
   * The background color of the cell. If background_color is also set, this field takes precedence.
   * @return value or {@code null} for none
   */
  public ColorStyle getBackgroundColorStyle() {
    return backgroundColorStyle;
  }

  /**
   * The background color of the cell. If background_color is also set, this field takes precedence.
   * @param backgroundColorStyle backgroundColorStyle or {@code null} for none
   */
  public CellFormat setBackgroundColorStyle(ColorStyle backgroundColorStyle) {
    this.backgroundColorStyle = backgroundColorStyle;
    return this;
  }

  /**
   * The borders of the cell.
   * @return value or {@code null} for none
   */
  public Borders getBorders() {
    return borders;
  }

  /**
   * The borders of the cell.
   * @param borders borders or {@code null} for none
   */
  public CellFormat setBorders(Borders borders) {
    this.borders = borders;
    return this;
  }

  /**
   * The horizontal alignment of the value in the cell.
   * @return value or {@code null} for none
   */
  public java.lang.String getHorizontalAlignment() {
    return horizontalAlignment;
  }

  /**
   * The horizontal alignment of the value in the cell.
   * @param horizontalAlignment horizontalAlignment or {@code null} for none
   */
  public CellFormat setHorizontalAlignment(java.lang.String horizontalAlignment) {
    this.horizontalAlignment = horizontalAlignment;
    return this;
  }

  /**
   * How a hyperlink, if it exists, should be displayed in the cell.
   * @return value or {@code null} for none
   */
  public java.lang.String getHyperlinkDisplayType() {
    return hyperlinkDisplayType;
  }

  /**
   * How a hyperlink, if it exists, should be displayed in the cell.
   * @param hyperlinkDisplayType hyperlinkDisplayType or {@code null} for none
   */
  public CellFormat setHyperlinkDisplayType(java.lang.String hyperlinkDisplayType) {
    this.hyperlinkDisplayType = hyperlinkDisplayType;
    return this;
  }

  /**
   * A format describing how number values should be represented to the user.
   * @return value or {@code null} for none
   */
  public NumberFormat getNumberFormat() {
    return numberFormat;
  }

  /**
   * A format describing how number values should be represented to the user.
   * @param numberFormat numberFormat or {@code null} for none
   */
  public CellFormat setNumberFormat(NumberFormat numberFormat) {
    this.numberFormat = numberFormat;
    return this;
  }

  /**
   * The padding of the cell.
   * @return value or {@code null} for none
   */
  public Padding getPadding() {
    return padding;
  }

  /**
   * The padding of the cell.
   * @param padding padding or {@code null} for none
   */
  public CellFormat setPadding(Padding padding) {
    this.padding = padding;
    return this;
  }

  /**
   * The direction of the text in the cell.
   * @return value or {@code null} for none
   */
  public java.lang.String getTextDirection() {
    return textDirection;
  }

  /**
   * The direction of the text in the cell.
   * @param textDirection textDirection or {@code null} for none
   */
  public CellFormat setTextDirection(java.lang.String textDirection) {
    this.textDirection = textDirection;
    return this;
  }

  /**
   * The format of the text in the cell (unless overridden by a format run). Setting a cell-level
   * link here will clear the cell's existing links. Setting the link field in a TextFormatRun will
   * take precedence over the cell-level link.
   * @return value or {@code null} for none
   */
  public TextFormat getTextFormat() {
    return textFormat;
  }

  /**
   * The format of the text in the cell (unless overridden by a format run). Setting a cell-level
   * link here will clear the cell's existing links. Setting the link field in a TextFormatRun will
   * take precedence over the cell-level link.
   * @param textFormat textFormat or {@code null} for none
   */
  public CellFormat setTextFormat(TextFormat textFormat) {
    this.textFormat = textFormat;
    return this;
  }

  /**
   * The rotation applied to text in a cell
   * @return value or {@code null} for none
   */
  public TextRotation getTextRotation() {
    return textRotation;
  }

  /**
   * The rotation applied to text in a cell
   * @param textRotation textRotation or {@code null} for none
   */
  public CellFormat setTextRotation(TextRotation textRotation) {
    this.textRotation = textRotation;
    return this;
  }

  /**
   * The vertical alignment of the value in the cell.
   * @return value or {@code null} for none
   */
  public java.lang.String getVerticalAlignment() {
    return verticalAlignment;
  }

  /**
   * The vertical alignment of the value in the cell.
   * @param verticalAlignment verticalAlignment or {@code null} for none
   */
  public CellFormat setVerticalAlignment(java.lang.String verticalAlignment) {
    this.verticalAlignment = verticalAlignment;
    return this;
  }

  /**
   * The wrap strategy for the value in the cell.
   * @return value or {@code null} for none
   */
  public java.lang.String getWrapStrategy() {
    return wrapStrategy;
  }

  /**
   * The wrap strategy for the value in the cell.
   * @param wrapStrategy wrapStrategy or {@code null} for none
   */
  public CellFormat setWrapStrategy(java.lang.String wrapStrategy) {
    this.wrapStrategy = wrapStrategy;
    return this;
  }

  @Override
  public CellFormat set(String fieldName, Object value) {
    return (CellFormat) super.set(fieldName, value);
  }

  @Override
  public CellFormat clone() {
    return (CellFormat) super.clone();
  }

}