com.esri.arcgis.editor
Class ISnapEnvironmentProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.ISnapEnvironmentProxy

All Implemented Interfaces:

ISnapEnvironment, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ISnapEnvironment2Proxy

public class ISnapEnvironmentProxy
extends com.esri.arcgis.interop.Dispatch
implements ISnapEnvironment, java.io.Serializable

Internal use class Proxy for COM Interface 'ISnapEnvironment'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that manage the snap agents used by the editor.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.editor.ISnapEnvironment

IID, IID99305f46_ef10_11d0_aaca_0000f804eb00

Constructor Summary

	ISnapEnvironmentProxy() For internal use only
	ISnapEnvironmentProxy(java.lang.Object obj)
protected	ISnapEnvironmentProxy(java.lang.Object obj, java.lang.String iid)
	ISnapEnvironmentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ISnapEnvironmentProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	addSnapAgent(ISnapAgent snapAgent) Adds a new snap agent to the snap environment.
void	clearSnapAgents() Removes all snap agents.
ISnapAgent	getSnapAgent(int index) A snap agent at the given index.
int	getSnapAgentCount() The number of active snap agents.
double	getSnapTolerance() The snap tolerance, measured in pixels or map units.
int	getSnapToleranceUnits() The units used for the snap tolerance.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	removeSnapAgent(int index) Removes the snap agent at the given index.
void	setSnapTolerance(double tol) The snap tolerance, measured in pixels or map units.
void	setSnapToleranceUnits(int units) The units used for the snap tolerance.
boolean	snapPoint(IPoint point) Attempts to snap the point using the current snap environment.

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

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

ISnapEnvironmentProxy

public ISnapEnvironmentProxy(java.lang.String CLSID,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.net.UnknownHostException,
                             java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

ISnapEnvironmentProxy

public ISnapEnvironmentProxy()

For internal use only

ISnapEnvironmentProxy

public ISnapEnvironmentProxy(java.lang.Object obj)
                      throws java.io.IOException

Throws:

java.io.IOException

ISnapEnvironmentProxy

protected ISnapEnvironmentProxy(java.lang.Object obj,
                                java.lang.String iid)
                         throws java.io.IOException

Throws:

java.io.IOException

ISnapEnvironmentProxy

protected ISnapEnvironmentProxy(java.lang.String CLSID,
                                java.lang.String iid,
                                java.lang.String host,
                                com.esri.arcgis.interop.AuthInfo authInfo)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

snapPoint

public boolean snapPoint(IPoint point)
                  throws java.io.IOException,
                         AutomationException

Attempts to snap the point using the current snap environment.

Specified by:

snapPoint in interface ISnapEnvironment

Parameters:

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

Returns:

The snapped

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapToleranceUnits

public int getSnapToleranceUnits()
                          throws java.io.IOException,
                                 AutomationException

The units used for the snap tolerance.

Specified by:

getSnapToleranceUnits in interface ISnapEnvironment

Returns:

A com.esri.arcgis.editor.esriSnapToleranceUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

public void setSnapToleranceUnits(int units)
                           throws java.io.IOException,
                                  AutomationException

The units used for the snap tolerance.

Specified by:

setSnapToleranceUnits in interface ISnapEnvironment

Parameters:

units - A com.esri.arcgis.editor.esriSnapToleranceUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

public double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

The snap tolerance, measured in pixels or map units.

Specified by:

getSnapTolerance in interface ISnapEnvironment

Returns:

The tol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double tol)
                      throws java.io.IOException,
                             AutomationException

The snap tolerance, measured in pixels or map units.

Specified by:

setSnapTolerance in interface ISnapEnvironment

Parameters:

tol - The tol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapAgentCount

public int getSnapAgentCount()
                      throws java.io.IOException,
                             AutomationException

The number of active snap agents.

Specified by:

getSnapAgentCount in interface ISnapEnvironment

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapAgent

public ISnapAgent getSnapAgent(int index)
                        throws java.io.IOException,
                               AutomationException

A snap agent at the given index.

Specified by:

getSnapAgent in interface ISnapEnvironment

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.editor.ISnapAgent

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

public void clearSnapAgents()
                     throws java.io.IOException,
                            AutomationException

Removes all snap agents.

Specified by:

clearSnapAgents in interface ISnapEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeSnapAgent

public void removeSnapAgent(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the snap agent at the given index.

Specified by:

removeSnapAgent in interface ISnapEnvironment

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSnapAgent

public void addSnapAgent(ISnapAgent snapAgent)
                  throws java.io.IOException,
                         AutomationException

Adds a new snap agent to the snap environment.

Specified by:

addSnapAgent in interface ISnapEnvironment

Parameters:

snapAgent - A reference to a com.esri.arcgis.editor.ISnapAgent (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.