com.esri.arcgis.controls
Class SnappingFeedback

java.lang.Object
  com.esri.arcgis.controls.SnappingFeedback

All Implemented Interfaces:

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

public class SnappingFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISnappingFeedback

Provdes the snapping feedback to the display.

Remarks

The SnappingFeedback class manages the display of snapping feedback, including the snapping symbol and snap tip.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Constructor Summary

SnappingFeedback()
Constructs a SnappingFeedback using ArcGIS Engine.

SnappingFeedback(Object obj)
Construct a SnappingFeedback using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	initialize(Object hook, ISnappingEnvironment snapEnv, boolean autoErase) Initialize with the current snapping environment.
void	refresh(int hdc) Refresh the last update.
void	unInitialize() Disconnecting from the View.
void	update(ISnappingResult snappingResult, int hdc) Sets the current mouse location and snap result.

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

SnappingFeedback

public SnappingFeedback()
                 throws IOException,
                        UnknownHostException

Constructs a SnappingFeedback using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SnappingFeedback

public SnappingFeedback(Object obj)
                 throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SnappingFeedback theSnappingFeedback = (SnappingFeedback) obj;

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

initialize

public void initialize(Object hook,
                       ISnappingEnvironment snapEnv,
                       boolean autoErase)
                throws IOException,
                       AutomationException

Initialize with the current snapping environment.

Remarks

Initialize sets up a SnappingFeedback class with the appropriate snap symbol as defined on snapping environment.

Product Availability

Available with ArcGIS Engine.

Specified by:

initialize in interface ISnappingFeedback

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

snapEnv - A reference to a com.esri.arcgis.controls.ISnappingEnvironment (in)

autoErase - The autoErase (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unInitialize

public void unInitialize()
                  throws IOException,
                         AutomationException

Disconnecting from the View.

Remarks

Uninitialize releases any references to the snapping environment and application specified in ISnappingFeedback.Initialize.

Product Availability

Available with ArcGIS Engine.

Specified by:

unInitialize in interface ISnappingFeedback

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(ISnappingResult snappingResult,
                   int hdc)
            throws IOException,
                   AutomationException

Sets the current mouse location and snap result.

Remarks

Update notifies the snapping feedback object that changes in the snap location may have occurred. The Update method uses the snapResult object that is passed in to display the snapping symbol and snap tip if a snap occurred, and draws them on the hDC passed in. Calls to Update are usually made in conjunction with calls to IPointSnapper.Snap() inside a tool’s MouseMove() method. Even if a null snap result is returned, your code should ensure that Update is called; a null SnapResult passed into the Update method() is fine.

Product Availability

Available with ArcGIS Engine.

Specified by:

update in interface ISnappingFeedback

Parameters:

snappingResult - A reference to a com.esri.arcgis.controls.ISnappingResult (in)

hdc - The hdc (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(int hdc)
             throws IOException,
                    AutomationException

Refresh the last update.

Remarks

A call to Refresh invalidates the previous location of the SnapTip and the snap symbol, and draws the new feedback. When a tool is utilizing the snapping environment, ISnappingFeedback.Refresh() should be called in the tool’s refresh method.

Product Availability

Available with ArcGIS Engine.

Specified by:

refresh in interface ISnappingFeedback

Parameters:

hdc - The hdc (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.