bibliothek.gui.dock.facile.state
Interface MaximizeArea

All Known Implementing Classes:
MaximizeSplitDockStation

public interface MaximizeArea

A wrapper around a DockStation, this wrapper marks a station as beeing able to show a maximized Dockable.

Author:
Benjamin Sigg

Method Summary
 void addMaximizeAreaListener(MaximizeAreaListener listener)
          Adds a listener to this area.
 void dropAside(Dockable dockable)
          Somehow makes dockable child of this station.
 Dockable getMaximizedDockable()
          Gets the element which is currently maximized.
 DockStation getStation()
          Gets the station which is represented by this MaximizeArea.
 String getUniqueId()
          Gets a unique identifier for this area.
 void removeMaximizeAreaListener(MaximizeAreaListener listener)
          Removes a listener from this area
 void setMaximizedDockable(Dockable dockable)
          Sets the element which should be maximized.
 

Method Detail

getUniqueId

String getUniqueId()
Gets a unique identifier for this area. The identifier must not be shared with any other area that is used by the same controller.

Returns:
the unique identifier

getStation

DockStation getStation()
Gets the station which is represented by this MaximizeArea.

Returns:
the station, never null

addMaximizeAreaListener

void addMaximizeAreaListener(MaximizeAreaListener listener)
Adds a listener to this area. This listener will be informed whenever the maximized dockable changes.

Parameters:
listener - the new listener

removeMaximizeAreaListener

void removeMaximizeAreaListener(MaximizeAreaListener listener)
Removes a listener from this area

Parameters:
listener - the listener to remove

dropAside

void dropAside(Dockable dockable)
Somehow makes dockable child of this station. This method should add dockable at a place were it can be removed without destroying the original layout.

Parameters:
dockable - a new element which should become child of this station

setMaximizedDockable

void setMaximizedDockable(Dockable dockable)
Sets the element which should be maximized. The element is always a child of the station.

Parameters:
dockable - the element to maximize or null if no element should be maximized

getMaximizedDockable

Dockable getMaximizedDockable()
Gets the element which is currently maximized.

Returns:
the currently maximized element or null if no element is maximized