Packagecom.esri.aws.awx.map.handlers
Classpublic class PolygonMouseHandler
InheritancePolygonMouseHandler Inheritance BaseOverlayMouseHandler Inheritance BaseMouseHandler Inheritance flash.events.EventDispatcher

PolygonMouse Handler is used to create polygons by adding points with each mouse click.

See also

com.esri.aws.awx.events.OverlayEvent


Public Properties
 PropertyDefined by
 InheritedapplyToMap : Boolean
BaseOverlayMouseHandler
 Inheritedmap : IMap
The map reference.
BaseMouseHandler
 InheritedoverlayLayer : OverlayLayer
The overlayLayer to which the overlay will be added
BaseOverlayMouseHandler
 InheritedoverlayObjectClass : *
Define the overlay object class to create instances of overlay objects for that layer.
BaseOverlayMouseHandler
 Inheritedstyle : IStyle
BaseOverlayMouseHandler
Protected Properties
 PropertyDefined by
 Inheritedm_applyToMap : Boolean
If true, the overlay will be added to the overlay layer.
BaseOverlayMouseHandler
 Inheritedm_map : IMap
The IMap reference.
BaseMouseHandler
 Inheritedm_overlayLayer : OverlayLayer
The overlay layer to add the overlays to.
BaseOverlayMouseHandler
 Inheritedm_overlayObject : OverlayObject
The created overlaye object.
BaseOverlayMouseHandler
 Inheritedm_overlayObjectClass : Class
The overlay object class to create instances of overlay objects for the layer.
BaseOverlayMouseHandler
 Inheritedm_style : IStyle
The overlay style.
BaseOverlayMouseHandler
Public Methods
 MethodDefined by
  
PolygonMouseHandler(overlayLayer:OverlayLayer, style:PolygonStyle = null, applyToMap:Boolean = true)
Creates a new PolygonMouseHandler.
PolygonMouseHandler
  
cleanUp():void
Cleans up any extraneous handlers when mouse handler is removed.
PolygonMouseHandler
  
onClick(event:MouseEvent):void
onClick adds the next point to the polygon.
PolygonMouseHandler
  
onDoubleClick(event:MouseEvent):void
onDoubleClick adds the final point to the polygon.
PolygonMouseHandler
 Inherited
onMouseDown(event:MouseEvent):void
Mouse down function handler.
BaseMouseHandler
 Inherited
onMouseMove(event:MouseEvent):void
Mouse movement function handler.
BaseMouseHandler
 Inherited
onMouseOut(event:MouseEvent):void
Mouse out function handler.
BaseMouseHandler
 Inherited
onMouseOver(event:MouseEvent):void
Mouse over function handler.
BaseMouseHandler
 Inherited
onMouseUp(event:MouseEvent):void
Mouse up function handler.
BaseMouseHandler
 Inherited
onMouseWheel(event:MouseEvent):void
Mouse wheel function handler.
BaseMouseHandler
Protected Methods
 MethodDefined by
 Inherited
stage2GeoPoint(event:MouseEvent):GeoPoint
Converts a stage location to a geograhic location.
BaseMouseHandler
Events
 EventSummaryDefined by
    PolygonMouseHandler
    PolygonMouseHandler
Constructor detail
PolygonMouseHandler()constructor
public function PolygonMouseHandler(overlayLayer:OverlayLayer, style:PolygonStyle = null, applyToMap:Boolean = true)

Creates a new PolygonMouseHandler.

Parameters
overlayLayer:OverlayLayer — The layer to apply the style to.
 
style:PolygonStyle (default = null) — The polygon style. Default is null.
 
applyToMap:Boolean (default = true) — If true, the overlay will be added to the overlay layer on double-click.
Method detail
cleanUp()method
public override function cleanUp():void

Cleans up any extraneous handlers when mouse handler is removed.

onClick()method 
public override function onClick(event:MouseEvent):void

onClick adds the next point to the polygon.

Parameters
event:MouseEvent
onDoubleClick()method 
public override function onDoubleClick(event:MouseEvent):void

onDoubleClick adds the final point to the polygon.

Parameters
event:MouseEvent
Event detail
errorevent 
Event object type: flash.events.ErrorEvent

overlayCreatedevent  
Event object type: com.esri.aws.awx.events.OverlayEvent
OverlayEvent.type property = com.esri.aws.awx.events.OverlayEvent.OVERLAY_CREATED