com.javadocking.drag.dockretriever
Class DynamicDockRetriever

java.lang.Object
  com.javadocking.drag.dockretriever.DynamicDockRetriever

All Implemented Interfaces:

DockRetriever

public class DynamicDockRetriever
extends java.lang.Object
implements DockRetriever

This is the default dock retriever. The dock is searched in the DockModel of the DockingManager. First a dock is searched that has the same owner window as the dock where the dockable comes from. If there is not such a dock under the mouse location, docks with other owner windows are tried.

The possible docks that are used in the dock model:

• should inherit from the java.awt.Component class,
• or should be a FloatDock.
  Other type of docks will not be found by this retriever.

  Author:

  Heidi Rakels.

  Constructor Summary

  DynamicDockRetriever()
  

  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.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Constructor Detail

  DynamicDockRetriever

  public DynamicDockRetriever()

  Method Detail

  retrieveHighestPriorityDock

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

  Description copied from interface: DockRetriever

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

  Specified by:

  retrieveHighestPriorityDock in interface DockRetriever

  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.