com.esri.arcgis.controls
Class Snapping

java.lang.Object
  com.esri.arcgis.controls.Snapping

All Implemented Interfaces:

ISnappingEnvironment, ISnappingEnvironment2, com.esri.arcgis.interop.RemoteObjRef, IExtension, java.io.Serializable

public class Snapping
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISnappingEnvironment, ISnappingEnvironment2, IExtension

COM Class 'Snapping'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Provides the snapping environment for tools to use.' 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

Fields inherited from interface com.esri.arcgis.controls.ISnappingEnvironment2

IID, IID8147026e_d1df_420b_851b_e699004f195a, xxDummy

Fields inherited from interface com.esri.arcgis.controls.ISnappingEnvironment

IID89a22907_b646_491e_89f9_55f707daf009

Fields inherited from interface com.esri.arcgis.system.IExtension

IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy

Constructor Summary

Snapping()
Constructs a Snapping using ArcGIS Engine.

Snapping(java.lang.Object obj)
Construct a Snapping using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the extension.
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.
int	hashCode() the hashcode for this object
boolean	isEnabled() Toggles snapping on/off.
boolean	isIgnoreBasemapLayers() Ignores basemap layers.
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	release() Release a Snapping.
void	setEnabled(boolean snapping) Toggles snapping on/off.
void	setIgnoreBasemapLayers(boolean flag) Ignores basemap layers.
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.
void	shutdown() Shuts down the extension.
void	startup(java.lang.Object initializationData) Starts up the extension with the given initialization data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Snapping

public Snapping()
         throws java.io.IOException,
                java.net.UnknownHostException

Constructs a Snapping using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Snapping

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

Construct a Snapping using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Snapping.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems Snapping theSnapping = (Snapping) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a Snapping.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

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.

isIgnoreBasemapLayers

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

Ignores basemap layers.

Specified by:

isIgnoreBasemapLayers in interface ISnappingEnvironment2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreBasemapLayers

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

Ignores basemap layers.

Specified by:

setIgnoreBasemapLayers in interface ISnappingEnvironment2

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the extension.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shutdown

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

Shuts down the extension.

Specified by:

shutdown in interface IExtension

Throws:

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

AutomationException - If the ArcObject component throws an exception.