bibliothek.gui.dock.common.mode
Class CExternalizedMode

java.lang.Object
  extended by bibliothek.gui.dock.facile.mode.AbstractLocationMode<A>
      extended by bibliothek.gui.dock.facile.mode.DefaultLocationMode<M>
          extended by bibliothek.gui.dock.facile.mode.ExternalizedMode<CExternalizedModeArea>
              extended by bibliothek.gui.dock.common.mode.CExternalizedMode
All Implemented Interfaces:
CLocationMode, LocationMode, Mode<Location>, Iterable<CExternalizedModeArea>

public class CExternalizedMode
extends ExternalizedMode<CExternalizedModeArea>
implements CLocationMode

Manages areas on which externalized dockables are shown.

Author:
Benjamin Sigg

Nested Class Summary
 
Nested classes/interfaces inherited from class bibliothek.gui.dock.facile.mode.AbstractLocationMode
AbstractLocationMode.DockableHandle
 
Field Summary
 
Fields inherited from class bibliothek.gui.dock.facile.mode.ExternalizedMode
ICON_IDENTIFIER, IDENTIFIER
 
Constructor Summary
CExternalizedMode(CControl control)
          Creates a new mode.
 
Method Summary
 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 class bibliothek.gui.dock.facile.mode.ExternalizedMode
ensureNotHidden, getExtendedMode, getSettingFactory, getUniqueIdentifier, isDefaultMode, readSetting, runApply, writeSetting
 
Methods inherited from class bibliothek.gui.dock.facile.mode.DefaultLocationMode
current, isCurrentMode
 
Methods inherited from class bibliothek.gui.dock.facile.mode.AbstractLocationMode
add, addLocationModeListener, apply, createHandle, get, get, get, getActionsFor, getController, getDefaultArea, getManager, getRepresentation, isModeAvailable, isRepresenting, iterator, listeners, remove, removeLocationModeListener, setActionProvider, setController, setDefaultArea, setManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface bibliothek.gui.dock.facile.mode.LocationMode
addLocationModeListener, ensureNotHidden, getExtendedMode, getManager, getRepresentation, isCurrentMode, isRepresenting, removeLocationModeListener, setController, setManager
 
Methods inherited from interface bibliothek.gui.dock.support.mode.Mode
apply, current, getActionsFor, getSettingFactory, getUniqueIdentifier, isDefaultMode, readSetting, writeSetting
 

Constructor Detail

CExternalizedMode

public CExternalizedMode(CControl control)
Creates a new mode.

Parameters:
control - the owner of this mode
Method Detail

getCLocation

public CLocation getCLocation(Dockable dockable)
Description copied from interface: CLocationMode
Gets the location of dockable which is in this mode.

Specified by:
getCLocation in interface CLocationMode
Parameters:
dockable - the element whose location is asked
Returns:
the location or null if it cannot be determined

getCLocation

public CLocation getCLocation(Dockable dockable,
                              Location location)
Description copied from interface: CLocationMode
Gets the location of dockable which might or might not be a child of this mode.

Specified by:
getCLocation in interface CLocationMode
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

public boolean isBasicMode()
Description copied from interface: CLocationMode
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.

Specified by:
isBasicMode in interface CLocationMode
Returns:
true if this is a basic mode

respectWorkingAreas

public boolean respectWorkingAreas(DockStation station)
Description copied from interface: CLocationMode
Tells whether Dockables which have this mode applied should respect the settings for CWorkingAreas.

Specified by:
respectWorkingAreas in interface CLocationMode
Parameters:
station - the station which is the parent of the Dockables
Returns:
true if the settings should be respected, false otherwise