Interface LocationModePerspective
- All Known Implementing Classes:
AbstractModePerspective,CExternalizedModePerspective,CMaximizedModePerspective,CMinimizedModePerspective,CNormalModePerspective
public interface LocationModePerspective
Represents a
CLocationMode in a perspective.- Author:
- Benjamin Sigg
-
Method Summary
Modifier and TypeMethodDescriptionGets the unique identifier for this mode.booleanisCurrentMode(PerspectiveDockable dockable) Checks whetherdockablecurrently is inthismode.booleanisCurrentMode(String root, DockableProperty location) Checks whether the dockable at locationroot/locationshould be in the mode represented bythis.voidreadSetting(ModeSetting<Location> setting) Reads settings belonging to this mode fromsetting.voidsetPerspective(CPerspective perspective) Informs this mode of what perspective is going to use it.voidwriteSetting(ModeSetting<Location> setting) Writes settings that belong to this mode tosetting.
-
Method Details
-
setPerspective
Informs this mode of what perspective is going to use it.- Parameters:
perspective- the perspective that uses this mode
-
getIdentifier
ExtendedMode getIdentifier()Gets the unique identifier for this mode.- Returns:
- the unique identifier, not
null
-
isCurrentMode
Checks whetherdockablecurrently is inthismode.- Parameters:
dockable- the element whose mode is searched- Returns:
trueif this mode describes the situation ofdockable
-
isCurrentMode
Checks whether the dockable at locationroot/locationshould be in the mode represented bythis.- Parameters:
root- the unique identifer of the rootDockStationlocation- the location on the root station- Returns:
- whether a dockable in this mode can have the described location
-
readSetting
Reads settings belonging to this mode fromsetting.- Parameters:
setting- some settings
-
writeSetting
Writes settings that belong to this mode tosetting.- Parameters:
setting- the settings to write
-