com.javadocking.drag.painter
Class LabelDockableDragPainter

java.lang.Object
  com.javadocking.drag.painter.LabelDockableDragPainter

All Implemented Interfaces:

DockableDragPainter

public class LabelDockableDragPainter
extends java.lang.Object
implements DockableDragPainter

This dockable drag painter shows a window with the title of the dockable at the current mouse position, when the dockable is dragged. This window is also visible outside the owner window. The dock cursor or cannotdock cursor is shown on the window. TODO dispose the window

Author:

Heidi Rakels.

Constructor Summary

LabelDockableDragPainter()
Constructs a dockable drag painter that shows a window with the title of the dockable at the current mouse position, when the dockable is dragged.

Method Summary

void	clear() Clears everything what was painted by this painter before.
int	getVerticalShift() Gets how much the label is shifted from the mouse in the vertical direction.
void	paintDockableDrag(Dockable newDockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock) Paints a dockable during dragging.
void	setVerticalShift(int verticalShift) Sets how much the label is shifted from the mouse in the vertical direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelDockableDragPainter

public LabelDockableDragPainter()

Constructs a dockable drag painter that shows a window with the title of the dockable at the current mouse position, when the dockable is dragged.

Method Detail

clear

public void clear()

Description copied from interface: DockableDragPainter

Clears everything what was painted by this painter before.

Specified by:

clear in interface DockableDragPainter

paintDockableDrag

public void paintDockableDrag(Dockable newDockable,
                              Dock dock,
                              java.awt.Rectangle rectangle,
                              java.awt.Point locationInDestinationDock)

Description copied from interface: DockableDragPainter

Paints a dockable during dragging.

Usually a rectangle is painted. It shows where the dockable will be docked in the dock, if the mouse would be released at the current mouse position.

Specified by:

paintDockableDrag in interface DockableDragPainter

Parameters:

newDockable - The dockable that will be painted.

dock - The dock in which the dockable can be docked.

rectangle - The rectangle that defines, where the given dockable will be docked, if the mouse is released at the current mouse position. The position of the rectangle is relative to the given dock.

locationInDestinationDock - The position of the mouse relative to the given dock.

getVerticalShift

public int getVerticalShift()

Gets how much the label is shifted from the mouse in the vertical direction.

Returns:

How much the label is shifted from the mouse in the vertical direction.

setVerticalShift

public void setVerticalShift(int verticalShift)

Sets how much the label is shifted from the mouse in the vertical direction.

Parameters:

verticalShift - How much the label is shifted from the mouse in the vertical direction.