|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.controls.Snapping
public class Snapping
Provides the snapping environment for tools to use.
Field Summary |
---|
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(Object obj)
Construct a Snapping using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
boolean |
equals(Object o)
Compare this object with another |
static String |
getClsid()
getClsid. |
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 |
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(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 |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public Snapping() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic Snapping(Object obj) throws IOException
obj
to Snapping
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
Snapping theSnapping = (Snapping) obj;
Method Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public boolean isEnabled() throws IOException, AutomationException
The Enabled property determines whether the snapping environment is active. If enabled, tools that utilize the mouse movement will return valid ISnappingResult references. Because this is setting is shared across all tools and applications, it is not recommended that individual tools modify this setting.
isEnabled
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEnabled(boolean snapping) throws IOException, AutomationException
setEnabled
in interface ISnappingEnvironment
snapping
- The snapping (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isTextSnapping() throws IOException, AutomationException
isTextSnapping
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTextSnapping(boolean snapping) throws IOException, AutomationException
setTextSnapping
in interface ISnappingEnvironment
snapping
- The snapping (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSnappingType() throws IOException, AutomationException
Use the esriSnappingType enumeration to define which snapping types should be evaluated when IPointSnapper.Snap is called. An individual snapping type can be specified, or a combination of snapping types may be used. The combination of snapping types is accomplished using a bit mask.
Snapping Types are evaluated in a fixed order defined below:
SnappingType is an application-level setting.
getSnappingType
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSnappingType(int options) throws IOException, AutomationException
setSnappingType
in interface ISnappingEnvironment
options
- A com.esri.arcgis.controls.esriSnappingType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowSnapTips() throws IOException, AutomationException
Determines whether snap tips are shown when a snapping type is satisfied. By default, snap tips are shown. The information displayed in the snap tip is determined by ISnappingEnvironment.SnapTipType.
ShowSnapTips is an application-level setting.
isShowSnapTips
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowSnapTips(boolean show) throws IOException, AutomationException
setShowSnapTips
in interface ISnappingEnvironment
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSnapTipType() throws IOException, AutomationException
The snapping tip type can contain the layer name of the feature layer that was snapped to, or the snapping type that was satisfied. The default is to show both the layer name and the snapping type as part of the snap tip.
getSnapTipType
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSnapTipType(int options) throws IOException, AutomationException
setSnapTipType
in interface ISnappingEnvironment
options
- A com.esri.arcgis.controls.esriSnappingTipType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITextSymbol getSnapTipSymbol() throws IOException, AutomationException
The SnapTipSymbol defines the textsymbol that is used to display information provided in the snap result’s description after a valid snap location was found. If ISnappingEnvironment.SnapTipType = 0 (no snap tip) this setting had no effect.
You have a number of options to customize the tip symbol, including advanced text capabilities provided by IFormattedTextSymbol to provide options for backgrounds, offsets, or right-to-left text capabilities.
The location of the tip is not customizable; the application will display the snap tip above and to the right of the snap location, unless at the extreme top or right bounds of the display.
SnapTipSymbol is an application-level setting.
getSnapTipSymbol
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSnapTipSymbolByRef(ITextSymbol symbol) throws IOException, AutomationException
setSnapTipSymbolByRef
in interface ISnappingEnvironment
symbol
- A reference to a com.esri.arcgis.display.ITextSymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowSnapTipBackground() throws IOException, AutomationException
The snapping tip uses XOR to display the snapping tip text. If you are snapping against an orthophoto or other imagery data source, the text may be difficult to see. By setting ShowTipBackground to true, a solid color is displayed so the snap tip text may be clearly seen.
This is an application-level setting, and is false by default.
isShowSnapTipBackground
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowSnapTipBackground(boolean show) throws IOException, AutomationException
setShowSnapTipBackground
in interface ISnappingEnvironment
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IColor getSnapSymbolColor() throws IOException, AutomationException
Specifies the color of the snapping symbol displayed when a valid snap result was found. The default color is black. Changing the color to a high contrast value such as yellow or cyan is particularly useful in situations where you are working against imagery or other layers symbolized using grayscale. The snap symbol itself cannot be altered.
getSnapSymbolColor
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSnapSymbolColorByRef(IColor color) throws IOException, AutomationException
setSnapSymbolColorByRef
in interface ISnappingEnvironment
color
- A reference to a com.esri.arcgis.display.IColor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTolerance(int tol) throws IOException, AutomationException
setTolerance
in interface ISnappingEnvironment
tol
- The tol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTolerance() throws IOException, AutomationException
The tolerance defines the distance used to determine whether a given snapping type is satisfied. The tolerance is defined in pixels; the default is 7 pixels.
The tolerance is an application-level setting.
getTolerance
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPointSnapper getPointSnapper() throws IOException, AutomationException
The PointSnapper property returns a reference to the engine that is responsible for performing snapping operations.
getPointSnapper
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPointSnapperByRef(IPointSnapper snapper) throws IOException, AutomationException
setPointSnapperByRef
in interface ISnappingEnvironment
snapper
- A reference to a com.esri.arcgis.controls.IPointSnapper (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIgnoreIMSLayers() throws IOException, AutomationException
The IgnoreIMSLayers setting excludes IMS feature service layers from participating in the snapping cache. In most cases, the time required to build the snapping cache against IMS layers is not fast enough, so they are automatically excluded from the snapping cache. In certain situations, the IMS layer response time is reasonable (such as an IMS service on an intranet) setting this property to false will include these layers in the snapping cache. IgnoreIMSLayers is set to true by default.
isIgnoreIMSLayers
in interface ISnappingEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setIgnoreIMSLayers(boolean flag) throws IOException, AutomationException
setIgnoreIMSLayers
in interface ISnappingEnvironment
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIgnoreBasemapLayers() throws IOException, AutomationException
isIgnoreBasemapLayers
in interface ISnappingEnvironment2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setIgnoreBasemapLayers(boolean flag) throws IOException, AutomationException
setIgnoreBasemapLayers
in interface ISnappingEnvironment2
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IExtension
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void startup(Object initializationData) throws IOException, AutomationException
startup
in interface IExtension
initializationData
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void shutdown() throws IOException, AutomationException
shutdown
in interface IExtension
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |