com.esri.arcgis.controls
Class ISnappingFeedbackProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.ISnappingFeedbackProxy

All Implemented Interfaces:

ISnappingFeedback, Externalizable, Serializable

public class ISnappingFeedbackProxy
extends com.esri.arcgis.interop.Dispatch
implements ISnappingFeedback, Serializable

ISnappingFeedback Interface

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISnappingFeedbackProxy()
	ISnappingFeedbackProxy(Object obj)
protected	ISnappingFeedbackProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	initialize(Object hook, ISnappingEnvironment snapEnv, boolean autoErase) Initialize with the current snapping environment.
void	refresh(int hdc) Refresh the last update.
void	removeListener(String iidStr, Object theListener)
void	unInitialize() Disconnecting from the View.
void	update(ISnappingResult snappingResult, int hdc) Sets the current mouse location and snap result.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISnappingFeedbackProxy

public ISnappingFeedbackProxy()

ISnappingFeedbackProxy

public ISnappingFeedbackProxy(Object obj)
                       throws IOException

Throws:

IOException

ISnappingFeedbackProxy

protected ISnappingFeedbackProxy(Object obj,
                                 String iid)
                          throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.