001 /*
002 * Copyright 1998-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.swing.event;
026
027 import javax.swing.MenuElement;
028 import javax.swing.MenuSelectionManager;
029 import java.util.EventObject;
030 import java.awt.event.MouseEvent;
031 import java.awt.Component;
032
033 /**
034 * MenuDragMouseEvent is used to notify interested parties that
035 * the menu element has received a MouseEvent forwarded to it
036 * under drag conditions.
037 * <p>
038 * <strong>Warning:</strong>
039 * Serialized objects of this class will not be compatible with
040 * future Swing releases. The current serialization support is
041 * appropriate for short term storage or RMI between applications running
042 * the same version of Swing. As of 1.4, support for long term storage
043 * of all JavaBeans<sup><font size="-2">TM</font></sup>
044 * has been added to the <code>java.beans</code> package.
045 * Please see {@link java.beans.XMLEncoder}.
046 *
047 * @version 1.22 05/05/07
048 * @author Georges Saab
049 */
050 public class MenuDragMouseEvent extends MouseEvent {
051 private MenuElement path[];
052 private MenuSelectionManager manager;
053
054 /**
055 * Constructs a MenuDragMouseEvent object.
056 * <p>Absolute coordinates xAbs and yAbs are set to source's location on screen plus
057 * relative coordinates x and y. xAbs and yAbs are set to zero if the source is not showing.
058 *
059 * @param source the Component that originated the event
060 * (typically <code>this</code>)
061 * @param id an int specifying the type of event, as defined
062 * in {@link java.awt.event.MouseEvent}
063 * @param when a long identifying the time the event occurred
064 * @param modifiers an int specifying any modifier keys held down,
065 * as specified in {@link java.awt.event.InputEvent}
066 * @param x an int specifying the horizontal position at which
067 * the event occurred, in pixels
068 * @param y an int specifying the vertical position at which
069 * the event occurred, in pixels
070 * @param clickCount an int specifying the number of mouse-clicks
071 * @param popupTrigger a boolean -- true if the event {should?/did?}
072 * trigger a popup
073 * @param p an array of MenuElement objects specifying a path
074 * to a menu item affected by the drag
075 * @param m a MenuSelectionManager object that handles selections
076 * @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)
077 */
078 public MenuDragMouseEvent(Component source, int id, long when,
079 int modifiers, int x, int y, int clickCount,
080 boolean popupTrigger, MenuElement p[],
081 MenuSelectionManager m) {
082 super (source, id, when, modifiers, x, y, clickCount,
083 popupTrigger);
084 path = p;
085 manager = m;
086 }
087
088 /**
089 * Constructs a MenuDragMouseEvent object.
090 * <p>Even if inconsistent values for relative and absolute coordinates are
091 * passed to the constructor, the MenuDragMouseEvent instance is still
092 * created.
093 * @param source the Component that originated the event
094 * (typically <code>this</code>)
095 * @param id an int specifying the type of event, as defined
096 * in {@link java.awt.event.MouseEvent}
097 * @param when a long identifying the time the event occurred
098 * @param modifiers an int specifying any modifier keys held down,
099 * as specified in {@link java.awt.event.InputEvent}
100 * @param x an int specifying the horizontal position at which
101 * the event occurred, in pixels
102 * @param y an int specifying the vertical position at which
103 * the event occurred, in pixels
104 * @param xAbs an int specifying the horizontal absolute position at which
105 * the event occurred, in pixels
106 * @param yAbs an int specifying the vertical absolute position at which
107 * the event occurred, in pixels
108 * @param clickCount an int specifying the number of mouse-clicks
109 * @param popupTrigger a boolean -- true if the event {should?/did?}
110 * trigger a popup
111 * @param p an array of MenuElement objects specifying a path
112 * to a menu item affected by the drag
113 * @param m a MenuSelectionManager object that handles selections
114 * @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)
115 * @since 1.6
116 */
117 public MenuDragMouseEvent(Component source, int id, long when,
118 int modifiers, int x, int y, int xAbs, int yAbs,
119 int clickCount, boolean popupTrigger, MenuElement p[],
120 MenuSelectionManager m) {
121 super (source, id, when, modifiers, x, y, xAbs, yAbs,
122 clickCount, popupTrigger, MouseEvent.NOBUTTON);
123 path = p;
124 manager = m;
125 }
126
127 /**
128 * Returns the path to the selected menu item.
129 *
130 * @return an array of MenuElement objects representing the path value
131 */
132 public MenuElement[] getPath() {
133 return path;
134 }
135
136 /**
137 * Returns the current menu selection manager.
138 *
139 * @return a MenuSelectionManager object
140 */
141 public MenuSelectionManager getMenuSelectionManager() {
142 return manager;
143 }
144 }
|