bibliothek.gui.dock.common.perspective.mode
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
 ExtendedMode getIdentifier()
          Gets the unique identifier for this mode.
 boolean isCurrentMode(PerspectiveDockable dockable)
          Checks whether dockable currently is in this mode.
 void readSetting(ModeSetting<Location> setting)
          Reads settings belonging to this mode from setting.
 void setPerspective(CPerspective perspective)
          Informs this mode of what perspective is going to use it.
 void writeSetting(ModeSetting<Location> setting)
          Writes settings that belong to this mode to setting.
 

Method Detail

setPerspective

void setPerspective(CPerspective perspective)
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

boolean isCurrentMode(PerspectiveDockable dockable)
Checks whether dockable currently is in this mode.

Parameters:
dockable - the element whose mode is searched
Returns:
true if this mode describes the situation of dockable

readSetting

void readSetting(ModeSetting<Location> setting)
Reads settings belonging to this mode from setting.

Parameters:
setting - some settings

writeSetting

void writeSetting(ModeSetting<Location> setting)
Writes settings that belong to this mode to setting.

Parameters:
setting - the settings to write