bibliothek.gui.dock.event
Class DockAdapter

java.lang.Object
  extended by bibliothek.gui.dock.event.DockAdapter
All Implemented Interfaces:
DockableListener, DockControllerListener, DockRegisterListener, DockRelocatorListener, DockStationListener
Direct Known Subclasses:
DefaultDockRelocator.TitleListener, DockController.TitleListener, FullScreenClickableListener

public abstract class DockAdapter
extends java.lang.Object
implements DockableListener, DockControllerListener, DockStationListener

An abstract implementation of DockableListener, DockStationListener and DockControllerListener. All methods of this class are empty. This class can be used if one or more of the mentioned interfaces should be implemented, but only a few methods have actually to do something

Author:
Benjamin Sigg

Constructor Summary
DockAdapter()
           
 
Method Summary
 void dockableAdded(DockStation station, Dockable dockable)
          Invoked after dockable has been added to station.
 void dockableAdding(DockStation station, Dockable dockable)
          Invoked before dockable is added to station.
 void dockableDrag(DockController controller, Dockable dockable, DockStation station)
          Invoked before a Dockable is moved around.
 void dockableFocused(DockController controller, Dockable dockable)
          Invoked when dockable has gained the focus.
 void dockablePut(DockController controller, Dockable dockable, DockStation station)
          Invoked after a Dockable was moved.
 void dockableRegistered(DockController controller, Dockable dockable)
          Invoked after a Dockable was registered.
 void dockableRegistering(DockController controller, Dockable dockable)
          Invoked right before the dockable is registered in the controller.
 void dockableRemoved(DockStation station, Dockable dockable)
          Invoked after dockable has been removed from station.
 void dockableRemoving(DockStation station, Dockable dockable)
          Invoked before dockable is removed from station.
 void dockableUnregistered(DockController controller, Dockable dockable)
          Invoked after dockable has been unregistered from controller.
 void dockableVisibiltySet(DockStation station, Dockable dockable, boolean visible)
          Invoked if the visibility of a child has been changed.
 void dockStationRegistered(DockController controller, DockStation station)
          Invoked after a DockStation was registered.
 void dockStationRegistering(DockController controller, DockStation station)
          Invoked right before the station is registered in the controller.
 void dockStationUnregistered(DockController controller, DockStation station)
          Invoked after station has been unregistered from controller.
 void titleBinded(Dockable dockable, DockTitle title)
          Will be invoked when a DockTitle was binded to a Dockable.
 void titleBinded(DockController controller, DockTitle title, Dockable dockable)
          Called when title was binded to dockable.
 void titleIconChanged(Dockable dockable, javax.swing.Icon oldIcon, javax.swing.Icon newIcon)
          Invoked when the title-icon of a Dockable has changed
 void titleTextChanged(Dockable dockable, java.lang.String oldTitle, java.lang.String newTitle)
          Invoked when the title of a Dockable has changed.
 void titleUnbinded(Dockable dockable, DockTitle title)
          Will be invoked when a DockTitle was unbinded from a Dockable.
 void titleUnbinded(DockController controller, DockTitle title, Dockable dockable)
          Called when title was unbinded from dockable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DockAdapter

public DockAdapter()
Method Detail

titleBinded

public void titleBinded(Dockable dockable,
                        DockTitle title)
Description copied from interface: DockableListener
Will be invoked when a DockTitle was binded to a Dockable.

Specified by:
titleBinded in interface DockableListener
Parameters:
dockable - the Dockable whose title is set
title - the new title

titleIconChanged

public void titleIconChanged(Dockable dockable,
                             javax.swing.Icon oldIcon,
                             javax.swing.Icon newIcon)
Description copied from interface: DockableListener
Invoked when the title-icon of a Dockable has changed

Specified by:
titleIconChanged in interface DockableListener
Parameters:
dockable - the Dockable whose title is changed
oldIcon - the old icon, may be null
newIcon - the new icon, may be null

titleTextChanged

public void titleTextChanged(Dockable dockable,
                             java.lang.String oldTitle,
                             java.lang.String newTitle)
Description copied from interface: DockableListener
Invoked when the title of a Dockable has changed.

Specified by:
titleTextChanged in interface DockableListener
Parameters:
dockable - the Dockable whose title is changed
oldTitle - the title before the change
newTitle - the title after the change

titleUnbinded

public void titleUnbinded(Dockable dockable,
                          DockTitle title)
Description copied from interface: DockableListener
Will be invoked when a DockTitle was unbinded from a Dockable.

Specified by:
titleUnbinded in interface DockableListener
Parameters:
dockable - the Dockable whose title was removed
title - the remove title

dockStationUnregistered

public void dockStationUnregistered(DockController controller,
                                    DockStation station)
Description copied from interface: DockRegisterListener
Invoked after station has been unregistered from controller. Note that this method can be invoked while a Dockable is dragged, use the method DockController.isOnMove().

Specified by:
dockStationUnregistered in interface DockRegisterListener
Parameters:
controller - the controller from whom dockable was removed
station - the removed DockStation

dockStationRegistered

public void dockStationRegistered(DockController controller,
                                  DockStation station)
Description copied from interface: DockRegisterListener
Invoked after a DockStation was registered. This method can be called while a Dockable is dragged. See the method DockController.isOnMove().

Specified by:
dockStationRegistered in interface DockRegisterListener
Parameters:
controller - the controller where station was added
station - the DockStation that was added

dockStationRegistering

public void dockStationRegistering(DockController controller,
                                   DockStation station)
Description copied from interface: DockRegisterListener
Invoked right before the station is registered in the controller.

Specified by:
dockStationRegistering in interface DockRegisterListener
Parameters:
controller - the controller who does not yet know station.
station - the station who does not yet know controller.

dockableUnregistered

public void dockableUnregistered(DockController controller,
                                 Dockable dockable)
Description copied from interface: DockRegisterListener
Invoked after dockable has been unregistered from controller. Note that this method can be invoked while a Dockable is dragged, use the method DockController.isOnMove().

Specified by:
dockableUnregistered in interface DockRegisterListener
Parameters:
controller - the controller from whom dockable was removed
dockable - the removed Dockable

dockableDrag

public void dockableDrag(DockController controller,
                         Dockable dockable,
                         DockStation station)
Description copied from interface: DockRelocatorListener
Invoked before a Dockable is moved around. This method is called after the user has released the mouse which was dragging a DockTitle around.

Specified by:
dockableDrag in interface DockRelocatorListener
Parameters:
controller - the origin of the event
dockable - the Dockable which was dragged
station - the future parent of dockable
See Also:
DockRelocatorListener.dockablePut(DockController, Dockable, DockStation)

dockableFocused

public void dockableFocused(DockController controller,
                            Dockable dockable)
Description copied from interface: DockControllerListener
Invoked when dockable has gained the focus.

Specified by:
dockableFocused in interface DockControllerListener
Parameters:
controller - the origin of the event
dockable - the Dockable which is now focused

dockablePut

public void dockablePut(DockController controller,
                        Dockable dockable,
                        DockStation station)
Description copied from interface: DockRelocatorListener
Invoked after a Dockable was moved.

Specified by:
dockablePut in interface DockRelocatorListener
Parameters:
controller - the origin of the event
dockable - the Dockable which was dragged
station - the new parent of dockable
See Also:
DockRelocatorListener.dockableDrag(DockController, Dockable, DockStation)

dockableRegistered

public void dockableRegistered(DockController controller,
                               Dockable dockable)
Description copied from interface: DockRegisterListener
Invoked after a Dockable was registered. Note that this method can be called while a Dockable is dragged. See the method DockController.isOnMove().

Specified by:
dockableRegistered in interface DockRegisterListener
Parameters:
controller - the controller where dockable was added
dockable - the Dockable that was added

dockableRegistering

public void dockableRegistering(DockController controller,
                                Dockable dockable)
Description copied from interface: DockRegisterListener
Invoked right before the dockable is registered in the controller.

Specified by:
dockableRegistering in interface DockRegisterListener
Parameters:
controller - the controller who does not yet know dockable.
dockable - the dockable who does not yet know controller.

titleBinded

public void titleBinded(DockController controller,
                        DockTitle title,
                        Dockable dockable)
Description copied from interface: DockControllerListener
Called when title was binded to dockable. This method is called after the DockTitle.bind()-method was invoked.

Specified by:
titleBinded in interface DockControllerListener
Parameters:
controller - the origin of the event
title - the DockTitle that was binded
dockable - the owner of title

titleUnbinded

public void titleUnbinded(DockController controller,
                          DockTitle title,
                          Dockable dockable)
Description copied from interface: DockControllerListener
Called when title was unbinded from dockable. This method is called after the DockTitle.bind()-method was invoked.

Specified by:
titleUnbinded in interface DockControllerListener
Parameters:
controller - the origin of the event
title - the DockTitle which was unbinded
dockable - the old owner of title

dockableAdded

public void dockableAdded(DockStation station,
                          Dockable dockable)
Description copied from interface: DockStationListener
Invoked after dockable has been added to station.

Specified by:
dockableAdded in interface DockStationListener
Parameters:
station - the station where the new child was added
dockable - the new child

dockableAdding

public void dockableAdding(DockStation station,
                           Dockable dockable)
Description copied from interface: DockStationListener
Invoked before dockable is added to station.

Specified by:
dockableAdding in interface DockStationListener
Parameters:
station - the station where the new child will be added
dockable - the new child

dockableRemoved

public void dockableRemoved(DockStation station,
                            Dockable dockable)
Description copied from interface: DockStationListener
Invoked after dockable has been removed from station.

Specified by:
dockableRemoved in interface DockStationListener
Parameters:
station - the station where the old child was removed
dockable - the old child

dockableRemoving

public void dockableRemoving(DockStation station,
                             Dockable dockable)
Description copied from interface: DockStationListener
Invoked before dockable is removed from station.

Specified by:
dockableRemoving in interface DockStationListener
Parameters:
station - the station where the old child will be removed
dockable - the old child

dockableVisibiltySet

public void dockableVisibiltySet(DockStation station,
                                 Dockable dockable,
                                 boolean visible)
Description copied from interface: DockStationListener
Invoked if the visibility of a child has been changed. The visibility has to be implemented in a global scale. Callers may use the class DockableVisibilityManager to organize the calls in an easy way.

Specified by:
dockableVisibiltySet in interface DockStationListener
Parameters:
station - the station whose children have changed their visibility
dockable - the Dockable whose visibility has changed
visible - the new visibility-state