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 abstract class CFlapLocation
extends CLocation

A location which represents a FlapDockStation.

Author:

Benjamin Sigg

Constructor Summary

CFlapLocation()

Method Summary

CFlapIndexLocation	append() Creates a location to append children at the end of the station.
CLocation	aside() Returns a CLocation that describes the location of an element that should be inserted next to this location.
CLocation	expandProperty(DockableProperty property) 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.
CFlapIndexLocation	insert(int index) Creates a location to insert children into the station.

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

base, base, external, findProperty, findRoot, maximized, maximized, maximized, maximized, minimized, minimized, normalized, working

Methods inherited from class java.lang.Object

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

Constructor Detail

CFlapLocation

public CFlapLocation()

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

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

expandProperty

public CLocation expandProperty(DockableProperty property)

Description copied from class: CLocation

Tries to create a location that resembles property.

Specified by:

expandProperty in class CLocation

Parameters:

property - some location

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