com.google.api.services.sheets.v4.model.BandingProperties Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* 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://code.google.com/p/google-apis-client-generator/
* (build: 2017-01-11 18:31:16 UTC)
* on 2017-01-26 at 19:22:02 UTC
* Modify at your own risk.
*/
package com.google.api.services.sheets.v4.model;
/**
* Properties referring a single dimension (either row or column). If both
* BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied
* to cells according to the following rules:
*
* * header_color and footer_color take priority over band colors. * first_band_color takes priority
* over second_band_color. * row_properties takes priority over column_properties.
*
* For example, the first row color takes priority over the first column color, but the first column
* color takes priority over the second row color. Similarly, the row header takes priority over the
* column header in the top left cell, but the column header takes priority over the first row color
* if the row header is not set.
*
* 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:
* http://code.google.com/p/google-http-java-client/wiki/JSON
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class BandingProperties extends com.google.api.client.json.GenericJson {
/**
* The first color that is alternating. (Required)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private Color firstBandColor;
/**
* The color of the last row or column. If this field is not set, the last row or column will be
* filled with either first_band_color or second_band_color, depending on the color of the
* previous row or column.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private Color footerColor;
/**
* The color of the first row or column. If this field is set, the first row or column will be
* filled with this color and the colors will alternate between first_band_color and
* second_band_color starting from the second row or column. Otherwise, the first row or column
* will be filled with first_band_color and the colors will proceed to alternate as they normally
* would.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private Color headerColor;
/**
* The second color that is alternating. (Required)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private Color secondBandColor;
/**
* The first color that is alternating. (Required)
* @return value or {@code null} for none
*/
public Color getFirstBandColor() {
return firstBandColor;
}
/**
* The first color that is alternating. (Required)
* @param firstBandColor firstBandColor or {@code null} for none
*/
public BandingProperties setFirstBandColor(Color firstBandColor) {
this.firstBandColor = firstBandColor;
return this;
}
/**
* The color of the last row or column. If this field is not set, the last row or column will be
* filled with either first_band_color or second_band_color, depending on the color of the
* previous row or column.
* @return value or {@code null} for none
*/
public Color getFooterColor() {
return footerColor;
}
/**
* The color of the last row or column. If this field is not set, the last row or column will be
* filled with either first_band_color or second_band_color, depending on the color of the
* previous row or column.
* @param footerColor footerColor or {@code null} for none
*/
public BandingProperties setFooterColor(Color footerColor) {
this.footerColor = footerColor;
return this;
}
/**
* The color of the first row or column. If this field is set, the first row or column will be
* filled with this color and the colors will alternate between first_band_color and
* second_band_color starting from the second row or column. Otherwise, the first row or column
* will be filled with first_band_color and the colors will proceed to alternate as they normally
* would.
* @return value or {@code null} for none
*/
public Color getHeaderColor() {
return headerColor;
}
/**
* The color of the first row or column. If this field is set, the first row or column will be
* filled with this color and the colors will alternate between first_band_color and
* second_band_color starting from the second row or column. Otherwise, the first row or column
* will be filled with first_band_color and the colors will proceed to alternate as they normally
* would.
* @param headerColor headerColor or {@code null} for none
*/
public BandingProperties setHeaderColor(Color headerColor) {
this.headerColor = headerColor;
return this;
}
/**
* The second color that is alternating. (Required)
* @return value or {@code null} for none
*/
public Color getSecondBandColor() {
return secondBandColor;
}
/**
* The second color that is alternating. (Required)
* @param secondBandColor secondBandColor or {@code null} for none
*/
public BandingProperties setSecondBandColor(Color secondBandColor) {
this.secondBandColor = secondBandColor;
return this;
}
@Override
public BandingProperties set(String fieldName, Object value) {
return (BandingProperties) super.set(fieldName, value);
}
@Override
public BandingProperties clone() {
return (BandingProperties) super.clone();
}
}