com.softwarefx.chartfx.server
Enum DockArea

java.lang.Object
  java.lang.Enum<DockArea>
      com.softwarefx.chartfx.server.DockArea

All Implemented Interfaces:

Serializable, Comparable<DockArea>

public enum DockArea
extends Enum<DockArea>

Define how to set the docked selected tool position.

Enum Constant Summary

BOTTOM
Docks the object to the bottom margin.

LEFT
Docks the object to the left margin.

RIGHT
Docks the object to the right margin.

TOP
Docks the object to the top margin.

Method Summary

static EnumSet<DockArea>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static DockArea	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(DockArea value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(EnumSet<DockArea> value) Returns a numeric value that represents the given EnumSet or Enum item.
static DockArea	valueOf(String name) Returns the enum constant of this type with the specified name.
static DockArea[]	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

LEFT

public static final DockArea LEFT

Docks the object to the left margin.

TOP

public static final DockArea TOP

Docks the object to the top margin.

RIGHT

public static final DockArea RIGHT

Docks the object to the right margin.

BOTTOM

public static final DockArea BOTTOM

Docks the object to the bottom margin.

Method Detail

values

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

Returns:

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

valueOf

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

getEnumSetValue

public static EnumSet<DockArea> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static DockArea getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(DockArea value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<DockArea> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.