com.vlsolutions.swing.docking.event
Class DockEvent

java.lang.Object
  extended by com.vlsolutions.swing.docking.event.DockEvent
Direct Known Subclasses:
DockDragEvent, DockDropEvent

public abstract class DockEvent
extends Object

Abstract superclass of drag and drop docking events.

This class holds a reference to the source of the event and its mouse event.


Field Summary
protected  DockingDesktop desktop
          The docking desktop
protected  MouseEvent event
          The MouseEvent, in target's coordinates
protected  DockableDragSource source
          The drag source
 
Constructor Summary
DockEvent(DockingDesktop desktop, DockableDragSource source, MouseEvent event)
          Constructor for dock events.
 
Method Summary
 DockingDesktop getDesktop()
          Returns a reference of the desktop in which the docking event takes place
 DockableDragSource getDragSource()
          Returns a reference to the drag source of this event.
 MouseEvent getMouseEvent()
          Returns the MouseEvent which is the cause of this DockEvent.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

source

protected DockableDragSource source
The drag source


desktop

protected DockingDesktop desktop
The docking desktop


event

protected MouseEvent event
The MouseEvent, in target's coordinates

Constructor Detail

DockEvent

public DockEvent(DockingDesktop desktop,
                 DockableDragSource source,
                 MouseEvent event)
Constructor for dock events.

Parameters:
source - the source of drag operation
event - the mouse event which is the cause of this DockEvent.
Method Detail

getMouseEvent

public MouseEvent getMouseEvent()
Returns the MouseEvent which is the cause of this DockEvent.

note that mouse coordinates are converted into the target's coordinates.

Returns:
a mouse event

getDragSource

public DockableDragSource getDragSource()
Returns a reference to the drag source of this event.

Returns:
the drag source (the component actually dragged)

getDesktop

public DockingDesktop getDesktop()
Returns a reference of the desktop in which the docking event takes place



© Copyright 2004-2005 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications