com.esri.arcgis.cartoUI
Class ScaleTracker

java.lang.Object
  com.esri.arcgis.cartoUI.ScaleTracker

All Implemented Interfaces:

IScaleTracker, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ScaleTracker
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IScaleTracker

Tracker for scale operations.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

ScaleTracker()
Constructs a ScaleTracker using ArcGIS Engine.

ScaleTracker(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScaleTracker theScaleTracker = (ScaleTracker) obj;

Method Summary

void	addGeometry(IGeometry geometry) Adds a geometry to be scaled.
void	clearGeometry() Clears all the geometries.
boolean	deactivate() Cancel tracking.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ScaleTracker

public ScaleTracker()
             throws IOException,
                    UnknownHostException

Constructs a ScaleTracker using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ScaleTracker

public ScaleTracker(Object obj)
             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScaleTracker theScaleTracker = (ScaleTracker) obj;

Construct a ScaleTracker using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ScaleTracker.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setDisplayByRef

public 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

Specified by:

setDisplayByRef in interface IScaleTracker

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

public 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

Specified by:

getCursor in interface IScaleTracker

Returns:

The cursor (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public 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

Specified by:

refresh in interface IScaleTracker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseDown

public 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

Specified by:

onMouseDown in interface IScaleTracker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseMove

public 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

Specified by:

onMouseMove in interface IScaleTracker

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

public 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

Specified by:

onMouseUp in interface IScaleTracker

Returns:

The scaleChanged

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onKeyDown

public 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

Specified by:

onKeyDown in interface IScaleTracker

Parameters:

keyCode - The keyCode (in)

Returns:

The scaleChanged

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public boolean deactivate()
                   throws IOException,
                          AutomationException

Cancel tracking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deactivate in interface IScaleTracker

Returns:

The complete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrigin

public 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

Specified by:

setOrigin in interface IScaleTracker

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

public IPoint getOrigin()
                 throws IOException,
                        AutomationException

The scale origin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOrigin in interface IScaleTracker

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

public 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

Specified by:

addGeometry in interface IScaleTracker

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

public 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

Specified by:

clearGeometry in interface IScaleTracker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScaleFactor

public double getScaleFactor()
                      throws IOException,
                             AutomationException

The scale factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getScaleFactor in interface IScaleTracker

Returns:

The factor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.