Package com.oorian.css

Enum Class AspectRatio

java.lang.Object

java.lang.Enum<AspectRatio>

com.oorian.css.AspectRatio

All Implemented Interfaces:

Serializable, Comparable<AspectRatio>, Constable

public enum AspectRatio
extends Enum<AspectRatio>

CSS aspect-ratio property keyword values for element aspect ratios.

The aspect-ratio property sets a preferred aspect ratio for an element's box. This enum provides keyword values; numeric ratios should be set using a string value directly.

Usage:

 element.setAspectRatio(AspectRatio.AUTO);
 // For numeric ratios, use: element.setStyle("aspect-ratio", "16/9");
 

Since:

2024

Version:

1.0

Author:

Marvin P. Warble Jr.

See Also:

• ObjectFit

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	Box has no preferred aspect ratio (default).
INHERIT	Inherits from parent element.
INITIAL	Sets to default value.
REVERT	Rolls back to the value defined by a previous cascade origin.
REVERT_LAYER	Rolls back to the value defined in the previous cascade layer.
UNSET	Resets the property to its inherited value or initial value.

Method Summary

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

Box has no preferred aspect ratio (default).

INITIAL

public static final AspectRatio INITIAL

Sets to default value.

INHERIT

public static final AspectRatio INHERIT

Inherits from parent element.

UNSET

public static final AspectRatio UNSET

Resets the property to its inherited value or initial value.

REVERT

public static final AspectRatio REVERT

Rolls back to the value defined by a previous cascade origin.

REVERT_LAYER

public static final AspectRatio REVERT_LAYER

Rolls back to the value defined in the previous cascade layer.

Method Details

values

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

Returns:

the CSS value