com.vlsolutions.swing.docking.event
Class DockEvent
java.lang.Object
com.vlsolutions.swing.docking.event.DockEvent
public abstract class DockEvent
extends java.lang.Object
Abstract superclass of drag and drop docking events.
This class holds a reference to the source of the event and its mouse event.
action
protected DockingActionEvent action
The action corresponding to the drag and drop gesture
(actions can be seen as allowed docking gestures)
desktop
protected DockingDesktop desktop
The docking desktop which is the destination of the drag and drop gesture
event
protected MouseEvent event
The MouseEvent, in target's coordinates
DockEvent
public DockEvent(DockingDesktop targetDesktop,
DockableDragSource source,
MouseEvent event)
Constructor for dock events.
targetDesktop
- the desktop which will receive the dropsource
- the source of drag operationevent
- the mouse event which is the cause of this DockEvent.
getDesktop
public DockingDesktop getDesktop()
Returns a reference of the desktop in which the docking event takes place.
As of version 2.1, this method returns the "target" desktop (the one in which the drop will occur)
To get a reference of the "source" desktop, use the DockableState information provided by
the DockingContext.
getDockingAction
public DockingActionEvent getDockingAction()
Returns the DockingActionEvent corresponding to the drag and drop gesture
getDragSource
public DockableDragSource getDragSource()
Returns a reference to the drag source of this event.
- the drag source (the component actually dragged)
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.
setDockingAction
public void setDockingAction(DockingActionEvent actionEvent)
Set the docking action corresponding to this drag and drop gesture.
© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications