edu.ucdavis.cstars.client.toolbars

Class Edit

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.toolbars.Edit

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

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Edit.EditState
static class	Edit.Info angle, scaleX and scaleY are not always returned.
static class	Edit.Options
static class	Edit.ToolType
static class	Edit.VertexInfo

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(Edit.ToolType tool, Graphic graphic) Activates the toolbar to edit the supplied graphic.
void	activate(Edit.ToolType tool, Graphic graphic, Edit.Options options) Activates the toolbar to edit the supplied graphic.
void	addActivateHandler(ToolbarActivateHandler handler) Add activate handler.
void	addDeactivateHandler(ToolbarDeactivateHandler handler) Add deactivate handler
void	addGraphicClickHandler(ToolbarGraphicClickHandler handler) Add handler for when graphic is clicked
void	addGraphicFirstMoveHandler(ToolbarGraphicFirstMoveHandler handler) Add handler for when graphic first moves
void	addGraphicMoveHandler(ToolbarGraphicMoveHandler handler) Add handler for when graphic is moved
void	addGraphicMoveStartHandler(ToolbarGraphicMoveHandler handler) Add handler for when a graphic move starts
void	addGraphicMoveStopHandler(ToolbarGraphicMoveStopHandler handler) Add handler for when a graphic move stops
void	addRotateFirstMoveHandler(ToolbarRotateFirstMoveHandler handler) Add handler for when graphic is first rotated
void	addRotateHandler(ToolbarRotateHandler handler) Add handler for when a graphic is rotated
void	addRotateStartHandler(ToolbarRotateStartHandler handler) Add handler for when graphic rotation is started
void	addRotateStopHandler(ToolbarRotateStopHandler handler) Add handler for when graphic stops rotating
void	addScaleFirstMoveHandler(ToolbarScaleFirstMoveHandler handler) Add handler for when graphic is first moved
void	addScaleHandler(ToolbarScaleHandler handler) Add handler for when graphic is scaled
void	addScaleStartHandler(ToolbarScaleStartHandler handler) Add handler for when graphic starts being scaled
void	addScaleStopHandler(ToolbarScaleStopHandler handler) Add handler for when graphic stops being scaled
void	addVertexAddHandler(ToolbarVertexAddHandler handler) Add handler for when vertex is added
void	addVertexClickHandler(ToolbarVertexClickHandler handler) Add handler for when vertex is clicked
void	addVertexDeleteHandler(ToolbarVertexDeleteHandler handler) Add handler for when vertex is deleted
void	addVertexFirstMoveHandler(ToolbarVertexFirstMoveHandler handler) Add handler for when vertex is first moved.
void	addVertexMouseOutHandler(ToolbarVertexMouseOutHandler handler) Add handler for when vertex is first moved.
void	addVertexMouseOverHandler(ToolbarVertexMouseOverHandler handler) Add handler for when mouse is over vertex.
void	addVertexMoveEndHandler(ToolbarVertexMoveEndHandler handler) Add handler for when vertex stops moving
void	addVertexMoveHandler(ToolbarVertexMoveHandler handler) Add handler for when vertex is moved
void	addVertexMoveStartHandler(ToolbarVertexMoveStartHandler handler) Add handler for when vertex starts moving
static boolean	assertLoaded() Check that the esri.toolbars.edit has been loaded
static Edit	create(MapWidget map) Creates a new Edit object.
static Edit	create(MapWidget map, Edit.Options options) Creates a new Edit object.
void	deactivate() Deactivates the toolbar.
Edit.EditState	getCurrentState() Get an edit state object.
void	refresh() Refreshes the internal state of the toolbar.

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 Edit create(MapWidget map)

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

Parameters:

map - - Map the toolbar is associated with.

Returns:

Edit

create

public static Edit create(MapWidget map,
          Edit.Options options)

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

Parameters:

map - - Map the toolbar is associated with.

options - - Optional parameters.

Returns:

Edit

assertLoaded

public static boolean assertLoaded()

Check that the esri.toolbars.edit has been loaded

Returns:

boolean

activate

public final void activate(Edit.ToolType tool,
            Graphic graphic)

Activates the toolbar to edit the supplied graphic. After activation the toolbar is ready for user interaction using the specified tool.

Parameters:

tool - - type of tool to be used.

graphic - - The graphic to edit.

activate

public final void activate(Edit.ToolType tool,
            Graphic graphic,
            Edit.Options options)

Activates the toolbar to edit the supplied graphic. After activation the toolbar is ready for user interaction using the specified tool.

Parameters:

tool - - type of tool to be used.

graphic - - The graphic to edit.

options - - set optional values.

deactivate

public final void deactivate()

Deactivates the toolbar. Call this method to deactivate the toolbar after editing the graphic.

getCurrentState

public final Edit.EditState getCurrentState()

Get an edit state object.

Returns:

EditState

refresh

public final void refresh()

Refreshes the internal state of the toolbar.

addActivateHandler

public final void addActivateHandler(ToolbarActivateHandler handler)

Add activate handler.

Parameters:

handler - - fires when toolbar activates

addDeactivateHandler

public final void addDeactivateHandler(ToolbarDeactivateHandler handler)

Add deactivate handler

Parameters:

handler - - fires when the toolbar deactivates and reactivates map navigation

addGraphicClickHandler

public final void addGraphicClickHandler(ToolbarGraphicClickHandler handler)

Add handler for when graphic is clicked

Parameters:

handler - - Fires when a graphic is clicked. Applicable only when the MOVE tool is active.

addGraphicFirstMoveHandler

public final void addGraphicFirstMoveHandler(ToolbarGraphicFirstMoveHandler handler)

Add handler for when graphic first moves

Parameters:

handler - - Fires when the user begins to move a graphic. Applicable only when the MOVE tool is active.

addGraphicMoveHandler

public final void addGraphicMoveHandler(ToolbarGraphicMoveHandler handler)

Add handler for when graphic is moved

Parameters:

handler - - Fired continuously as the graphic moves. Applicable only when the MOVE tool is active.

addGraphicMoveStartHandler

public final void addGraphicMoveStartHandler(ToolbarGraphicMoveHandler handler)

Add handler for when a graphic move starts

Parameters:

handler - - Fired when the mouse button is pressed down on the graphic, usually while moving a graphic. Applicable only when the MOVE tool is active.

addGraphicMoveStopHandler

public final void addGraphicMoveStopHandler(ToolbarGraphicMoveStopHandler handler)

Add handler for when a graphic move stops

Parameters:

handler - - Fired when the mouse button is released, usually after moving the graphic. Applicable only when the MOVE tool is active.

addRotateHandler

public final void addRotateHandler(ToolbarRotateHandler handler)

Add handler for when a graphic is rotated

Parameters:

handler - - Fires continuously as a graphic is rotated.

addRotateFirstMoveHandler

public final void addRotateFirstMoveHandler(ToolbarRotateFirstMoveHandler handler)

Add handler for when graphic is first rotated

Parameters:

handler - - Fires when the user begins to drag a handle to rotate the graphic.

addRotateStartHandler

public final void addRotateStartHandler(ToolbarRotateStartHandler handler)

Add handler for when graphic rotation is started

Parameters:

handler - - Fires when a user clicks on the handle to begin rotating a graphic.

addRotateStopHandler

public final void addRotateStopHandler(ToolbarRotateStopHandler handler)

Add handler for when graphic stops rotating

Parameters:

handler - - Fires when the mouse button is released from the rotate handle to finish rotating the graphic.

addScaleHandler

public final void addScaleHandler(ToolbarScaleHandler handler)

Add handler for when graphic is scaled

Parameters:

handler - - Fires continuously as the graphic is being scaled.

addScaleFirstMoveHandler

public final void addScaleFirstMoveHandler(ToolbarScaleFirstMoveHandler handler)

Add handler for when graphic is first moved

Parameters:

handler - - Fires when the user begins to drag a handle to scale the graphic.

addScaleStartHandler

public final void addScaleStartHandler(ToolbarScaleStartHandler handler)

Add handler for when graphic starts being scaled

Parameters:

handler - - Fires when a user clicks on the handle to scale or resize a graphic.

addScaleStopHandler

public final void addScaleStopHandler(ToolbarScaleStopHandler handler)

Add handler for when graphic stops being scaled

Parameters:

handler - - Fires when the mouse button is released from the scale handle to finish scaling the graphic.

addVertexAddHandler

public final void addVertexAddHandler(ToolbarVertexAddHandler handler)

Add handler for when vertex is added

Parameters:

handler - - Fired after a new vertex is added to a polyline or polygon or a new point is added to a multipoint. Applicable only when the EDIT_VERTICES tool is active.

addVertexClickHandler

public final void addVertexClickHandler(ToolbarVertexClickHandler handler)

Add handler for when vertex is clicked

Parameters:

handler - - Fired when the mouse button is clicked on the vertex of a polyline or polygon or a point in a multipoint. Applicable only when the EDIT_VERTICES tool is active.

addVertexDeleteHandler

public final void addVertexDeleteHandler(ToolbarVertexDeleteHandler handler)

Add handler for when vertex is deleted

Parameters:

handler - - Fired after a vertex(polyline, polygon) or point(multipoint) is deleted. Applicable only when the EDIT_VERTICES tool is active.

addVertexFirstMoveHandler

public final void addVertexFirstMoveHandler(ToolbarVertexFirstMoveHandler handler)

Add handler for when vertex is first moved.

Parameters:

handler - - Fired when the user begins to move the vertex of a polyline or polygon or a point of a multipoint. Applicable only when the EDIT_VERTICES tool is active.

addVertexMouseOutHandler

public final void addVertexMouseOutHandler(ToolbarVertexMouseOutHandler handler)

Add handler for when vertex is first moved.

Parameters:

handler - - Fires as the mouse exits a vertex(polyline, polygon) or a point(multipoint). Applicable only when the EDIT_VERTICES tool is active.

addVertexMouseOverHandler

public final void addVertexMouseOverHandler(ToolbarVertexMouseOverHandler handler)

Add handler for when mouse is over vertex.

Parameters:

handler - - Fired when the mouse moves over a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.

addVertexMoveHandler

public final void addVertexMoveHandler(ToolbarVertexMoveHandler handler)

Add handler for when vertex is moved

Parameters:

handler - - Fired continuously as the user is moving a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.

addVertexMoveStartHandler

public final void addVertexMoveStartHandler(ToolbarVertexMoveStartHandler handler)

Add handler for when vertex starts moving

Parameters:

handler - - Fired when the mouse button is pressed down on a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.

addVertexMoveEndHandler

public final void addVertexMoveEndHandler(ToolbarVertexMoveEndHandler handler)

Add handler for when vertex stops moving

Parameters:

handler - - Fired when the mouse button is released from a vertex (polyline, polygon) or point(multipoint). Applicable only when the EDIT_VERTICES tool is active.