pub.vlsolutions.swing.docking

Interface DockableDragSource

All Known Implementing Classes:

DockableStoreButton, DockTabbedPane, DockViewAsTab.TabHeader, DockViewTitleBar, MaximizedDockViewAsTab.MaximizedTabHeader

public interface DockableDragSource

An interface implemented by visual components used for drag and drop operations on a DockableContainer.

This interface is used by API Extenders to create new kind of drag sources.

A "Drag Source" is a component, linked to a Dockable, responsible for drag gesture recognition. There can be more than one DockableDragSource per Dockable.

For example, the title bar of a docked component is usually the drag source of this component (meaning : when a user drags the title bar, he expects the dockable to be dragged around).

These draggable components must be able to give informations about their target (the component known to the user, which is actually dragged).

Version:

1.0

Author:

Lilian Chamontin, vlsolutions.

Method Summary

Methods

Modifier and Type	Method and Description
void	endDragComponent(boolean dropped) notifies the source when the drag operation has ended (by a drop or cancelled)
Dockable	getDockable() Returns the Dockable component this source is for
java.awt.Container	getDockableContainer() returns the DockableContainer responsible for displaying the associated dockable
boolean	startDragComponent(java.awt.Point p) Notifies this source that a drag operation has begun.

Method Detail

startDragComponent

boolean startDragComponent(java.awt.Point p)

Notifies this source that a drag operation has begun.

The source may reject the drag according to internal conditions (in that case this method shall return false) or to wrong mouse position .

Returns:

true if drag operation is accepted (i.e the zone pointed by p refers to a draggable component), false otherwise.

getDockable

Dockable getDockable()

Returns the Dockable component this source is for

getDockableContainer

java.awt.Container getDockableContainer()

returns the DockableContainer responsible for displaying the associated dockable

endDragComponent

void endDragComponent(boolean dropped)

notifies the source when the drag operation has ended (by a drop or cancelled)

Since:

2.1.3