edu.ucdavis.cstars.client.toolbars

Class Draw

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.toolbars.Draw

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

Toolbar that supports functionality to create new geometries by drawing them: points (POINT or MULTI_POINT), lines (LINE, POLYLINE, or FREEHAND_POLYLINE), polygons (FREEHAND_POLYGON or POLYGON), or rectangles (EXTENT). To edit geometries of existing graphics, use the Edit Toolbar.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Draw.GeometryType
static class	Draw.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(Draw.GeometryType geometryType) Activates the toolbar for drawing geometries.
void	activate(Draw.GeometryType geometryType, Draw.Options options) Activates the toolbar for drawing geometries.
void	addDrawEndHandler(DrawEndHandler handler) Add handler to draw end event;
static Draw	create(MapWidget map, Draw.Options options) Creates a new Draw object.
void	deactivate() Deactivates the toolbar and reactivates map navigation.
void	finishDrawing() Finishes drawing the geometry and fires the onDrawEnd event.
SimpleFillSymbol	getFillSymbol() Symbol to be used when drawing a Polygon or Extent.
SimpleLineSymbol	getLineSymbol() Symbol to be used when drawing a Polyline.
SimpleMarkerSymbol	getMarkerSymbol() Symbol to be used when drawing a Point or Multipoint.
boolean	respectDrawingVertexOrder() When set to false, the geometry is modified to be topologically correct.
void	setFillSymbol(SimpleFillSymbol fillSymbol) Sets the fill symbol.
void	setLineSymbol(SimpleLineSymbol lineSymbol) Sets the line symbol.
void	setMarkerSymbol(SimpleMarkerSymbol markerSymbol) Sets the marker symbol.
void	setRespectDrawingVertexOrder(boolean set) Sets whether the polygon geometry should be modified to be topologically correct.

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 Draw create(MapWidget map,
          Draw.Options options)

Creates a new Draw object. A map is a required parameter.

Parameters:

map - - Map the toolbar is associated with.

options - - Parameters that define the functionality of the draw toolbar.

Returns:

Draw

getFillSymbol

public final SimpleFillSymbol getFillSymbol()

Symbol to be used when drawing a Polygon or Extent.

Returns:

SimpleFillSymbol

getLineSymbol

public final SimpleLineSymbol getLineSymbol()

Symbol to be used when drawing a Polyline.

Returns:

SimpleLineSymbol

getMarkerSymbol

public final SimpleMarkerSymbol getMarkerSymbol()

Symbol to be used when drawing a Point or Multipoint.

Returns:

SimpleMarkerSymbol

respectDrawingVertexOrder

public final boolean respectDrawingVertexOrder()

When set to false, the geometry is modified to be topologically correct. When set to true, the input geometry is not modified. Default value: true

Returns:

boolean

activate

public final void activate(Draw.GeometryType geometryType)

Activates the toolbar for drawing geometries. Activating the toolbar disables map navigation.

Parameters:

geometryType - -The type of geometry drawn.

activate

public final void activate(Draw.GeometryType geometryType,
            Draw.Options options)

Activates the toolbar for drawing geometries. Activating the toolbar disables map navigation.

Parameters:

geometryType - - The type of geometry drawn.

options - - Options that define the functionality of the draw toolbar.

deactivate

public final void deactivate()

Deactivates the toolbar and reactivates map navigation.

finishDrawing

public final void finishDrawing()

Finishes drawing the geometry and fires the onDrawEnd event. Use this method to finish drawing a polyline, polygon or multipoint when working with the copmact build on a touch supported device like the iPhone.

setFillSymbol

public final void setFillSymbol(SimpleFillSymbol fillSymbol)

Sets the fill symbol.

Parameters:

fillSymbol - - The fill symbol.

setLineSymbol

public final void setLineSymbol(SimpleLineSymbol lineSymbol)

Sets the line symbol.

Parameters:

lineSymbol - - The line symbol.

setMarkerSymbol

public final void setMarkerSymbol(SimpleMarkerSymbol markerSymbol)

Sets the marker symbol.

Parameters:

markerSymbol - - The marker symbol.

setRespectDrawingVertexOrder

public final void setRespectDrawingVertexOrder(boolean set)

Sets whether the polygon geometry should be modified to be topologically correct.

Parameters:

set - -When set to false, the geometry is modified to be topologically correct. When set to true, the input geometry is not modified.

addDrawEndHandler

public final void addDrawEndHandler(DrawEndHandler handler)

Add handler to draw end event;

Parameters:

handler - - Geometry drawn on the client.