com.javadocking.dock
Class Priority

java.lang.Object
  com.javadocking.dock.Priority

public class Priority
extends java.lang.Object

This class defines the integer constants for the priority for adding a dockable to a specific dock.

Depending on the location of the mouse above the dock, when dragging a dockable, a dockable can be docked in different ways in the dock. Every location has a priority for docking a dockable. If a dockable cannot be docked at all, the priority is CANNOT_DOCK. Other possible priority values with ascending priority are CAN_DOCK_AS_LAST, CAN_DOCK, CAN_DOCK_WITH_PRIORITY and CAN_DOCK_WITH_HIGH_PRIORITY.

It is possible that a dockable can be docked in multiple docks for the same screen location. In that case the dock that has the highest priority, will be chosen.

Author:

Heidi Rakels.

Field Summary

static int	CAN_DOCK A dockable can be docked.
static int	CAN_DOCK_AS_LAST A dockable can be docked, but only if there are no other possiblities.
static int	CAN_DOCK_WITH_HIGH_PRIORITY A dockable can be docked with high priority.
static int	CAN_DOCK_WITH_PRIORITY A dockable can be docked with priority.
static int	CANNOT_DOCK A dockable cannot be docked.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CANNOT_DOCK

public static final int CANNOT_DOCK

A dockable cannot be docked.

See Also:

Constant Field Values

CAN_DOCK_AS_LAST

public static final int CAN_DOCK_AS_LAST

A dockable can be docked, but only if there are no other possiblities.

See Also:

Constant Field Values

CAN_DOCK

public static final int CAN_DOCK

A dockable can be docked.

See Also:

Constant Field Values

CAN_DOCK_WITH_PRIORITY

public static final int CAN_DOCK_WITH_PRIORITY

A dockable can be docked with priority. With priority means that it is a good position. If the dock can also be docked in other docks, but not with priority, it will be added here.

See Also:

Constant Field Values

CAN_DOCK_WITH_HIGH_PRIORITY

public static final int CAN_DOCK_WITH_HIGH_PRIORITY

A dockable can be docked with high priority. With high priority means that it is the best position for this dockable.

See Also:

Constant Field Values