edu.ucdavis.cstars.client

Class SnappingManager

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.SnappingManager

public class SnappingManager
extends com.google.gwt.core.client.JavaScriptObject

The SnappingManager is used to add snapping capability to the Editor, Measurement Widget, Draw toolbar and Edit toolbar.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnappingManager.LayerInfos
static class	SnappingManager.SnappingOptions

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertLoaded() Check that the esri.SnappingManager has been loaded
static SnappingManager	create() Create a new SnappingManager object.
static SnappingManager	create(SnappingManager.SnappingOptions options) Create a new SnappingManager object.
void	destroy() Destroy the SnappingManager object.
Deferred	getSnappingPoint(Point screenPoint) Returns a deferred object, which can be added to a callback to find the snap point.
void	setLayerInfos(SnappingManager.LayerInfos[] layerInfos) An array of layerInfo objects used to specify the target snapping layers.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static SnappingManager create()

Create a new SnappingManager object. It is not required to create a SnappingManager object to enable snapping for the Editor, Measurement or Draw and Edit Toolbars. To enable snapping, call the map's enableSnapping method. Create a new snapping manager object if the default options need to be modified.

Returns:

SnappingManager

create

public static SnappingManager create(SnappingManager.SnappingOptions options)

Create a new SnappingManager object. It is not required to create a SnappingManager object to enable snapping for the Editor, Measurement or Draw and Edit Toolbars. To enable snapping, call the map's enableSnapping method. Create a new snapping manager object if the default options need to be modified.

Parameters:

Options - - Optional parameters.

Returns:

SnappingManager

assertLoaded

public static boolean assertLoaded()

Check that the esri.SnappingManager has been loaded

Returns:

boolean

destroy

public final void destroy()

Destroy the SnappingManager object. All related objects will be set to null.

getSnappingPoint

public final Deferred getSnappingPoint(Point screenPoint)

Returns a deferred object, which can be added to a callback to find the snap point.

Parameters:

screenPoint - - The input screen point for which to find the snapping location.

Returns:

Deferred

setLayerInfos

public final void setLayerInfos(SnappingManager.LayerInfos[] layerInfos)

An array of layerInfo objects used to specify the target snapping layers.

Parameters:

layerInfos - - An array of layerInfo objects that define the snapping target layers. All values are optional. If no snapping options are set the default values will be used.