bibliothek.gui.dock.frontend

Interface DockFrontendPerspective

All Known Implementing Classes:

DefaultDockFrontendPerspective

public interface DockFrontendPerspective

Represents the layout that is created and managed by a DockFrontend, offers methods to easily modify that layout. Clients should call DockFrontend.getPerspective(boolean) to acquire an object of this type.
This interface is only a wrapper around Perspective and offers some shortcuts to implement tasks more easily, clients could also access the Perspective directly and completely ignore this object.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	apply() Applies the current layout to the DockFrontend which created this perspective.
PredefinedPerspective	getPerspective() Gets the internal representation of this layout.
PropertyTransformer	getPropertyTransformer() Gets a PropertyTransformer which is used to read and write DockablePropertys.
PerspectiveStation	getRoot(String root) Allows access to the root DockStation named root.
void	store(String name) Stores this perspective in the DockFrontend using name as key.

Method Detail

getPerspective

PredefinedPerspective getPerspective()

Gets the internal representation of this layout.

Returns:

the internal representation

getPropertyTransformer

PropertyTransformer getPropertyTransformer()

Gets a PropertyTransformer which is used to read and write DockablePropertys.

Returns:

the transformer

getRoot

PerspectiveStation getRoot(String root)

Allows access to the root DockStation named root.

Parameters:

root - the name of the station

Returns:

the root station or null if not found

apply

void apply()

Applies the current layout to the DockFrontend which created this perspective.
Please note that implementations may restrict what information is applied, specifically:

• It may not be possible to add/remove root-stations through this method.
• Invisible elements may not be touched

store

void store(String name)

Stores this perspective in the DockFrontend using name as key. The same restrictions as found in apply() may apply to this method.

Parameters:

name - the name of this layout