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

Class FilterCriteria

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.FilterCriteria

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FilterCriteria
extends com.google.api.client.json.GenericJson

Criteria for showing/hiding rows in a filter or filter view.

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
FilterCriteria()

Method Summary

Modifier and Type	Method and Description
FilterCriteria	clone()
BooleanCondition	getCondition() A condition that must be true for values to be shown.
List<String>	getHiddenValues() Values that should be hidden.
Color	getVisibleBackgroundColor() The background fill color to filter by; only cells with this fill color are shown.
ColorStyle	getVisibleBackgroundColorStyle() The background fill color to filter by; only cells with this fill color are shown.
Color	getVisibleForegroundColor() The foreground color to filter by; only cells with this foreground color are shown.
ColorStyle	getVisibleForegroundColorStyle() The foreground color to filter by; only cells with this foreground color are shown.
FilterCriteria	set(String fieldName, Object value)
FilterCriteria	setCondition(BooleanCondition condition) A condition that must be true for values to be shown.
FilterCriteria	setHiddenValues(List<String> hiddenValues) Values that should be hidden.
FilterCriteria	setVisibleBackgroundColor(Color visibleBackgroundColor) The background fill color to filter by; only cells with this fill color are shown.
FilterCriteria	setVisibleBackgroundColorStyle(ColorStyle visibleBackgroundColorStyle) The background fill color to filter by; only cells with this fill color are shown.
FilterCriteria	setVisibleForegroundColor(Color visibleForegroundColor) The foreground color to filter by; only cells with this foreground color are shown.
FilterCriteria	setVisibleForegroundColorStyle(ColorStyle visibleForegroundColorStyle) The foreground color to filter by; only cells with this foreground color are shown.

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

FilterCriteria

public FilterCriteria()

Method Detail

getCondition

public BooleanCondition getCondition()

A condition that must be true for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)

Returns:

value or null for none

setCondition

public FilterCriteria setCondition(BooleanCondition condition)

A condition that must be true for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)

Parameters:

condition - condition or null for none

getHiddenValues

public List<String> getHiddenValues()

Values that should be hidden.

Returns:

value or null for none

setHiddenValues

public FilterCriteria setHiddenValues(List<String> hiddenValues)

Values that should be hidden.

Parameters:

hiddenValues - hiddenValues or null for none

getVisibleBackgroundColor

public Color getVisibleBackgroundColor()

The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.

Returns:

value or null for none

setVisibleBackgroundColor

public FilterCriteria setVisibleBackgroundColor(Color visibleBackgroundColor)

The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.

Parameters:

visibleBackgroundColor - visibleBackgroundColor or null for none

getVisibleBackgroundColorStyle

public ColorStyle getVisibleBackgroundColorStyle()

The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.

Returns:

value or null for none

setVisibleBackgroundColorStyle

public FilterCriteria setVisibleBackgroundColorStyle(ColorStyle visibleBackgroundColorStyle)

The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.

Parameters:

visibleBackgroundColorStyle - visibleBackgroundColorStyle or null for none

getVisibleForegroundColor

public Color getVisibleForegroundColor()

The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.

Returns:

value or null for none

setVisibleForegroundColor

public FilterCriteria setVisibleForegroundColor(Color visibleForegroundColor)

The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.

Parameters:

visibleForegroundColor - visibleForegroundColor or null for none

getVisibleForegroundColorStyle

public ColorStyle getVisibleForegroundColorStyle()

The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.

Returns:

value or null for none

setVisibleForegroundColorStyle

public FilterCriteria setVisibleForegroundColorStyle(ColorStyle visibleForegroundColorStyle)

The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.

Parameters:

visibleForegroundColorStyle - visibleForegroundColorStyle or null for none

set

public FilterCriteria set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public FilterCriteria clone()

Overrides:

clone in class com.google.api.client.json.GenericJson