com.esri.arcgis.controls
Class IEngineSnapEnvironmentProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IEngineSnapEnvironmentProxy
All Implemented Interfaces:
IEngineSnapEnvironment, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IEngineSnapEnvironment'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.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 =

public class IEngineSnapEnvironmentProxy
extends com.esri.arcgis.interop.Dispatch
implements IEngineSnapEnvironment, java.io.Serializable

Internal use class

See Also:
Serialized Form

Field Summary
 boolean noncastable
          Deprecated.  
static java.lang.Class targetClass
          Deprecated.  
 
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.controls.IEngineSnapEnvironment
IID, IIDfad24a05_b217_4058_b3e2_6b306df64f68
 
Constructor Summary
  IEngineSnapEnvironmentProxy()
          Deprecated. For internal use only
  IEngineSnapEnvironmentProxy(java.lang.Object obj)
          Deprecated.  
protected IEngineSnapEnvironmentProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IEngineSnapEnvironmentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IEngineSnapEnvironmentProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Deprecated.  
 void addSnapAgent(IEngineSnapAgent snapAgent)
          Deprecated. Adds a new snap agent to the snap environment.
 void clearSnapAgents()
          Deprecated. Removes all snap agents.
 IEngineSnapAgent getSnapAgent(int index)
          Deprecated. A snap agent at the given index.
 int getSnapAgentCount()
          Deprecated. The number of active snap agents.
 double getSnapTolerance()
          Deprecated. The snap tolerance, measured in pixels or map units.
 int getSnapToleranceUnits()
          Deprecated. The units used for the snap tolerance.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void removeSnapAgent(int index)
          Deprecated. Removes the snap agent at the given index.
 void setSnapTolerance(double tol)
          Deprecated. The snap tolerance, measured in pixels or map units.
 void setSnapToleranceUnits(int units)
          Deprecated. The units used for the snap tolerance.
 boolean snapPoint(IPoint point)
          Deprecated. 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
Deprecated. 

noncastable

public boolean noncastable
Deprecated. 
Constructor Detail

IEngineSnapEnvironmentProxy

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

IEngineSnapEnvironmentProxy

public IEngineSnapEnvironmentProxy()
Deprecated. 
For internal use only


IEngineSnapEnvironmentProxy

public IEngineSnapEnvironmentProxy(java.lang.Object obj)
                            throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IEngineSnapEnvironmentProxy

protected IEngineSnapEnvironmentProxy(java.lang.Object obj,
                                      java.lang.String iid)
                               throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IEngineSnapEnvironmentProxy

protected IEngineSnapEnvironmentProxy(java.lang.String CLSID,
                                      java.lang.String iid,
                                      java.lang.String host,
                                      com.esri.arcgis.interop.AuthInfo authInfo)
                               throws java.io.IOException
Deprecated. 
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
Deprecated. 
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
Deprecated. 
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

snapPoint

public boolean snapPoint(IPoint point)
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Attempts to snap the point using the current snap environment.

Specified by:
snapPoint in interface IEngineSnapEnvironment
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
Deprecated. 
The units used for the snap tolerance.

Specified by:
getSnapToleranceUnits in interface IEngineSnapEnvironment
Returns:
A com.esri.arcgis.controls.esriEngineSnapToleranceUnits 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
Deprecated. 
The units used for the snap tolerance.

Specified by:
setSnapToleranceUnits in interface IEngineSnapEnvironment
Parameters:
units - A com.esri.arcgis.controls.esriEngineSnapToleranceUnits 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
Deprecated. 
The snap tolerance, measured in pixels or map units.

Specified by:
getSnapTolerance in interface IEngineSnapEnvironment
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
Deprecated. 
The snap tolerance, measured in pixels or map units.

Specified by:
setSnapTolerance in interface IEngineSnapEnvironment
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
Deprecated. 
The number of active snap agents.

Specified by:
getSnapAgentCount in interface IEngineSnapEnvironment
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSnapAgent

public IEngineSnapAgent getSnapAgent(int index)
                              throws java.io.IOException,
                                     AutomationException
Deprecated. 
A snap agent at the given index.

Specified by:
getSnapAgent in interface IEngineSnapEnvironment
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IEngineSnapAgent
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
Deprecated. 
Removes all snap agents.

Specified by:
clearSnapAgents in interface IEngineSnapEnvironment
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
Deprecated. 
Removes the snap agent at the given index.

Specified by:
removeSnapAgent in interface IEngineSnapEnvironment
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(IEngineSnapAgent snapAgent)
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Adds a new snap agent to the snap environment.

Specified by:
addSnapAgent in interface IEngineSnapEnvironment
Parameters:
snapAgent - A reference to a com.esri.arcgis.controls.IEngineSnapAgent (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.