com.esri.arcgis.controls
Class ISnappingEnvironmentProxy

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

All Implemented Interfaces:

ISnappingEnvironment, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ISnappingEnvironment2Proxy

public class ISnappingEnvironmentProxy
extends com.esri.arcgis.interop.Dispatch
implements ISnappingEnvironment, java.io.Serializable

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

Description: 'ISnappingEnvironment 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.ISnappingEnvironment

IID, IID89a22907_b646_491e_89f9_55f707daf009

Constructor Summary

	ISnappingEnvironmentProxy() For internal use only
	ISnappingEnvironmentProxy(java.lang.Object obj)
protected	ISnappingEnvironmentProxy(java.lang.Object obj, java.lang.String iid)
	ISnappingEnvironmentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ISnappingEnvironmentProxy(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)
IPointSnapper	getPointSnapper() Returns the point snapper.
int	getSnappingType() The types of snapping currently being considered.
IColor	getSnapSymbolColor() The color of the snapping symbol.
ITextSymbol	getSnapTipSymbol() The symbol that displays the snap tip.
int	getSnapTipType() The types of snapping tip to be displayed.
int	getTolerance() Sets the snap tolerance in pixels.
boolean	isEnabled() Toggles snapping on/off.
boolean	isIgnoreIMSLayers() Ignores layers with slow response times.
boolean	isShowSnapTipBackground() Toggles snap tip background on/off.
boolean	isShowSnapTips() Toggles snap tips on/off.
boolean	isTextSnapping() Toggles snapping to text on/off.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setEnabled(boolean snapping) Toggles snapping on/off.
void	setIgnoreIMSLayers(boolean flag) Ignores layers with slow response times.
void	setPointSnapperByRef(IPointSnapper snapper) Returns the point snapper.
void	setShowSnapTipBackground(boolean show) Toggles snap tip background on/off.
void	setShowSnapTips(boolean show) Toggles snap tips on/off.
void	setSnappingType(int options) The types of snapping currently being considered.
void	setSnapSymbolColorByRef(IColor color) The color of the snapping symbol.
void	setSnapTipSymbolByRef(ITextSymbol symbol) The symbol that displays the snap tip.
void	setSnapTipType(int options) The types of snapping tip to be displayed.
void	setTextSnapping(boolean snapping) Toggles snapping to text on/off.
void	setTolerance(int tol) Sets the snap tolerance in pixels.

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

ISnappingEnvironmentProxy

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

ISnappingEnvironmentProxy

public ISnappingEnvironmentProxy()

For internal use only

ISnappingEnvironmentProxy

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

Throws:

java.io.IOException

ISnappingEnvironmentProxy

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

Throws:

java.io.IOException

ISnappingEnvironmentProxy

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

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Toggles snapping on/off.

Specified by:

isEnabled in interface ISnappingEnvironment

Returns:

The snapping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean snapping)
                throws java.io.IOException,
                       AutomationException

Toggles snapping on/off.

Specified by:

setEnabled in interface ISnappingEnvironment

Parameters:

snapping - The snapping (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTextSnapping

public boolean isTextSnapping()
                       throws java.io.IOException,
                              AutomationException

Toggles snapping to text on/off.

Specified by:

isTextSnapping in interface ISnappingEnvironment

Returns:

The snapping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextSnapping

public void setTextSnapping(boolean snapping)
                     throws java.io.IOException,
                            AutomationException

Toggles snapping to text on/off.

Specified by:

setTextSnapping in interface ISnappingEnvironment

Parameters:

snapping - The snapping (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnappingType

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

The types of snapping currently being considered.

Specified by:

getSnappingType in interface ISnappingEnvironment

Returns:

A com.esri.arcgis.controls.esriSnappingType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnappingType

public void setSnappingType(int options)
                     throws java.io.IOException,
                            AutomationException

The types of snapping currently being considered.

Specified by:

setSnappingType in interface ISnappingEnvironment

Parameters:

options - A com.esri.arcgis.controls.esriSnappingType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSnapTips

public boolean isShowSnapTips()
                       throws java.io.IOException,
                              AutomationException

Toggles snap tips on/off.

Specified by:

isShowSnapTips in interface ISnappingEnvironment

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSnapTips

public void setShowSnapTips(boolean show)
                     throws java.io.IOException,
                            AutomationException

Toggles snap tips on/off.

Specified by:

setShowSnapTips in interface ISnappingEnvironment

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapTipType

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

The types of snapping tip to be displayed.

Specified by:

getSnapTipType in interface ISnappingEnvironment

Returns:

A com.esri.arcgis.controls.esriSnappingTipType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTipType

public void setSnapTipType(int options)
                    throws java.io.IOException,
                           AutomationException

The types of snapping tip to be displayed.

Specified by:

setSnapTipType in interface ISnappingEnvironment

Parameters:

options - A com.esri.arcgis.controls.esriSnappingTipType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapTipSymbol

public ITextSymbol getSnapTipSymbol()
                             throws java.io.IOException,
                                    AutomationException

The symbol that displays the snap tip.

Specified by:

getSnapTipSymbol in interface ISnappingEnvironment

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTipSymbolByRef

public void setSnapTipSymbolByRef(ITextSymbol symbol)
                           throws java.io.IOException,
                                  AutomationException

The symbol that displays the snap tip.

Specified by:

setSnapTipSymbolByRef in interface ISnappingEnvironment

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSnapTipBackground

public boolean isShowSnapTipBackground()
                                throws java.io.IOException,
                                       AutomationException

Toggles snap tip background on/off.

Specified by:

isShowSnapTipBackground in interface ISnappingEnvironment

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSnapTipBackground

public void setShowSnapTipBackground(boolean show)
                              throws java.io.IOException,
                                     AutomationException

Toggles snap tip background on/off.

Specified by:

setShowSnapTipBackground in interface ISnappingEnvironment

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapSymbolColor

public IColor getSnapSymbolColor()
                          throws java.io.IOException,
                                 AutomationException

The color of the snapping symbol.

Specified by:

getSnapSymbolColor in interface ISnappingEnvironment

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapSymbolColorByRef

public void setSnapSymbolColorByRef(IColor color)
                             throws java.io.IOException,
                                    AutomationException

The color of the snapping symbol.

Specified by:

setSnapSymbolColorByRef in interface ISnappingEnvironment

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTolerance

public void setTolerance(int tol)
                  throws java.io.IOException,
                         AutomationException

Sets the snap tolerance in pixels.

Specified by:

setTolerance in interface ISnappingEnvironment

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTolerance

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

Sets the snap tolerance in pixels.

Specified by:

getTolerance in interface ISnappingEnvironment

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPointSnapper

public IPointSnapper getPointSnapper()
                              throws java.io.IOException,
                                     AutomationException

Returns the point snapper.

Specified by:

getPointSnapper in interface ISnappingEnvironment

Returns:

A reference to a com.esri.arcgis.controls.IPointSnapper

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPointSnapperByRef

public void setPointSnapperByRef(IPointSnapper snapper)
                          throws java.io.IOException,
                                 AutomationException

Returns the point snapper.

Specified by:

setPointSnapperByRef in interface ISnappingEnvironment

Parameters:

snapper - A reference to a com.esri.arcgis.controls.IPointSnapper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIgnoreIMSLayers

public boolean isIgnoreIMSLayers()
                          throws java.io.IOException,
                                 AutomationException

Ignores layers with slow response times.

Specified by:

isIgnoreIMSLayers in interface ISnappingEnvironment

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreIMSLayers

public void setIgnoreIMSLayers(boolean flag)
                        throws java.io.IOException,
                               AutomationException

Ignores layers with slow response times.

Specified by:

setIgnoreIMSLayers in interface ISnappingEnvironment

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.