bibliothek.gui.dock.common.location
Class CFlapLocation

java.lang.Object
  bibliothek.gui.dock.common.CLocation
      bibliothek.gui.dock.common.location.CFlapLocation

Direct Known Subclasses:

CMinimizeAreaLocation, CMinimizedLocation

public class CFlapLocation
extends CLocation

A location which represents a FlapDockStation.

Author:

Benjamin Sigg

Constructor Summary

CFlapLocation()
Creates a new location

CFlapLocation(CLocation parent)
Creates a new location

Method Summary

CFlapIndexLocation	append() Creates a location to append children at the end of the station.
CLocation	aside() Deprecated. see CLocation.aside() for an explanation.
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.
CFlapIndexLocation	insert(int index) Creates a location to insert children into the station.
String	toString()

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

CFlapLocation

public CFlapLocation()

Creates a new location

CFlapLocation

public CFlapLocation(CLocation parent)

Creates a new location

Parameters:

parent -

Method Detail

append

public CFlapIndexLocation append()

Creates a location to append children at the end of the station.

Returns:

the location marking the last position

insert

public CFlapIndexLocation insert(int index)

Creates a location to insert children into the station.

Parameters:

index - the exact position

Returns:

a location marking the position index

getParent

public CLocation getParent()

Gets the parent location of this location.

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

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

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

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

toString

public String toString()

Overrides:

toString in class Object