com.esri.arcgis.display
Interface ISelectionTracker

All Superinterfaces:
Serializable
All Known Subinterfaces:
ICalloutTracker
All Known Implementing Classes:
CalloutTracker, EnvelopeTracker, LineTracker, PointTracker, PolygonTracker

public interface ISelectionTracker
extends Serializable

Provides access to members that control the managing of selection handle tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean deactivate()
          Cancel tracking.
 void draw(IDisplay display, int hDC, int style)
          Draw selection indicater.
 IEnvelope getBounds(IDisplay display)
          The area covered by the tracker including handles.
 IGeometry getGeometry()
          Geometry used for tracking feedback.
 int hitTest(IPoint point)
          Check if mouse is over tracker.
 boolean isLocked()
          Indicates if the tracker is locked or not.
 boolean isShowHandles()
          Indicates if the tracker is showing handles or not.
 boolean onKeyDown(int keyCode, int shift)
          Special keypress processing while tracking.
 boolean onKeyUp(int keyCode, int shift)
          Special keypress processing while tracking.
 void onMouseDown(int button, int shift, int x, int y)
          Begin tracking move or resize based on the location of the mouse over the tracker handles.
 void onMouseMove(int button, int shift, int x, int y)
          In process move or resize tracking.
 void onMouseUp(int button, int shift, int x, int y)
          Finish move or resize tracking.
 int queryCursor(IPoint point)
          If the mouse is over the tracker, return an HCURSOR to indicate legal operations based on mouse's relation to selection handles: move resize, etc.
 void queryMoveFeedback(IDisplayFeedback moveFeedback)
          The move feedback for the selection tracker.
 void queryResizeFeedback(IDisplayFeedback resizeFeedback)
          The resize feedback for the selection tracker.
 void setDisplayByRef(IScreenDisplay rhs1)
          The display used by the tracker.
 void setGeometry(IGeometry geometry)
          Geometry used for tracking feedback.
 void setLocked(boolean locked)
          Indicates if the tracker is locked or not.
 void setShowHandles(boolean showHandles)
          Indicates if the tracker is showing handles or not.
 

Method Detail

setDisplayByRef

void setDisplayByRef(IScreenDisplay rhs1)
                     throws IOException,
                            AutomationException
The display used by the tracker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.display.IScreenDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeometry

void setGeometry(IGeometry geometry)
                 throws IOException,
                        AutomationException
Geometry used for tracking feedback.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException
Geometry used for tracking feedback.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBounds

IEnvelope getBounds(IDisplay display)
                    throws IOException,
                           AutomationException
The area covered by the tracker including handles.

Product Availability

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

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryCursor

int queryCursor(IPoint point)
                throws IOException,
                       AutomationException
If the mouse is over the tracker, return an HCURSOR to indicate legal operations based on mouse's relation to selection handles: move resize, etc. Return 0 if mouse isn't over tracker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
The cursor (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTest

int hitTest(IPoint point)
            throws IOException,
                   AutomationException
Check if mouse is over tracker. Return a TrackerLocation to indicate which handle mouse is over.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
A com.esri.arcgis.display.esriTrackerLocation constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          int hDC,
          int style)
          throws IOException,
                 AutomationException
Draw selection indicater. Usually a color outline with selection handles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
hDC - The hDC (A COM typedef) (in)
style - A com.esri.arcgis.display.esriTrackerStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMouseDown

void onMouseDown(int button,
                 int shift,
                 int x,
                 int y)
                 throws IOException,
                        AutomationException
Begin tracking move or resize based on the location of the mouse over the tracker handles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

onMouseMove

void onMouseMove(int button,
                 int shift,
                 int x,
                 int y)
                 throws IOException,
                        AutomationException
In process move or resize tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

onMouseUp

void onMouseUp(int button,
               int shift,
               int x,
               int y)
               throws IOException,
                      AutomationException
Finish move or resize tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

onKeyDown

boolean onKeyDown(int keyCode,
                  int shift)
                  throws IOException,
                         AutomationException
Special keypress processing while tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

onKeyUp

boolean onKeyUp(int keyCode,
                int shift)
                throws IOException,
                       AutomationException
Special keypress processing while tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deactivate

boolean deactivate()
                   throws IOException,
                          AutomationException
Cancel tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLocked

void setLocked(boolean locked)
               throws IOException,
                      AutomationException
Indicates if the tracker is locked or not. Locked means nodes cannot be moved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isLocked

boolean isLocked()
                 throws IOException,
                        AutomationException
Indicates if the tracker is locked or not. Locked means nodes cannot be moved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setShowHandles

void setShowHandles(boolean showHandles)
                    throws IOException,
                           AutomationException
Indicates if the tracker is showing handles or not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isShowHandles

boolean isShowHandles()
                      throws IOException,
                             AutomationException
Indicates if the tracker is showing handles or not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryMoveFeedback

void queryMoveFeedback(IDisplayFeedback moveFeedback)
                       throws IOException,
                              AutomationException
The move feedback for the selection tracker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
moveFeedback - A reference to a com.esri.arcgis.display.IDisplayFeedback (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryResizeFeedback

void queryResizeFeedback(IDisplayFeedback resizeFeedback)
                         throws IOException,
                                AutomationException
The resize feedback for the selection tracker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
resizeFeedback - A reference to a com.esri.arcgis.display.IDisplayFeedback (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.