com.esri.arcgis.display
Interface IScaleTracker

All Superinterfaces:

Serializable

All Known Implementing Classes:

ScaleTracker

public interface IScaleTracker
extends Serializable

Provides access to members that control the scale tracker.

Description

The IScaleTracker interface controls the user interface for scaling objects. It works in a similar way to IRotateTracker.

Product Availability

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

Method Summary

void	addGeometry(IGeometry geometry) Adds a geometry to be scaled.
void	clearGeometry() Clears all the geometries.
boolean	deactivate() Cancel tracking.
int	getCursor() 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.
IPoint	getOrigin() The scale origin.
double	getScaleFactor() The scale factor.
boolean	onKeyDown(int keyCode) Special keypress processing while tracking.
void	onMouseDown() Begin tracking move or resize based on the location of the mouse over the tracker handles.
void	onMouseMove(IPoint mapPoint) In process move or resize tracking.
boolean	onMouseUp() Finish move or resize tracking.
void	refresh() Invalidate the portion of the screen covered by the tracker.
void	setDisplayByRef(IScreenDisplay rhs1) The display used by the tracker.
void	setOrigin(IPoint anchor) The scale origin.

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.

getCursor

int getCursor()
              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

Returns:

The cursor (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Invalidate the portion of the screen covered by the tracker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseDown

void onMouseDown()
                 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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseMove

void onMouseMove(IPoint mapPoint)
                 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:

mapPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseUp

boolean onMouseUp()
                  throws IOException,
                         AutomationException

Finish move or resize tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The scaleChanged

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onKeyDown

boolean onKeyDown(int keyCode)
                  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)

Returns:

The scaleChanged

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.

setOrigin

void setOrigin(IPoint anchor)
               throws IOException,
                      AutomationException

The scale origin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

anchor - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrigin

IPoint getOrigin()
                 throws IOException,
                        AutomationException

The scale origin.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addGeometry

void addGeometry(IGeometry geometry)
                 throws IOException,
                        AutomationException

Adds a geometry to be scaled.

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.

clearGeometry

void clearGeometry()
                   throws IOException,
                          AutomationException

Clears all the geometries.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScaleFactor

double getScaleFactor()
                      throws IOException,
                             AutomationException

The scale factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The factor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.