bibliothek.gui.dock.control.relocator

Interface VetoableDockRelocatorListener

All Known Implementing Classes:

VetoableDockRelocatorAdapter

public interface VetoableDockRelocatorListener

This listener can be added to a DockRelocator and will receive an event whenever the user, a RemoteRelocator or a DirectRemoteRelocator moves around a Dockable.
Note: this listener is intended to monitor the users actions. This listener will never be informed about events that are triggered indirectly or by the client itself. It must not be used to keep track of the layout of the entire application, DockRegisterListener and DockHierarchyListeners are much better fit for that job.
A successful drag and drop operation of a Dockable will cause these events:

1. grabbing(DockRelocatorEvent) right before the operation starts.
2. grabbed(DockRelocatorEvent) once the operation started.
3. searched(DockRelocatorEvent) every time when the user moves the mouse.
4. dropping(DockRelocatorEvent) once the user released the mouse and the Dockable is about to change its position.
5. optional: dragging(DockRelocatorEvent) before the Dockable is removed from its current parent.
6. optional: dragged(DockRelocatorEvent) if the Dockable was removed from its parent.
7. dropped(DockRelocatorEvent) once the operation completed.

Other combinations of these event may happen in the future. The event canceled(DockRelocatorEvent) may be called at any time.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	canceled(DockRelocatorEvent event) Called if a drag and drop operation was canceled due to any reason.
void	dragged(DockRelocatorEvent event) Called after the Dockable was removed from its parent.
void	dragging(DockRelocatorEvent event) Called before the Dockable is removed from its parent.
void	dropped(DockRelocatorEvent event) Called after a drag and drop operation finished.
void	dropping(DockRelocatorEvent event) Called when the user released the mouse, but the Dockable was not yet moved.
void	grabbed(DockRelocatorEvent event) Called when the drag and drop operation started, after this method was invoked visible indicators for the user will start to appear.
void	grabbing(DockRelocatorEvent event) Called before the drag and drop operations starts, the user is already pressing the mouse, but there are no visible indicators of the operation yet.
void	searched(DockRelocatorEvent event) Called after the mouse has moved, the Dockable may have a new target DockStation.

Method Detail

grabbing

void grabbing(DockRelocatorEvent event)

Called before the drag and drop operations starts, the user is already pressing the mouse, but there are no visible indicators of the operation yet.

Parameters:

event - further description of the event

grabbed

void grabbed(DockRelocatorEvent event)

Called when the drag and drop operation started, after this method was invoked visible indicators for the user will start to appear.

Parameters:

event - further description of the event

searched

void searched(DockRelocatorEvent event)

Called after the mouse has moved, the Dockable may have a new target DockStation.

Parameters:

event - further description

dropping

void dropping(DockRelocatorEvent event)

Called when the user released the mouse, but the Dockable was not yet moved. After the drop operation completed the Dockable will either be a child of the target station, of its current parent or has no parent at all.

Parameters:

event - further description of the event

dragging

void dragging(DockRelocatorEvent event)

Called before the Dockable is removed from its parent. This event may even be called, if the future parent of the Dockable is identical to the current parent.

Parameters:

event - further description of the event

dragged

void dragged(DockRelocatorEvent event)

Called after the Dockable was removed from its parent. It is possible that the Dockable already has a new parent. It is even possible that the new parent is the old parent. This event can neither be canceled nor forbidden.

Parameters:

event - further description

dropped

void dropped(DockRelocatorEvent event)

Called after a drag and drop operation finished. The Dockable was moved by the operation. Please note that the actual parent of the Dockable does not have to be the target station. This event can neither be canceled nor forbidden.

Parameters:

event - further description of the event

canceled

void canceled(DockRelocatorEvent event)

Called if a drag and drop operation was canceled due to any reason.

Parameters:

event - further description of the event