echopoint
Enum BorderLayout.Region

java.lang.Object
  java.lang.Enum<BorderLayout.Region>
      echopoint.BorderLayout.Region

All Implemented Interfaces:

Serializable, Comparable<BorderLayout.Region>

Enclosing class:

BorderLayout

public static enum BorderLayout.Region
extends Enum<BorderLayout.Region>

Enumeration for the regions in a border layout.

Enum Constant Summary

center
The region that represents the centre (default) area of the layout container.

east
The region that represents the east (right) area of the layout container.

north
The region that represents the north (top) area of the layout container.

south
The region that represents the south (bottom) area of the layout container.

west
The region that represents the west (left) area of the layout container.

Method Summary

static BorderLayout.Region	valueOf(String name) Returns the enum constant of this type with the specified name.
static BorderLayout.Region[]	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

north

public static final BorderLayout.Region north

The region that represents the north (top) area of the layout container.

west

public static final BorderLayout.Region west

The region that represents the west (left) area of the layout container.

center

public static final BorderLayout.Region center

The region that represents the centre (default) area of the layout container.

east

public static final BorderLayout.Region east

The region that represents the east (right) area of the layout container.

south

public static final BorderLayout.Region south

The region that represents the south (bottom) area of the layout container.

Method Detail

values

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

Returns:

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

valueOf

public static BorderLayout.Region valueOf(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:

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

NullPointerException - if the argument is null