com.javadocking.drag.dockretriever
Interface DockRetriever

All Known Implementing Classes:

DynamicDockRetriever, StaticDockRetriever

public interface DockRetriever

When a dockable is dragged, a dock retriever searches the Dock under the screen location of the mouse, to which the Dockable should be added, if the mouse was released at that location.

If there are multiple docks under the mouse location, to which the dockable can be added, the dock that has the highest priority, is retrieved.

Author:

Heidi Rakels.

Method Summary

Dock[]

retrieveHighestPriorityDock(java.awt.Point screenLocation, Dockable dockable) Retrieves the dock that has the highest priority for adding the dockable, when the dockable is dragged over the given screen location.

Method Detail

retrieveHighestPriorityDock

Dock[] retrieveHighestPriorityDock(java.awt.Point screenLocation,
                                   Dockable dockable)

Retrieves the dock that has the highest priority for adding the dockable, when the dockable is dragged over the given screen location.

Parameters:

screenLocation - The location of the mouse on the screen.

dockable - The dockable that is dragged and has to be added to a new dock.

Returns:

The dock that has the highest priority for adding the dockable for the given screen location.