bibliothek.gui.dock.common.location
Class CWorkingAreaLocation

java.lang.Object
  bibliothek.gui.dock.common.CLocation
      bibliothek.gui.dock.common.location.CSplitLocation
          bibliothek.gui.dock.common.location.CWorkingAreaLocation

public class CWorkingAreaLocation
extends CSplitLocation

A location representing a CWorkingArea.

Author:

Benjamin Sigg

Constructor Summary

CWorkingAreaLocation(CWorkingArea area)
Creates a new location.

Method Summary

CLocation	aside() Returns a CLocation that describes the location of an element that should be inserted next to this location.
ExtendedMode	findMode() Gets the mode this location represents.
DockableProperty	findProperty(DockableProperty successor) Gets a path describing this location in terms of the DockingFrames.
String	findRoot() Gets the name of the station this location belongs to.
CWorkingArea	getWorkingArea() Gets the workingarea to which this location relates.
String	toString()

Methods inherited from class bibliothek.gui.dock.common.location.CSplitLocation

east, east, getParent, north, north, rectangle, south, south, stack, stack, west, west

Methods inherited from class bibliothek.gui.dock.common.CLocation

base, base, equals, expandProperty, expandProperty, external, findProperty, hashCode, maximized, maximized, maximized, maximized, minimized, minimized, normalized, working

Methods inherited from class java.lang.Object

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

Constructor Detail

CWorkingAreaLocation

public CWorkingAreaLocation(CWorkingArea area)

Creates a new location.

Parameters:

area - the area which is represented by this location

Method Detail

getWorkingArea

public CWorkingArea getWorkingArea()

Gets the workingarea to which this location relates.

Returns:

the area or null if the default center is meant.

aside

public CLocation aside()

Description copied from class: CLocation

Returns a CLocation that describes the location of an element that should be inserted next to this location.

Overrides:

aside in class CSplitLocation

Returns:

the new location

findMode

public ExtendedMode findMode()

Description copied from class: CLocation

Gets the mode this location represents.

Overrides:

findMode in class CSplitLocation

Returns:

the mode or null

findProperty

public DockableProperty findProperty(DockableProperty successor)

Description copied from class: CLocation

Gets a path describing this location in terms of the DockingFrames.

Overrides:

findProperty in class CSplitLocation

Parameters:

successor - the path of the elements above this location or null

Returns:

the path to this location or null, can also be successor

findRoot

public String findRoot()

Description copied from class: CLocation

Gets the name of the station this location belongs to. This can be the id of any CStation.

Overrides:

findRoot in class CSplitLocation

Returns:

the name of the station or null if this location does not have enough information to find the root

toString

public String toString()

Overrides:

toString in class CSplitLocation