Creates a new Edit object. A map is a required parameter.
Map the toolbar is associated with.
Optional parameters.
The map instance.
The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this Draw toolbar instance belongs to.
The mode the component is running - e.g. mouse, keyboard
When a textSymbol point is in edit mode, double-clicking leads to text editing mode, which is a text box where uses can change the text content.
Display and edit vertices of a Polyline, Polygon, or Multipoint.
Move graphic to a new location on the map.
Rotate the graphic.
Scale or resize a graphic.
Contains logic to check if there is a snapping point to replace the moved point. Snapping is difficult with points during keyboard edits as we do not have a vertex handle which is separate from the actual graphic. This handles points when the move is finished and does a last minute geometry swap. If the geometry is swapped before this time, the point can become locked to the same point on the screen.
The editing graphic.
The point geometry to override.
Convert a polygon to an extent. Used for zoom operations using the keyboard.
A esri.geometry.Polygon polygon that is to be converted to an extent.
Provides keyboard handling for the Edit component.
Internal method that subclasses should override to provide keyboard handling.
Changes the current status message to something like: "Use arrows to move, R to rotate, S to scale, V to select vertex. Combine with ALT for finer control. Combine with SHIFT to reverse." It will also narrate the above text via the ScreenReaderNarrate command. Implementors should override this method if they want to suppress this behavior.
Activates the toolbar to edit the supplied graphic. After activation the toolbar is ready for user interaction using the specified tool.
Specify the active tool(s). Combine tools using the | operator.
The graphic to edit.
See the object specifications table below for the structure of the options object.
Deactivates the toolbar. Call this method to deactivate the toolbar after editing the graphic.
Returns an object with the following properties that describe the current state: tool, graphic, isModified.
Returns an array with the available tools (for example, [MOVE tool, ROTATE tool, SCALE tool]).
Activates the toolbar for editing geometries.
Deactivates the toolbar and reactivates map navigation.
Fires when a graphic is clicked.
Fires when the user begins to move a graphic.
Fired continuously as the graphic moves.
Fired when the mouse button is pressed down on the graphic, usually while moving a graphic.
Fired when the mouse button is released, usually after moving the graphic.
Fires continuously as a graphic is rotated.
Fires when the user begins to drag a handle to rotate the graphic.
Fires when a user clicks on the handle to begin rotating a graphic.
Fires when the mouse button is released from the rotate handle to finish rotating the graphic.
Fires continuously as the graphic is being scaled.
Fires when the user begins to drag a handle to scale the graphic.
Fires when a user clicks on the handle to scale or resize a graphic.
Fires when the mouse button is released from the scale handle to finish scaling the graphic.
Fired after a new vertex is added to a polyline or polygon or a new point is added to a multipoint.
Fired when the mouse button is clicked on the vertex of a polyline or polygon or a point in a multipoint.
Fired after a vertex(polyline, polygon) or point(multipoint) is deleted.
Fired when the user begins to move the vertex of a polyline or polygon or a point of a multipoint.
Fires as the mouse exits a vertex(polyline, polygon) or a point(multipoint).
Fired when the mouse moves over a vertex (polyline, polygon) or point (multipoint).
Fired continuously as the user is moving a vertex (polyline, polygon) or point (multipoint).
Fired when the mouse button is pressed down on a vertex (polyline, polygon) or point (multipoint).
Fired when the mouse button is released from a vertex (polyline, polygon) or point(multipoint).
Fired when the editing tools are activated.
The editing type. The constants table lists valid editing values.
The graphic to edit whose vertices will be edited or moved.
Fired when the editing tools are deactivated.
The editing type. The constants table lists valid editing values.
The graphic the toolbar was associated with.
Fired when a graphic is clicked. Applicable only when the MOVE tool is active.
The clicked graphic.
An object with the following properties: mapPoint, screenPoint
Fired when the user begins to move a graphic. Applicable only when the MOVE tool is active.
The graphic associated with the toolbar.
Fired continuously as the graphic moves. Applicable only when the MOVE tool is active.
The graphic associated with the toolbar.
Represents the linear transformation applied to the graphic.
Fired when the mouse button is pressed down on the graphic, usually while moving a graphic. Applicable only when the MOVE tool is active.
The graphic associated with the toolbar.
Fired when the mouse button is released, usually after moving the graphic. Applicable only when the MOVE tool is active.
The graphic associated with the toolbar.
Represents the linear transformation applied to the graphic.
Fired when the input method for this component (e.g. keyboard, mouse) has changed.
Internal method that subclasses should override to provide keyboard handling.
Internal method that subclasses should override to provide keyboard handling.
Whether the operation was cancelled.
Fired continuously as a graphic is rotated.
The rotated graphic.
The info object has the following properties: transform, angle, around
Fired when the user begins to drag a handle to rotate the graphic.
The rotated graphic.
Fired when a user clicks on the handle to begin rotating a graphic.
The rotated graphic.
Fired when the mouse button is released from the rotate handle to finish rotating the graphic.
The rotated graphic.
The info object has the following properties: transform, angle, around
Fired continuously as the graphic is being scaled.
The scaled graphic.
The info object has the following properties: transform, scaleX, scaleY, around
Fired when the user begins to drag a handle to scale the graphic.
The scaled graphic.
Fired when a user clicks on the handle to scale or resize a graphic.
The scaled graphic.
Fired when the mouse button is released from the scale handle to finish scaling the graphic.
The scaled graphic.
The info object has the following properties: transform, scaleX, scaleY, around
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.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
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.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Fired after a vertex(polyline, polygon) or point(multipoint) is deleted. Applicable only when the EDIT_VERTICES tool is active.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
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.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Fired as the mouse exits a vertex(polyline, polygon) or a point(multipoint). Applicable only when the EDIT_VERTICES tool is active.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Fired when the mouse moves over a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Fired continuously as the user is moving a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Represents the linear transformation applied to the graphic.
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.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Fired when the mouse button is released from a vertex (polyline, polygon) or point(multipoint). Applicable only when the EDIT_VERTICES tool is active.
The graphic associated with the toolbar.
An object with properties: isGhost, pointIndex, segmentIndex
Represents the linear transformation applied to the graphic.
Refreshes the internal state of the toolbar.
Sets the current input method for this component (for example, mouse or keyboard).
The input method. See {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.accessibility.InputMethod} for valid values.
DEPRECATED: No longer functional
Editing component used internally by the Draw component. It explicitly overrides a few parent methods to avoid emitting events since this component is internal.