com.javadocking.dockable
Class DockingMode

java.lang.Object
  com.javadocking.dockable.DockingMode

public class DockingMode
extends java.lang.Object

This class defines the constants for the possible modes of docking a dockable. These constants are integers that can be combined with the bitwise or-operation.

Information on using docking modes is in How to Use Dockables in The Sanaware Developer Guide.

Author:

Heidi Rakels.

Field Summary

static int	ALL The dockable can be docked in every dock at every position, except in a tool bar, in a tool grid, in a minimize bar, or in a minimize grid.
static int	BOTTOM The dockable can be docked at the bottom of a dock.
static int	CENTER The dockable can be docked at the center of a dock.
static int	FLOAT The dockable can float.
static int	GRID The dockable can be docked in a grid with other dockables.
static int	HORIZONTAL_LINE The dockable can be docked in a horizontal line with other dockables.
static int	HORIZONTAL_MINIMIZE The dockable can be docked in a horizontal minimize bar.
static int	HORIZONTAL_TOOLBAR The dockable can be docked in a horizontal tool bar.
static int	LEFT The dockable can be docked at the left side of a dock.
static int	LINE The dockable can be docked in a line with other dockables.
static int	MINIMIZE_BAR The dockable can be docked in a horizontal or vertical minimize bar or in a minimize grid.
static int	MINIMIZE_GRID The dockable can be docked in a minimze grid.
static int	RIGHT The dockable can be docked at the right side of a dock.
static int	SINGLE The dockable can be docked all alone in a single dock.
static int	TAB The dockable can be docked as tab in a tabbed pane.
static int	TOOL_BAR The dockable can be docked in a horizontal or vertical tool bar, or in a tool grid.
static int	TOOL_GRID The dockable can be docked in a tool grid.
static int	TOP The dockable can be docked at the top of a dock.
static int	UNKNOWN The docking mode is not known.
static int	VERTICAL_LINE The dockable can be docked in a vertical line with other dockables.
static int	VERTICAL_MINIMIZE The dockable can be docked in a vertical minimize bar.
static int	VERTICAL_TOOLBAR The dockable can be docked in a vertical tool bar.

Method Summary

static java.lang.String

getDescription(int dockingMode) Gets a human readable description for a docking mode defined by this class.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

The docking mode is not known.

See Also:

Constant Field Values

LEFT

public static final int LEFT

The dockable can be docked at the left side of a dock.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

The dockable can be docked at the right side of a dock.

See Also:

Constant Field Values

TOP

public static final int TOP

The dockable can be docked at the top of a dock.

See Also:

Constant Field Values

BOTTOM

public static final int BOTTOM

The dockable can be docked at the bottom of a dock.

See Also:

Constant Field Values

TAB

public static final int TAB

The dockable can be docked as tab in a tabbed pane.

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

The dockable can float.

See Also:

Constant Field Values

SINGLE

public static final int SINGLE

The dockable can be docked all alone in a single dock.

See Also:

Constant Field Values

CENTER

public static final int CENTER

The dockable can be docked at the center of a dock.

See Also:

Constant Field Values

HORIZONTAL_LINE

public static final int HORIZONTAL_LINE

The dockable can be docked in a horizontal line with other dockables.

See Also:

Constant Field Values

VERTICAL_LINE

public static final int VERTICAL_LINE

The dockable can be docked in a vertical line with other dockables.

See Also:

Constant Field Values

GRID

public static final int GRID

The dockable can be docked in a grid with other dockables.

See Also:

Constant Field Values

HORIZONTAL_TOOLBAR

public static final int HORIZONTAL_TOOLBAR

The dockable can be docked in a horizontal tool bar.

See Also:

Constant Field Values

VERTICAL_TOOLBAR

public static final int VERTICAL_TOOLBAR

The dockable can be docked in a vertical tool bar.

See Also:

Constant Field Values

TOOL_GRID

public static final int TOOL_GRID

The dockable can be docked in a tool grid.

See Also:

Constant Field Values

HORIZONTAL_MINIMIZE

public static final int HORIZONTAL_MINIMIZE

The dockable can be docked in a horizontal minimize bar.

See Also:

Constant Field Values

VERTICAL_MINIMIZE

public static final int VERTICAL_MINIMIZE

The dockable can be docked in a vertical minimize bar.

See Also:

Constant Field Values

MINIMIZE_GRID

public static final int MINIMIZE_GRID

The dockable can be docked in a minimze grid.

See Also:

Constant Field Values

TOOL_BAR

public static final int TOOL_BAR

The dockable can be docked in a horizontal or vertical tool bar, or in a tool grid.

See Also:

Constant Field Values

MINIMIZE_BAR

public static final int MINIMIZE_BAR

The dockable can be docked in a horizontal or vertical minimize bar or in a minimize grid.

See Also:

Constant Field Values

LINE

public static final int LINE

The dockable can be docked in a line with other dockables.

See Also:

Constant Field Values

ALL

public static final int ALL

The dockable can be docked in every dock at every position, except in a tool bar, in a tool grid, in a minimize bar, or in a minimize grid.

See Also:

Constant Field Values

Method Detail

getDescription

public static java.lang.String getDescription(int dockingMode)

Gets a human readable description for a docking mode defined by this class.

Parameters:

dockingMode - A docking mode defined by this class.

Returns:

A human readable description for a docking mode defined by this class.