net.infonode.docking.drag

Interface DockingWindowDragger

public interface DockingWindowDragger

Handles the drag and drop of a {@link DockingWindow}. Note the the drag operation MUST be terminated using either {@link #abortDrag()} or {@link #dropWindow(MouseEvent)}.

Since: IDW 1.3.0

Version: $Revision: 1.6 $

Author: $Author: jesper $

Method Summary
voidabortDrag()
Aborts this drag operation.
voiddragWindow(MouseEvent mouseEvent)
Drags the window to a new location.
voiddropWindow(MouseEvent mouseEvent)
Drops the window at the specified location.
DockingWindowgetDragWindow()
The window that is dragged and dropped.
RootWindowgetDropTarget()
Returns the {@link RootWindow} where the window can be dropped.

Method Detail

abortDrag

public void abortDrag()
Aborts this drag operation.

dragWindow

public void dragWindow(MouseEvent mouseEvent)
Drags the window to a new location. The location is relative to the {@link RootWindow} in where it should be dropped, see {@link #getDropTarget()}.

Parameters: mouseEvent the mouse event that caused the drag

dropWindow

public void dropWindow(MouseEvent mouseEvent)
Drops the window at the specified location.

Parameters: mouseEvent the mouse event that caused the drop

getDragWindow

public DockingWindow getDragWindow()
The window that is dragged and dropped.

Returns: the window that is dragged and dropped.

getDropTarget

public RootWindow getDropTarget()
Returns the {@link RootWindow} where the window can be dropped.

Returns: the {@link RootWindow} where the window can be dropped