bibliothek.gui.dock.facile.state
Class MaximizeSplitDockStation

java.lang.Object
  extended by bibliothek.gui.dock.facile.state.MaximizeSplitDockStation
All Implemented Interfaces:
MaximizeArea

public class MaximizeSplitDockStation
extends Object
implements MaximizeArea

A MaximizeArea which works together with a SplitDockStation.

Author:
Benjamin Sigg

Constructor Summary
MaximizeSplitDockStation(String uniqueId, SplitDockStation station)
          Creates a new area.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MaximizeSplitDockStation

public MaximizeSplitDockStation(String uniqueId,
                                SplitDockStation station)
Creates a new area.

Parameters:
uniqueId - the result of getUniqueId()
station - the result of getStation()
Method Detail

addMaximizeAreaListener

public void addMaximizeAreaListener(MaximizeAreaListener listener)
Description copied from interface: MaximizeArea
Adds a listener to this area. This listener will be informed whenever the maximized dockable changes.

Specified by:
addMaximizeAreaListener in interface MaximizeArea
Parameters:
listener - the new listener

removeMaximizeAreaListener

public void removeMaximizeAreaListener(MaximizeAreaListener listener)
Description copied from interface: MaximizeArea
Removes a listener from this area

Specified by:
removeMaximizeAreaListener in interface MaximizeArea
Parameters:
listener - the listener to remove

dropAside

public void dropAside(Dockable dockable)
Description copied from interface: MaximizeArea
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.

Specified by:
dropAside in interface MaximizeArea
Parameters:
dockable - a new element which should become child of this station

getMaximizedDockable

public Dockable getMaximizedDockable()
Description copied from interface: MaximizeArea
Gets the element which is currently maximized.

Specified by:
getMaximizedDockable in interface MaximizeArea
Returns:
the currently maximized element or null if no element is maximized

getStation

public DockStation getStation()
Description copied from interface: MaximizeArea
Gets the station which is represented by this MaximizeArea.

Specified by:
getStation in interface MaximizeArea
Returns:
the station, never null

getUniqueId

public String getUniqueId()
Description copied from interface: MaximizeArea
Gets a unique identifier for this area. The identifier must not be shared with any other area that is used by the same controller.

Specified by:
getUniqueId in interface MaximizeArea
Returns:
the unique identifier

setMaximizedDockable

public void setMaximizedDockable(Dockable dockable)
Description copied from interface: MaximizeArea
Sets the element which should be maximized. The element is always a child of the station.

Specified by:
setMaximizedDockable in interface MaximizeArea
Parameters:
dockable - the element to maximize or null if no element should be maximized