bibliothek.gui.dock.common.mode

Interface CLocationMode

All Superinterfaces:

LocationMode, Mode<Location>

All Known Implementing Classes:

CExternalizedMode, CMaximizedMode, CMinimizedMode, CNormalMode

public interface CLocationMode
extends LocationMode

LocationMode offering methods to work with CLocation.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
LocationModePerspective	createPerspective() Gets an object that represents this type of mode in a CPerspective.
CLocation	getCLocation(Dockable dockable) Gets the location of dockable which is in this mode.
CLocation	getCLocation(Dockable dockable, Location location) Gets the location of dockable which might or might not be a child of this mode.
boolean	isBasicMode() Tells whether this mode is a basic mode or not.
boolean	respectWorkingAreas(DockStation station) Tells whether Dockables which have this mode applied should respect the settings for CWorkingAreas.

Methods inherited from interface bibliothek.gui.dock.facile.mode.LocationMode

addLocationModeListener, aside, ensureNotHidden, getExtendedMode, getManager, getRepresentation, getRepresentationIds, isCurrentMode, isRepresenting, removeLocationModeListener, setController, setManager, shouldAutoFocus

Methods inherited from interface bibliothek.gui.dock.support.mode.Mode

apply, current, getActionsFor, getSettingFactory, getUniqueIdentifier, isDefaultMode, readSetting, writeSetting

Method Detail

getCLocation

CLocation getCLocation(Dockable dockable)

Gets the location of dockable which is in this mode.

Parameters:

dockable - the element whose location is asked

Returns:

the location or null if it cannot be determined

getCLocation

CLocation getCLocation(Dockable dockable,
                       Location location)

Gets the location of dockable which might or might not be a child of this mode.

Parameters:

dockable - the element

location - the location dockable is supposed to be in if in this mode.

Returns:

the location or null if it cannot be determined

isBasicMode

boolean isBasicMode()

Tells whether this mode is a basic mode or not. There are basic and advanced modes. A basic and an advanced mode may share the same representation (the same DockStations), but if in doubt the basic mode has more weight.

Returns:

true if this is a basic mode

respectWorkingAreas

boolean respectWorkingAreas(DockStation station)

Tells whether Dockables which have this mode applied should respect the settings for CWorkingAreas.

Parameters:

station - the station which is the parent of the Dockables

Returns:

true if the settings should be respected, false otherwise

createPerspective

LocationModePerspective createPerspective()

Gets an object that represents this type of mode in a CPerspective.

Returns:

the perspective version of this