bibliothek.gui.dock.common.location
Class CMaximizedLocation

java.lang.Object
  extended by bibliothek.gui.dock.common.CLocation
      extended by bibliothek.gui.dock.common.location.AbstractStackholdingLocation
          extended by bibliothek.gui.dock.common.location.CMaximizedLocation

public class CMaximizedLocation
extends AbstractStackholdingLocation

A location representing the maximized state. If no root-station is set, then the location of a maximized element depends on its location before maximization.

Author:
Benjamin Sigg

Constructor Summary
CMaximizedLocation()
          Creates a new location
CMaximizedLocation(java.lang.String root)
          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.
 java.lang.String findRoot()
          Gets the name of the station this location belongs to.
 CLocation getParent()
          Gets the parent location of this location.
 java.lang.String toString()
           
 
Methods inherited from class bibliothek.gui.dock.common.location.AbstractStackholdingLocation
stack, stack
 
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

CMaximizedLocation

public CMaximizedLocation()
Creates a new location


CMaximizedLocation

public CMaximizedLocation(java.lang.String root)
Creates a new location.

Parameters:
root - the station which represents the maximize area, can be null
Method Detail

getParent

public CLocation getParent()
Description copied from class: CLocation
Gets the parent location of this location. Some root-locations may never have a parent.

Specified by:
getParent in class CLocation
Returns:
the parent location, can be null

findMode

public ExtendedMode findMode()
Description copied from class: CLocation
Gets the mode this location represents.

Specified by:
findMode in class CLocation
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.

Specified by:
findProperty in class CLocation
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 java.lang.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.

Specified by:
findRoot in class CLocation
Returns:
the name of the station or null if this location does not have enough information to find the root

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

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.

Specified by:
aside in class CLocation
Returns:
the new location