edu.ucdavis.cstars.client

Class SnappingManager.SnappingOptions

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.SnappingManager.SnappingOptions

Enclosing class:

SnappingManager

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

Method Summary

Methods

Modifier and Type	Method and Description
static SnappingManager.SnappingOptions	create()
void	setAlwaysSnap(boolean alwaysSnap) Set the alwaysSnap parameter.
void	setLayerInfos(SnappingManager.LayerInfos[] layerInfos) Set the layerInfos parameter.
void	setMap(MapWidget map) Set the map parameter.
void	setSnapKey(int key) Set the snapKey parameter.
void	setSnapPointSymbol(SimpleMarkerSymbol snapPointSymbol) Set the snapPointSymbol parameter.
void	setTolerance(int tolerance) Set the tolerance parameter.

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.SnappingOptions create()

setAlwaysSnap

public final void setAlwaysSnap(boolean alwaysSnap)

Set the alwaysSnap parameter.

Parameters:

alwaysSnap - - When true, snapping is always enabled. When false users press the snapKey to enable snapping. Default value is false.

setLayerInfos

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

Set the layerInfos parameter.

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.

setMap

public final void setMap(MapWidget map)

Set the map parameter.

Parameters:

map - - Reference to the map. Required parameter.

setSnapKey

public final void setSnapKey(int key)

Set the snapKey parameter.

Parameters:

- - When alwaysSnap is set to false use this option to define the key users press to enable snapping. The default values is the CTRL key.

setSnapPointSymbol

public final void setSnapPointSymbol(SimpleMarkerSymbol snapPointSymbol)

Set the snapPointSymbol parameter.

Parameters:

snapPointSymbol - - Define a symbol for the snapping location. The default symbol is a simple marker symbol with the following properties: size:15px,color:cyan, style:STYLE_CROSS.

setTolerance

public final void setTolerance(int tolerance)

Set the tolerance parameter.

Parameters:

tolerance - - Specify the radius of the snapping circle in pixels. The default value is 15 pixels.