Package com.oorian.css

Enum Class BackgroundSize

java.lang.Object

java.lang.Enum<BackgroundSize>

com.oorian.css.BackgroundSize

All Implemented Interfaces:

Serializable, Comparable<BackgroundSize>, Constable

public enum BackgroundSize
extends Enum<BackgroundSize>

CSS background-size property keyword values for image sizing.

The background-size property specifies the size of background images. It can scale images to fill the container or maintain aspect ratio.

Usage:

 element.setBackgroundSize(BackgroundSize.COVER);
 element.setBackgroundSize(BackgroundSize.CONTAIN);
 

Since:

2012

Version:

1.0

Author:

Marvin P. Warble Jr.

See Also:

• BackgroundIntf

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
AUTO	Image maintains its original size (default).
CONTAIN	Image fits inside container, may leave empty space.
COVER	Image covers entire container, may be cropped.
INHERIT	Inherits from parent element.
INITIAL	Sets to default value.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the CSS value string.
String	toString()	Returns the CSS value string.
static BackgroundSize	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BackgroundSize[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final BackgroundSize AUTO

Image maintains its original size (default).

INHERIT

public static final BackgroundSize INHERIT

Inherits from parent element.

INITIAL

public static final BackgroundSize INITIAL

Sets to default value.

COVER

public static final BackgroundSize COVER

Image covers entire container, may be cropped.

CONTAIN

public static final BackgroundSize CONTAIN

Image fits inside container, may leave empty space.

Method Details

values

public static BackgroundSize[] 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 BackgroundSize 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 String getValue()

Returns the CSS value string.

Returns:

the CSS value

toString

public String toString()

Returns the CSS value string.

Overrides:

toString in class Enum<BackgroundSize>

Returns:

the CSS value