Class IARControlEventsOnMouseUpEvent

  extended by java.util.EventObject
      extended by com.esri.arcgis.controls.IARControlEventsOnMouseUpEvent
All Implemented Interfaces:

public class IARControlEventsOnMouseUpEvent
extends EventObject


The OnMouseUp event is triggered when the user releases a mouse button on the Map or PageLayout display area of the ArcReaderControl. Use the event to specify actions that will occur when a given mouse button is released.

button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.

shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.

x is the X coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the CurrentView (the top left hand corner). x coordinates increase from left to right.

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the ArcReaderControl (the top left hand corner). y coordinates increase from top to bottom.

To find the origin of the CurrentView use ViewLeft and ViewTop properties. To convert x and y coordinates in pixels to map units and page units use the IARMap::ToMapPoint or IARPageLayout::ToPagePoint methods.


Use the win32 SetCapture function to continue receiving mouse events (until the mouse is released) when the mouse is moved outside the control's display area. The win32 ReleaseCapture function releases the mouse.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Field Summary
Fields inherited from class java.util.EventObject
Constructor Summary
IARControlEventsOnMouseUpEvent(Object source)
Method Summary
 int getButton()
 int getShift()
 int getX()
 int getY()
 void init(int button, int shift, int x, int y)
Methods inherited from class java.util.EventObject
getSource, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail


public IARControlEventsOnMouseUpEvent(Object source)
Method Detail


public void init(int button,
                 int shift,
                 int x,
                 int y)


public final int getButton()


public final int getShift()


public final int getX()


public final int getY()