com.esri.arcgis.controls
Class IPageLayoutControlEventsOnMouseDownEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.esri.arcgis.controls.IPageLayoutControlEventsOnMouseDownEvent
All Implemented Interfaces:
Serializable

public class IPageLayoutControlEventsOnMouseDownEvent
extends EventObject

Description

The OnMouseDown event is triggered when the user presses a mouse button on the PageLayoutControl. Use the event to specify actions that will occur when a given mouse button is pressed.

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 PageLayoutControl (the top left hand corner).

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the PageLayoutControl (the top left hand corner).

pageX is the X coordinate, in page units, where the mouse button was pressed referenced against the origin (bottom left hand corner) of the IPageLayoutControl::Page. The values returned are in IPage::Units.

pageY is the Y coordinate, in page units, where the mouse button was pressed referenced against the origin (bottom left hand corner) of the IPageLayoutControl::Page. The values returned are in IPage::Units.

Remarks

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 Engine.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
IPageLayoutControlEventsOnMouseDownEvent(Object source)
           
 
Method Summary
 int getButton()
           
 double getPageX()
           
 double getPageY()
           
 int getShift()
           
 int getX()
           
 int getY()
           
 void init(int button, int shift, int x, int y, double pageX, double pageY)
           
 
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

IPageLayoutControlEventsOnMouseDownEvent

public IPageLayoutControlEventsOnMouseDownEvent(Object source)
Method Detail

init

public void init(int button,
                 int shift,
                 int x,
                 int y,
                 double pageX,
                 double pageY)

getButton

public final int getButton()

getShift

public final int getShift()

getX

public final int getX()

getY

public final int getY()

getPageX

public final double getPageX()

getPageY

public final double getPageY()