com.esri.arcgis.controls
Class IPointSnapperProxy

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

public class IPointSnapperProxy
extends com.esri.arcgis.interop.Dispatch
implements IPointSnapper, java.io.Serializable

Internal use class Proxy for COM Interface 'IPointSnapper'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'IPointSnapper Interface' 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.controls.IPointSnapper
IID, IID2314d18e_2bd1_4298_aa30_d6759cd6c127
 
Constructor Summary
  IPointSnapperProxy()
          For internal use only
  IPointSnapperProxy(java.lang.Object obj)
           
protected IPointSnapperProxy(java.lang.Object obj, java.lang.String iid)
           
  IPointSnapperProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IPointSnapperProxy(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)
           
 int cacheShapes(IGeometryBag pShapes, java.lang.String name)
          Adds a shape to the snapping cache.
 void clearCache()
          Clears the underlying snapping cache.
 ISnappingResult fullSnap(IPoint point)
          Fully attempts to snap the specified point without regard to time.
 void getExcludedLayers(ISet ppSet)
          Returns a reference to the set of layers that will be excluded in snapping.
 IPoint getTangentInputPoint()
          Sets the input point used for calculating tangent points along curves.
 void removeCachedShapes(int token)
          Remove the shape from the cache.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setTangentInputPointByRef(IPoint point)
          Sets the input point used for calculating tangent points along curves.
 ISnappingResult snap(IPoint point)
          Attempts to snap the specified point.
 void updateCachedShapes(int token, IGeometryBag pShapes)
          Updates the shapes in the cache for the given token.
 
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

IPointSnapperProxy

public IPointSnapperProxy(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

IPointSnapperProxy

public IPointSnapperProxy()
For internal use only


IPointSnapperProxy

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

IPointSnapperProxy

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

IPointSnapperProxy

protected IPointSnapperProxy(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

snap

public ISnappingResult snap(IPoint point)
                     throws java.io.IOException,
                            AutomationException
Attempts to snap the specified point. This is used for tool snapping.

Specified by:
snap in interface IPointSnapper
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
A reference to a com.esri.arcgis.controls.ISnappingResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearCache

public void clearCache()
                throws java.io.IOException,
                       AutomationException
Clears the underlying snapping cache.

Specified by:
clearCache in interface IPointSnapper
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cacheShapes

public int cacheShapes(IGeometryBag pShapes,
                       java.lang.String name)
                throws java.io.IOException,
                       AutomationException
Adds a shape to the snapping cache. Use the returned token to remove the shape from the cache.

Specified by:
cacheShapes in interface IPointSnapper
Parameters:
pShapes - A reference to a com.esri.arcgis.geometry.IGeometryBag (in)
name - The name (in)
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateCachedShapes

public void updateCachedShapes(int token,
                               IGeometryBag pShapes)
                        throws java.io.IOException,
                               AutomationException
Updates the shapes in the cache for the given token. The token is acquired by calling CacheShape.

Specified by:
updateCachedShapes in interface IPointSnapper
Parameters:
token - The token (in)
pShapes - A reference to a com.esri.arcgis.geometry.IGeometryBag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeCachedShapes

public void removeCachedShapes(int token)
                        throws java.io.IOException,
                               AutomationException
Remove the shape from the cache. The token is acquired by calling CacheShape.

Specified by:
removeCachedShapes in interface IPointSnapper
Parameters:
token - The token (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTangentInputPointByRef

public void setTangentInputPointByRef(IPoint point)
                               throws java.io.IOException,
                                      AutomationException
Sets the input point used for calculating tangent points along curves.

Specified by:
setTangentInputPointByRef in interface IPointSnapper
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTangentInputPoint

public IPoint getTangentInputPoint()
                            throws java.io.IOException,
                                   AutomationException
Sets the input point used for calculating tangent points along curves.

Specified by:
getTangentInputPoint in interface IPointSnapper
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludedLayers

public void getExcludedLayers(ISet ppSet)
                       throws java.io.IOException,
                              AutomationException
Returns a reference to the set of layers that will be excluded in snapping.

Specified by:
getExcludedLayers in interface IPointSnapper
Parameters:
ppSet - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fullSnap

public ISnappingResult fullSnap(IPoint point)
                         throws java.io.IOException,
                                AutomationException
Fully attempts to snap the specified point without regard to time. Use Snap for tool snapping.

Specified by:
fullSnap in interface IPointSnapper
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
A reference to a com.esri.arcgis.controls.ISnappingResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.