com.esri.arcgis.controls
Interface ISnappingEnvironment

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ISnappingEnvironment2

All Known Implementing Classes:

ISnappingEnvironment2Proxy, ISnappingEnvironmentProxy, Snapping

public interface ISnappingEnvironment
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID89a22907_b646_491e_89f9_55f707daf009
static int	xxDummy Deprecated. Internal use only

Method Summary

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	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.

Field Detail

IID89a22907_b646_491e_89f9_55f707daf009

static final int IID89a22907_b646_491e_89f9_55f707daf009

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isEnabled

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

Toggles snapping on/off.

Returns:

The snapping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnabled

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

Toggles snapping on/off.

Parameters:

snapping - The snapping (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTextSnapping

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

Toggles snapping to text on/off.

Returns:

The snapping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextSnapping

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

Toggles snapping to text on/off.

Parameters:

snapping - The snapping (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnappingType

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

The types of snapping currently being considered.

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

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

The types of snapping currently being considered.

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

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

Toggles snap tips on/off.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSnapTips

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

Toggles snap tips on/off.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapTipType

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

The types of snapping tip to be displayed.

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

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

The types of snapping tip to be displayed.

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

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

The symbol that displays the snap tip.

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

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

The symbol that displays the snap tip.

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

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

Toggles snap tip background on/off.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSnapTipBackground

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

Toggles snap tip background on/off.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapSymbolColor

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

The color of the snapping symbol.

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

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

The color of the snapping symbol.

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

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

Sets the snap tolerance in pixels.

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTolerance

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

Sets the snap tolerance in pixels.

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPointSnapper

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

Returns the point snapper.

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

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

Returns the point snapper.

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

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

Ignores layers with slow response times.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreIMSLayers

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

Ignores layers with slow response times.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.