bibliothek.gui.dock.common.location

Class CExtendedModeLocation

java.lang.Object

bibliothek.gui.dock.common.CLocation

bibliothek.gui.dock.common.location.CExtendedModeLocation

public class CExtendedModeLocation
extends CLocation

This location represents an ExtendedMode. Using this location on a CDockable is equivalent of calling CDockable.setExtendedMode(bibliothek.gui.dock.common.mode.ExtendedMode).

Author:

Benjamin Sigg

Property Summary

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

findProperty

Constructor Summary

Constructors

Constructor and Description
CExtendedModeLocation(ExtendedMode mode) Creates a new location.

Method Summary

Modifier and Type	Method and Description
CLocation	aside() Deprecated. see CLocation.aside() for an explanation.
CLocation	expandProperty(DockableProperty property, CLocationExpandStrategy strategy) Tries to create a location that resembles property.
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.
CLocation	getParent() Gets the parent location of this location.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CExtendedModeLocation

public CExtendedModeLocation(ExtendedMode mode)

Creates a new location.

Parameters:

mode - the mode this location represents, not 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

aside

@Deprecated
public CLocation aside()

Deprecated. see CLocation.aside() for an explanation.

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

expandProperty

public CLocation expandProperty(DockableProperty property,
                                CLocationExpandStrategy strategy)

Description copied from class: CLocation

Tries to create a location that resembles property.

Overrides:

expandProperty in class CLocation

Parameters:

property - some location

strategy - a strategy helping to convert the properties

Returns:

a location whose CLocation.findProperty() would create property again, or null in case that property can't be used

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 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