bibliothek.gui.dock.event
Interface DockRegisterListener

All Known Subinterfaces:
DockListener
All Known Implementing Classes:
ActionBinder, DockAdapter, DockRegisterAdapter, FocusController

public interface DockRegisterListener

A listener receiving events from a DockRegister.
DockRegister can be stalled and some events may have a great delay when arriving. Subclasses should be aware that the current state of the dock-tree, and the state one would get when only monitoring with DockRegisterListener, may be different.

Author:
Benjamin Sigg

Method Summary
 void dockableCycledRegister(DockController controller, Dockable dockable)
          Invoked when dockable was added and removed from the controller, or was removed and added again to controller.
 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 dockableUnregistered(DockController controller, Dockable dockable)
          Invoked after dockable has been unregistered from controller.
 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.
 

Method Detail

dockableRegistering

void dockableRegistering(DockController controller,
                         Dockable dockable)
Invoked right before the dockable is registered in the controller.

Parameters:
controller - the controller who does not yet know dockable.
dockable - the dockable who does not yet know controller.

dockStationRegistering

void dockStationRegistering(DockController controller,
                            DockStation station)
Invoked right before the station is registered in the controller.

Parameters:
controller - the controller who does not yet know station.
station - the station who does not yet know controller.

dockableRegistered

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

Parameters:
controller - the controller where dockable was added
dockable - the Dockable that was added

dockStationRegistered

void dockStationRegistered(DockController controller,
                           DockStation station)
Invoked after a DockStation was registered. This method can be called while a Dockable is dragged. See the method DockController.isOnMove().

Parameters:
controller - the controller where station was added
station - the DockStation that was added

dockableUnregistered

void dockableUnregistered(DockController controller,
                          Dockable dockable)
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().

Parameters:
controller - the controller from where dockable was removed
dockable - the removed Dockable

dockStationUnregistered

void dockStationUnregistered(DockController controller,
                             DockStation station)
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().

Parameters:
controller - the controller from where dockable was removed
station - the removed DockStation

dockableCycledRegister

void dockableCycledRegister(DockController controller,
                            Dockable dockable)
Invoked when dockable was added and removed from the controller, or was removed and added again to controller. This method is only invoked if a call to dockableRegistered(DockController, Dockable) and dockableUnregistered(DockController, Dockable) was suppressed. It is unknown whether dockable is now registered at controller.

Parameters:
controller - the controller whose register dockable cycled
dockable - some Dockable