net.sf.freecol.client.gui.panel

Enum Flag.Background

java.lang.Object

java.lang.Enum<Flag.Background>

net.sf.freecol.client.gui.panel.Flag.Background

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Flag.Background>

Enclosing class:

Flag

public static enum Flag.Background
extends java.lang.Enum<Flag.Background>

The "background layer" of the flag, generally one or several squares or triangles of different color. The alignment of the background influences the size of the canton, if there is one.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FESSES Horizontal stripes.
PALES Vertical stripes.
PER_BEND Diagonal top left to bottom right.
PER_BEND_SINISTER Diagonal bottom left to top right.
PER_SALTIRE Quartered diagonally.
PLAIN A plain background.
QUARTERLY Quartered rectangularly.

Field Summary

Fields

Modifier and Type	Field and Description
Flag.Alignment	alignment

Method Summary

Modifier and Type	Method and Description
static Flag.Background	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Flag.Background[]	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

PLAIN

public static final Flag.Background PLAIN

A plain background.

QUARTERLY

public static final Flag.Background QUARTERLY

Quartered rectangularly.

PALES

public static final Flag.Background PALES

Vertical stripes.

FESSES

public static final Flag.Background FESSES

Horizontal stripes.

PER_BEND

public static final Flag.Background PER_BEND

Diagonal top left to bottom right.

PER_BEND_SINISTER

public static final Flag.Background PER_BEND_SINISTER

Diagonal bottom left to top right.

PER_SALTIRE

public static final Flag.Background PER_SALTIRE

Quartered diagonally.

Field Detail

alignment

public final Flag.Alignment alignment

Method Detail

values

public static Flag.Background[] 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 (Flag.Background c : Flag.Background.values())
    System.out.println(c);

Returns:

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

valueOf

public static Flag.Background 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