com.esri.arcgis.schematic
Interface INgProjectTool

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgProjectToolProxy, NgProject

public interface INgProjectTool
extends Serializable

Provides access to members that control the graphic project tool.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
INgProject

Method Summary
 void dblClick(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser)
          Occurs when a mouse button is double clicked when the project tool is active.
 boolean isSpatialEnvironment()
          Indicates if the event occured in ArcMap.
 void keyDown(INgView view, int keyCode, int shift)
          Occurs when a key on the keyboard is pressed when the project tool is active.
 void keyUp(INgView view, int keyCode, int shift)
          Occurs when a key on the keyboard is released when the project tool is active.
 void mouseDown(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser)
          Occurs when a mouse button is pressed when the project tool is active.
 void mouseMove(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser)
          Occurs when the mouse is moved when the project tool is active.
 void mouseUp(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser)
          Occurs when a mouse button is released when the project tool is active.
 void setSpatialEnvironment(boolean pVal)
          Indicates if the event occured in ArcMap.
 

Method Detail

mouseDown

void mouseDown(INgView view,
               int button,
               int shift,
               int xScreen,
               int yScreen,
               int xWindow,
               int yWindow,
               double xUser,
               double yUser)
               throws IOException,
                      AutomationException
Occurs when a mouse button is pressed when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in)
button - The button (in)
shift - The shift (in)
xScreen - The xScreen (in)
yScreen - The yScreen (in)
xWindow - The xWindow (in)
yWindow - The yWindow (in)
xUser - The xUser (in)
yUser - The yUser (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectTool.mouseUp(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double), INgProjectTool.mouseMove(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double)

mouseMove

void mouseMove(INgView view,
               int button,
               int shift,
               int xScreen,
               int yScreen,
               int xWindow,
               int yWindow,
               double xUser,
               double yUser)
               throws IOException,
                      AutomationException
Occurs when the mouse is moved when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in)
button - The button (in)
shift - The shift (in)
xScreen - The xScreen (in)
yScreen - The yScreen (in)
xWindow - The xWindow (in)
yWindow - The yWindow (in)
xUser - The xUser (in)
yUser - The yUser (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectTool.mouseDown(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double), INgProjectTool.mouseUp(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double)

mouseUp

void mouseUp(INgView view,
             int button,
             int shift,
             int xScreen,
             int yScreen,
             int xWindow,
             int yWindow,
             double xUser,
             double yUser)
             throws IOException,
                    AutomationException
Occurs when a mouse button is released when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in)
button - The button (in)
shift - The shift (in)
xScreen - The xScreen (in)
yScreen - The yScreen (in)
xWindow - The xWindow (in)
yWindow - The yWindow (in)
xUser - The xUser (in)
yUser - The yUser (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectTool.mouseDown(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double), INgProjectTool.mouseMove(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double)

dblClick

void dblClick(INgView view,
              int button,
              int shift,
              int xScreen,
              int yScreen,
              int xWindow,
              int yWindow,
              double xUser,
              double yUser)
              throws IOException,
                     AutomationException
Occurs when a mouse button is double clicked when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in)
button - The button (in)
shift - The shift (in)
xScreen - The xScreen (in)
yScreen - The yScreen (in)
xWindow - The xWindow (in)
yWindow - The yWindow (in)
xUser - The xUser (in)
yUser - The yUser (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

keyDown

void keyDown(INgView view,
             int keyCode,
             int shift)
             throws IOException,
                    AutomationException
Occurs when a key on the keyboard is pressed when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in)
keyCode - The keyCode (in)
shift - The shift (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectTool.keyUp(com.esri.arcgis.schematic.INgView, int, int)

keyUp

void keyUp(INgView view,
           int keyCode,
           int shift)
           throws IOException,
                  AutomationException
Occurs when a key on the keyboard is released when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in)
keyCode - The keyCode (in)
shift - The shift (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectTool.keyDown(com.esri.arcgis.schematic.INgView, int, int)

isSpatialEnvironment

boolean isSpatialEnvironment()
                             throws IOException,
                                    AutomationException
Indicates if the event occured in ArcMap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialEnvironment

void setSpatialEnvironment(boolean pVal)
                           throws IOException,
                                  AutomationException
Indicates if the event occured in ArcMap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.