bibliothek.gui.dock.common.location

Class CFlapIndexLocation

java.lang.Object

bibliothek.gui.dock.common.CLocation

bibliothek.gui.dock.common.location.AbstractStackholdingLocation

bibliothek.gui.dock.common.location.CFlapIndexLocation

public class CFlapIndexLocation
extends AbstractStackholdingLocation

A location which represents the index on a FlapDockStation.

Author:

Benjamin Sigg

Property Summary

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

findProperty

Constructor Summary

Constructors

Constructor and Description
CFlapIndexLocation(CFlapLocation parent, int index) Creates a new location

Method Summary

Modifier and Type	Method and Description
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.
int	getIndex() Gets the exact location of this location on its parent.
CFlapLocation	getParent() Gets the parent location of this location.
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

CFlapIndexLocation

public CFlapIndexLocation(CFlapLocation parent,
                          int index)

Creates a new location

Parameters:

parent - the FlapDockStation to which this location belongs

index - the exact position of this location

Method Detail

getParent

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

getIndex

public int getIndex()

Gets the exact location of this location on its parent.

Returns:

the exact location

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

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

toString

public String toString()

Overrides:

toString in class Object