Package cs2

Enum WindowSide

java.lang.Object

java.lang.Enum<WindowSide>

cs2.WindowSide

All Implemented Interfaces:

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

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

WindowSide is an enum used to indicate the four sides of a Window. This will commonly be used to add or find buttons in a Window.

Author:

loran, mapq, maellis

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST
NORTH
SOUTH
WEST

Method Summary

Modifier and Type	Method	Description
java.lang.String	getSide()	Gives the corresponding BorderLayout type to this WindowSide.
static WindowSide	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static WindowSide[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final WindowSide NORTH

EAST

public static final WindowSide EAST

SOUTH

public static final WindowSide SOUTH

WEST

public static final WindowSide WEST

Method Detail

values

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

Returns:

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

valueOf

public static WindowSide 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

getSide

public java.lang.String getSide()

Gives the corresponding BorderLayout type to this WindowSide.

Returns:

String layout side