org.axsl.common.value

Enum BackgroundRepeat

java.lang.Object

java.lang.Enum<BackgroundRepeat>

org.axsl.common.value.BackgroundRepeat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BackgroundRepeat>

public enum BackgroundRepeat
extends java.lang.Enum<BackgroundRepeat>

Enumeration of the possible background-repeat values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_REPEAT The image is not repeated.
REPEAT The image is repeated both horizontally and vertically.
REPEAT_X The image is repeated horizontally only.
REPEAT_Y The image is repeated vertically only.

Method Summary

Modifier and Type	Method and Description
boolean	repeatsHorizontal() Indicates whether the background repeats on the horizontal axis.
boolean	repeatsVertical() Indicates whether the background repeats on the vertical axis.
static BackgroundRepeat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BackgroundRepeat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REPEAT

public static final BackgroundRepeat REPEAT

The image is repeated both horizontally and vertically.

REPEAT_X

public static final BackgroundRepeat REPEAT_X

The image is repeated horizontally only.

REPEAT_Y

public static final BackgroundRepeat REPEAT_Y

The image is repeated vertically only.

NO_REPEAT

public static final BackgroundRepeat NO_REPEAT

The image is not repeated. Only one copy of the image is drawn.

Method Detail

values

public static BackgroundRepeat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BackgroundRepeat c : BackgroundRepeat.values())
    System.out.println(c);

Returns:

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

valueOf

public static BackgroundRepeat valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

repeatsHorizontal

public boolean repeatsHorizontal()

Indicates whether the background repeats on the horizontal axis.

Returns:

True iff the background repeats on the horizontal axis.

repeatsVertical

public boolean repeatsVertical()

Indicates whether the background repeats on the vertical axis.

Returns:

True iff the background repeats on the vertical axis.