Package com.grapecity.documents.excel

Enum Class BackgroundImageLayout

java.lang.Object

java.lang.Enum<BackgroundImageLayout>

com.grapecity.documents.excel.BackgroundImageLayout

All Implemented Interfaces:

Serializable, Comparable<BackgroundImageLayout>, Constable

public enum BackgroundImageLayout
extends Enum<BackgroundImageLayout>

Specifies how a background image should be stretched to fill the destination rectangle.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Center	Specifies to centre-align the image within the destination rectangle.
None	Specifies to left-align the image at the top across the destination rectangle.
Stretch	Specifies to resize the image to fill the destination dimensions.
Zoom	Specifies to resize the image to fit in the destination dimensions while preserving the image’s native aspect ratio.

Method Summary

Modifier and Type	Method	Description
static BackgroundImageLayout	forValue(Integer value)	Retrieves the enum constant corresponding to the specified integer value.
int	getValue()	Retrieves the integer value representing the enum constant.
static BackgroundImageLayout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BackgroundImageLayout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Stretch

public static final BackgroundImageLayout Stretch

Specifies to resize the image to fill the destination dimensions. The aspect ratio is not preserved.

Center

public static final BackgroundImageLayout Center

Specifies to centre-align the image within the destination rectangle.

Zoom

public static final BackgroundImageLayout Zoom

Specifies to resize the image to fit in the destination dimensions while preserving the image’s native aspect ratio.

None

public static final BackgroundImageLayout None

Specifies to left-align the image at the top across the destination rectangle.

Method Details

values

public static BackgroundImageLayout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BackgroundImageLayout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Retrieves the integer value representing the enum constant.

Returns:

The ordinal value of the enum constant.

forValue

public static BackgroundImageLayout forValue(Integer value)

Retrieves the enum constant corresponding to the specified integer value.

Parameters:

value - The integer value representing the enum constant.

Returns:

The BackgroundImageLayout enum constant.