Module omix.api

Package omix.util

Enum DockingPosition

java.lang.Object

java.lang.Enum<DockingPosition>

omix.util.DockingPosition

All Implemented Interfaces:

Serializable, Comparable<DockingPosition>, Constable

public enum DockingPosition
extends Enum<DockingPosition>

This enum represents all available docking positions at a node in the diagram area.

Since:

Omix 1.3

Author:

peter Droste

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	bottom center
BOTTOM_LEFT	bottom left
BOTTOM_RIGHT	bottom right
CENTER	center of the node
CENTER_LEFT	center left
CENTER_RIGHT	center right
TOP	top center
TOP_LEFT	top left
TOP_RIGHT	top right

Method Summary

Modifier and Type	Method	Description
static DockingPosition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DockingPosition[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOP_RIGHT

public static final DockingPosition TOP_RIGHT

top right

TOP

public static final DockingPosition TOP

top center

TOP_LEFT

public static final DockingPosition TOP_LEFT

top left

CENTER_RIGHT

public static final DockingPosition CENTER_RIGHT

center right

CENTER

public static final DockingPosition CENTER

center of the node

CENTER_LEFT

public static final DockingPosition CENTER_LEFT

center left

BOTTOM_LEFT

public static final DockingPosition BOTTOM_LEFT

bottom left

BOTTOM

public static final DockingPosition BOTTOM

bottom center

BOTTOM_RIGHT

public static final DockingPosition BOTTOM_RIGHT

bottom right

Method Details

values

public static DockingPosition[] values()

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

Returns:

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

valueOf

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