Packagecom.esri.aws.awx.map.handlers
Classpublic class BaseOverlayMouseHandler
InheritanceBaseOverlayMouseHandler Inheritance BaseMouseHandler Inheritance flash.events.EventDispatcher
SubclassesMarkerMouseHandler, PolygonMouseHandler, PolylineMouseHandler, RedLineMouseHandler

BaseOverlayMouseHandler is a base class for custom IMouseHandler classes to extend. It containes properties for working with overlays.


Public Properties
 PropertyDefined by
  applyToMap : Boolean
BaseOverlayMouseHandler
 Inheritedmap : IMap
The map reference.
BaseMouseHandler
  overlayLayer : OverlayLayer
The overlayLayer to which the overlay will be added
BaseOverlayMouseHandler
  overlayObjectClass : *
Define the overlay object class to create instances of overlay objects for that layer.
BaseOverlayMouseHandler
  style : IStyle
BaseOverlayMouseHandler
Protected Properties
 PropertyDefined by
  m_applyToMap : Boolean
If true, the overlay will be added to the overlay layer.
BaseOverlayMouseHandler
 Inheritedm_map : IMap
The IMap reference.
BaseMouseHandler
  m_overlayLayer : OverlayLayer
The overlay layer to add the overlays to.
BaseOverlayMouseHandler
  m_overlayObject : OverlayObject
The created overlaye object.
BaseOverlayMouseHandler
  m_overlayObjectClass : Class
The overlay object class to create instances of overlay objects for the layer.
BaseOverlayMouseHandler
  m_style : IStyle
The overlay style.
BaseOverlayMouseHandler
Public Methods
 MethodDefined by
  
BaseOverlayMouseHandler(overlayLayer:OverlayLayer = null, style:IStyle = null, applyToMap:Boolean = true)
Creates a new BaseOverlayMouseHandler.
BaseOverlayMouseHandler
  
cleanUp():void
Cleans up any extraneous handlers when mouse handler is removed.
BaseOverlayMouseHandler
 Inherited
onClick(event:MouseEvent):void
Mouse click function handler.
BaseMouseHandler
 Inherited
onDoubleClick(event:MouseEvent):void
Mouse double-click function handler.
BaseMouseHandler
 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
Property detail
applyToMapproperty
applyToMap:Boolean  [read-write]

Implementation
    public function get applyToMap():Boolean
    public function set applyToMap(value:Boolean):void
m_applyToMapproperty 
protected var m_applyToMap:Boolean

If true, the overlay will be added to the overlay layer.

m_overlayLayerproperty 
protected var m_overlayLayer:OverlayLayer

The overlay layer to add the overlays to.

m_overlayObjectproperty 
protected var m_overlayObject:OverlayObject

The created overlaye object.

m_overlayObjectClassproperty 
protected var m_overlayObjectClass:Class

The overlay object class to create instances of overlay objects for the layer.

m_styleproperty 
protected var m_style:IStyle

The overlay style.

overlayLayerproperty 
overlayLayer:OverlayLayer  [read-write]

The overlayLayer to which the overlay will be added

Implementation
    public function get overlayLayer():OverlayLayer
    public function set overlayLayer(value:OverlayLayer):void
overlayObjectClassproperty 
overlayObjectClass:*  [read-write]

Define the overlay object class to create instances of overlay objects for that layer.

Implementation
    public function get overlayObjectClass():*
    public function set overlayObjectClass(value:*):void
styleproperty 
style:IStyle  [read-write]

Implementation
    public function get style():IStyle
    public function set style(value:IStyle):void
Constructor detail
BaseOverlayMouseHandler()constructor
public function BaseOverlayMouseHandler(overlayLayer:OverlayLayer = null, style:IStyle = null, applyToMap:Boolean = true)

Creates a new BaseOverlayMouseHandler.

Parameters
overlayLayer:OverlayLayer (default = null) — The overlay layer to add the overlays to.
 
style:IStyle (default = null) — The overlay style. Default is null.
 
applyToMap:Boolean (default = true) — If true, the overlay will be added to the overlay layer.
Method detail
cleanUp()method
public override function cleanUp():void

Cleans up any extraneous handlers when mouse handler is removed.