bibliothek.gui.dock.station.span
Class SpanMode

java.lang.Object
  bibliothek.gui.dock.station.span.SpanMode

public class SpanMode
extends Object

A SpanMode is a default configuration telling a Span how it is used. The class offers enumeration like constants, and the default DockStations will only use these constants. Custom DockStations however may define their own SpanModes.

Author:

Benjamin Sigg

Field Summary

static SpanMode	OFF Used to disabled a Span, the span has size 0 and thus is not visible
static SpanMode	OPEN Fully opens a Span, the user sees how the layout will change when he drops a Dockable at its current position.
static SpanMode	TEASING Opens a Span just a little bit, enough for the user to see there is something happening

Constructor Summary

SpanMode(String id, int size)
Creates a new mode

Method Summary

boolean	equals(Object obj)
int	getSize() Gets the default size in pixels.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

OFF

public static final SpanMode OFF

Used to disabled a Span, the span has size 0 and thus is not visible

TEASING

public static final SpanMode TEASING

Opens a Span just a little bit, enough for the user to see there is something happening

OPEN

public static final SpanMode OPEN

Fully opens a Span, the user sees how the layout will change when he drops a Dockable at its current position.

Constructor Detail

SpanMode

public SpanMode(String id,
                int size)

Creates a new mode

Parameters:

id - the unique identifier of this mode

size - the preferred default size of this mode

Method Detail

getSize

public int getSize()

Gets the default size in pixels.

Returns:

the default size, at least 0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object