Module java.desktop
Package javax.swing.event

# Class MenuDragMouseEvent

java.lang.Object
java.util.EventObject
java.awt.AWTEvent
java.awt.event.ComponentEvent
java.awt.event.InputEvent
java.awt.event.MouseEvent
javax.swing.event.MenuDragMouseEvent

All Implemented Interfaces:
  `Serializable`

public class MenuDragMouseEvent extends MouseEvent
MenuDragMouseEvent is used to notify interested parties that the menu element has received a MouseEvent forwarded to it under drag conditions.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the `java.beans` package. Please see `XMLEncoder`.

- ## Field Summary

  ### Fields declared in class java.awt.event.MouseEvent

  `BUTTON1, BUTTON2, BUTTON3, MOUSE_CLICKED, MOUSE_DRAGGED, MOUSE_ENTERED, MOUSE_EXITED, MOUSE_FIRST, MOUSE_LAST, MOUSE_MOVED, MOUSE_PRESSED, MOUSE_RELEASED, MOUSE_WHEEL, NOBUTTON`

  ### Fields declared in class java.awt.event.InputEvent

  `ALT_DOWN_MASK, ALT_GRAPH_DOWN_MASK, ALT_GRAPH_MASK, ALT_MASK, BUTTON1_DOWN_MASK, BUTTON1_MASK, BUTTON2_DOWN_MASK, BUTTON2_MASK, BUTTON3_DOWN_MASK, BUTTON3_MASK, CTRL_DOWN_MASK, CTRL_MASK, META_DOWN_MASK, META_MASK, SHIFT_DOWN_MASK, SHIFT_MASK`

  ### Fields declared in class java.awt.event.ComponentEvent

  `COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN`

  ### Fields declared in class java.awt.AWTEvent

  `ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK`

  ### Fields declared in class java.util.EventObject

  `source`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `MenuDragMouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, MenuElement[] p, MenuSelectionManager m)`
  Constructs a MenuDragMouseEvent object.
  `MenuDragMouseEvent(Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, MenuElement[] p, MenuSelectionManager m)`
  Constructs a MenuDragMouseEvent object.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `MenuSelectionManager`
  `getMenuSelectionManager()`
  Returns the current menu selection manager.
  `MenuElement[]`
  `getPath()`
  Returns the path to the selected menu item.

  ### Methods declared in class java.awt.event.MouseEvent

  `getButton, getClickCount, getLocationOnScreen, getMouseModifiersText, getPoint, getX, getXOnScreen, getY, getYOnScreen, isPopupTrigger, paramString, translatePoint`

  ### Methods declared in class java.awt.event.InputEvent

  `consume, getMaskForButton, getModifiers, getModifiersEx, getModifiersExText, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown`

  ### Methods declared in class java.awt.event.ComponentEvent

  `getComponent`

  ### Methods declared in class java.awt.AWTEvent

  `getID, setSource, toString`

  ### Methods declared in class java.util.EventObject

  `getSource`

  ### Methods declared in class java.lang.Object

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

- ## Constructor Details

  - ### MenuDragMouseEvent

    public MenuDragMouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, MenuElement[] p, MenuSelectionManager m)
    Constructs a MenuDragMouseEvent object.

    Absolute coordinates xAbs and yAbs are set to source's location on screen plus relative coordinates x and y. xAbs and yAbs are set to zero if the source is not showing.

    Parameters:
      `source` - the Component that originated the event (typically `this`)
      `id` - an int specifying the type of event, as defined in `MouseEvent`
      `when` - a long identifying the time the event occurred
      `modifiers` - an int specifying any modifier keys held down, as specified in `InputEvent`
      `x` - an int specifying the horizontal position at which the event occurred, in pixels
      `y` - an int specifying the vertical position at which the event occurred, in pixels
      `clickCount` - an int specifying the number of mouse-clicks
      `popupTrigger` - a boolean -- true if the event {should?/did?} trigger a popup
      `p` - an array of MenuElement objects specifying a path to a menu item affected by the drag
      `m` - a MenuSelectionManager object that handles selections
    See Also:
      - `MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)`

  - ### MenuDragMouseEvent

    public MenuDragMouseEvent(Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, MenuElement[] p, MenuSelectionManager m)
    Constructs a MenuDragMouseEvent object.

    Even if inconsistent values for relative and absolute coordinates are passed to the constructor, the MenuDragMouseEvent instance is still created.

    Parameters:
      `source` - the Component that originated the event (typically `this`)
      `id` - an int specifying the type of event, as defined in `MouseEvent`
      `when` - a long identifying the time the event occurred
      `modifiers` - an int specifying any modifier keys held down, as specified in `InputEvent`
      `x` - an int specifying the horizontal position at which the event occurred, in pixels
      `y` - an int specifying the vertical position at which the event occurred, in pixels
      `xAbs` - an int specifying the horizontal absolute position at which the event occurred, in pixels
      `yAbs` - an int specifying the vertical absolute position at which the event occurred, in pixels
      `clickCount` - an int specifying the number of mouse-clicks
      `popupTrigger` - a boolean -- true if the event {should?/did?} trigger a popup
      `p` - an array of MenuElement objects specifying a path to a menu item affected by the drag
      `m` - a MenuSelectionManager object that handles selections
    Since:
      1.6
    See Also:
      - `MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)`

- ## Method Details

  - ### getPath

    public MenuElement[] getPath()
    Returns the path to the selected menu item.
    Returns:
      an array of MenuElement objects representing the path value

  - ### getMenuSelectionManager

    public MenuSelectionManager getMenuSelectionManager()
    Returns the current menu selection manager.
    Returns:
      a MenuSelectionManager object