com.google.api.services.docs.v1.model

Class CropProperties

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.CropProperties

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angles are 0, the image is not cropped.

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 Docs 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
CropProperties()

Method Summary

Modifier and Type	Method and Description
CropProperties	clone()
Float	getAngle() The clockwise rotation angle of the crop rectangle around its center, in radians.
Float	getOffsetBottom() The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
Float	getOffsetLeft() The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
Float	getOffsetRight() The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
Float	getOffsetTop() The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
CropProperties	set(String fieldName, Object value)
CropProperties	setAngle(Float angle) The clockwise rotation angle of the crop rectangle around its center, in radians.
CropProperties	setOffsetBottom(Float offsetBottom) The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
CropProperties	setOffsetLeft(Float offsetLeft) The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
CropProperties	setOffsetRight(Float offsetRight) The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
CropProperties	setOffsetTop(Float offsetTop) The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.

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

CropProperties

public CropProperties()

Method Detail

getAngle

public Float getAngle()

The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.

Returns:

value or null for none

setAngle

public CropProperties setAngle(Float angle)

The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.

Parameters:

angle - angle or null for none

getOffsetBottom

public Float getOffsetBottom()

The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.

Returns:

value or null for none

setOffsetBottom

public CropProperties setOffsetBottom(Float offsetBottom)

The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.

Parameters:

offsetBottom - offsetBottom or null for none

getOffsetLeft

public Float getOffsetLeft()

The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.

Returns:

value or null for none

setOffsetLeft

public CropProperties setOffsetLeft(Float offsetLeft)

The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.

Parameters:

offsetLeft - offsetLeft or null for none

getOffsetRight

public Float getOffsetRight()

The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.

Returns:

value or null for none

setOffsetRight

public CropProperties setOffsetRight(Float offsetRight)

The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.

Parameters:

offsetRight - offsetRight or null for none

getOffsetTop

public Float getOffsetTop()

The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.

Returns:

value or null for none

setOffsetTop

public CropProperties setOffsetTop(Float offsetTop)

The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.

Parameters:

offsetTop - offsetTop or null for none

set

public CropProperties set(String fieldName,
                          Object value)

Overrides:

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

clone

public CropProperties clone()

Overrides:

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