Package net.risingworld.api.ui.style

Enum Class ScaleMode

java.lang.Object

java.lang.Enum<ScaleMode>

net.risingworld.api.ui.style.ScaleMode

All Implemented Interfaces:

Serializable, Comparable<ScaleMode>, Constable

public enum ScaleMode
extends Enum<ScaleMode>

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
ScaleAndCrop	Scales the image and keeps the aspect ratio.
ScaleToFit	Scales the image and keeps the aspect ratio.
StretchToFill	Default: Stretches the image to fill the whole element, irrespective of the aspect ratio

Method Summary

Modifier and Type	Method	Description
static ScaleMode	get(int ordinal)	Gets an enum from the ordinal value.
static ScaleMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScaleMode[]	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

StretchToFill

public static final ScaleMode StretchToFill

Default: Stretches the image to fill the whole element, irrespective of the aspect ratio

ScaleAndCrop

public static final ScaleMode ScaleAndCrop

Scales the image and keeps the aspect ratio. If the image exceeds the element, it will be cropped

ScaleToFit

public static final ScaleMode ScaleToFit

Scales the image and keeps the aspect ratio. Makes sure the image completely fits into the element

Method Details

values

public static ScaleMode[] 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 ScaleMode 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

get

public static ScaleMode get(int ordinal)

Gets an enum from the ordinal value.

Parameters:

ordinal - the ordinal value (index).

Returns:

the according enum.