01: /*
02: * Copyright (C) 2004 NNL Technology AB
03: * Visit www.infonode.net for information about InfoNode(R)
04: * products and how to contact NNL Technology AB.
05: *
06: * This program is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU General Public License
08: * as published by the Free Software Foundation; either version 2
09: * of the License, or (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19: * MA 02111-1307, USA.
20: */
21:
22: // $Id: DockingWindowDragger.java,v 1.6 2005/02/16 11:28:14 jesper Exp $
23: package net.infonode.docking.drag;
24:
25: import net.infonode.docking.DockingWindow;
26: import net.infonode.docking.RootWindow;
27:
28: import java.awt.event.MouseEvent;
29:
30: /**
31: * Handles the drag and drop of a {@link DockingWindow}. Note the the drag operation MUST be terminated using either
32: * {@link #abortDrag()} or {@link #dropWindow(MouseEvent)}.
33: *
34: * @author $Author: jesper $
35: * @version $Revision: 1.6 $
36: * @since IDW 1.3.0
37: */
38: public interface DockingWindowDragger {
39: /**
40: * Returns the {@link RootWindow} where the window can be dropped.
41: *
42: * @return the {@link RootWindow} where the window can be dropped
43: */
44: RootWindow getDropTarget();
45:
46: /**
47: * The window that is dragged and dropped.
48: *
49: * @return the window that is dragged and dropped.
50: */
51: DockingWindow getDragWindow();
52:
53: /**
54: * Drags the window to a new location. The location is relative to the {@link RootWindow} in where it should be
55: * dropped, see {@link #getDropTarget()}.
56: *
57: * @param mouseEvent the mouse event that caused the drag
58: */
59: void dragWindow(MouseEvent mouseEvent);
60:
61: /**
62: * Aborts this drag operation.
63: */
64: void abortDrag();
65:
66: /**
67: * Drops the window at the specified location.
68: *
69: * @param mouseEvent the mouse event that caused the drop
70: */
71: void dropWindow(MouseEvent mouseEvent);
72: }
|