org.pzgui
Enum DockLocation

java.lang.Object
  java.lang.Enum<DockLocation>
      org.pzgui.DockLocation

All Implemented Interfaces:

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

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

How a window is connected (docked) to another.

Author:

David Underhill

Enum Constant Summary

ABOVE

BELOW

LEFT_OF

NOT_DOCKED

RIGHT_OF

Method Summary

Vector2i	getChildPosition(Vector2i parentPos, Vector2i parentSize, Vector2i childPos, Vector2i childSize) Returns the position for the top-left corner of a child window based on the current docking scheme.
static DockLocation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DockLocation[]	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

NOT_DOCKED

public static final DockLocation NOT_DOCKED

RIGHT_OF

public static final DockLocation RIGHT_OF

LEFT_OF

public static final DockLocation LEFT_OF

ABOVE

public static final DockLocation ABOVE

BELOW

public static final DockLocation BELOW

Method Detail

values

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

Returns:

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

valueOf

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

getChildPosition

public Vector2i getChildPosition(Vector2i parentPos,
                                 Vector2i parentSize,
                                 Vector2i childPos,
                                 Vector2i childSize)

Returns the position for the top-left corner of a child window based on the current docking scheme.

Parameters:

parentPos - Location of the parent's top-left corner. If null, childPos is returned.

parentSize - Size of the parent.

childPos - Location of the child's top-left corner.

childSize - Size of the child.

Returns:

position of the child