Package 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 Details

    • 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