Packagecom.esri.aws.awx.map.handlers
Classpublic class AWXKeyboardMouseHandler
InheritanceAWXKeyboardMouseHandler Inheritance flash.events.EventDispatcher
ImplementsIKeyboardHandler, IMouseHandler

AWXKeyboardMouseHandler implements both IKeyboardHandler and IMouseHandler. It is used as the default keyboard and mouse handler for the AWX Application.

See also

com.esri.aws.awx.events.MapChangeEvent
com.esri.aws.awx.events.PanEvent


Public Properties
 PropertyDefined by
  lineColor : uint
lineColor is the uint color (ex: 0xFF0000) that defines the line used to pan a projected map.
AWXKeyboardMouseHandler
  map : IMap
[write-only] The map reference.
AWXKeyboardMouseHandler
  rubberBandColor : uint
rubberBandColor is the uint color (ex: 0xFF0000) that defines the rubber band box used to zoom in on the map.
AWXKeyboardMouseHandler
  rubberBandFillAlpha : Number
rubberBandFillAlpha is the Number (0-1) that defines the fill alpha of the rubber band box used to zoom in on the map.
AWXKeyboardMouseHandler
  rubberBandFillColor : uint
rubberBandFillColor is the uint color (ex: 0xFF0000) that defines the fill color of the rubber band box used to zoom in on the map.
AWXKeyboardMouseHandler
  useCursor : Boolean
AWXKeyboardMouseHandler
Public Methods
 MethodDefined by
  
Sets up the AWXKeyboardMouseHandler with a simple pan mouse handler and pan/zoom keyboard handler.
AWXKeyboardMouseHandler
  
cleanUp():void
Cleans up any extraneous handlers when mouse handler is removed.
AWXKeyboardMouseHandler
  
onClick(event:MouseEvent):void
Throws the onClick mouse event.
AWXKeyboardMouseHandler
  
onDoubleClick(event:MouseEvent):void
Dispatches the onDoubleClick mouse event.
AWXKeyboardMouseHandler
  
onKeyDown(event:KeyboardEvent):void
Dispatches the onKeyDown keyboard event and turns on the rubberband cursor.
AWXKeyboardMouseHandler
  
onKeyUp(event:KeyboardEvent):void
Dispatches the onKeyUp keyboard event and allows for zooming and panning using the +,- and arrow keys.
AWXKeyboardMouseHandler
  
onMouseDown(event:MouseEvent):void
Dispaches mouse down event.
AWXKeyboardMouseHandler
  
onMouseMove(event:MouseEvent):void
Dispatches the onMouseMove mouse event.
AWXKeyboardMouseHandler
  
onMouseOut(event:MouseEvent):void
Dispatches the onMouseOut mouse event.
AWXKeyboardMouseHandler
  
onMouseOver(event:MouseEvent):void
Dispatches the onMouseOver mouse event.
AWXKeyboardMouseHandler
  
onMouseUp(event:MouseEvent):void
Dispatches the onMouseUp mouse event.
AWXKeyboardMouseHandler
  
onMouseWheel(event:MouseEvent):void
Dispatches the onMouseWheel mouse event and adjusts the map scale.
AWXKeyboardMouseHandler
Events
 EventSummaryDefined by
   The user has drawn a box using the RubberBandMouseHandler.AWXKeyboardMouseHandler
Property detail
lineColorproperty
lineColor:uint  [read-write]

lineColor is the uint color (ex: 0xFF0000) that defines the line used to pan a projected map.

The default value is 0xAA0000.

Implementation
    public function get lineColor():uint
    public function set lineColor(value:uint):void
mapproperty 
map:IMap  [write-only]

The map reference.

Implementation
    public function set map(value:IMap):void
rubberBandColorproperty 
rubberBandColor:uint  [read-write]

rubberBandColor is the uint color (ex: 0xFF0000) that defines the rubber band box used to zoom in on the map.

The default value is 0xAA0000.

Implementation
    public function get rubberBandColor():uint
    public function set rubberBandColor(value:uint):void
rubberBandFillAlphaproperty 
rubberBandFillAlpha:Number  [read-write]

rubberBandFillAlpha is the Number (0-1) that defines the fill alpha of the rubber band box used to zoom in on the map.

The default value is 0.3.

Implementation
    public function get rubberBandFillAlpha():Number
    public function set rubberBandFillAlpha(value:Number):void
rubberBandFillColorproperty 
rubberBandFillColor:uint  [read-write]

rubberBandFillColor is the uint color (ex: 0xFF0000) that defines the fill color of the rubber band box used to zoom in on the map.

The default value is 0x444444.

Implementation
    public function get rubberBandFillColor():uint
    public function set rubberBandFillColor(value:uint):void
useCursorproperty 
useCursor:Boolean  [read-write]Implementation
    public function get useCursor():Boolean
    public function set useCursor(value:Boolean):void
Constructor detail
AWXKeyboardMouseHandler()constructor
public function AWXKeyboardMouseHandler()

Sets up the AWXKeyboardMouseHandler with a simple pan mouse handler and pan/zoom keyboard handler.

Method detail
cleanUp()method
public function cleanUp():void

Cleans up any extraneous handlers when mouse handler is removed.

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

Throws the onClick mouse event.

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

Dispatches the onDoubleClick mouse event.

Parameters
event:MouseEvent
onKeyDown()method 
public function onKeyDown(event:KeyboardEvent):void

Dispatches the onKeyDown keyboard event and turns on the rubberband cursor.

Parameters
event:KeyboardEvent — the KeyboardEvent that triggered the method.
onKeyUp()method 
public function onKeyUp(event:KeyboardEvent):void

Dispatches the onKeyUp keyboard event and allows for zooming and panning using the +,- and arrow keys.

Parameters
event:KeyboardEvent — the KeyboardEvent that triggered the method.
onMouseDown()method 
public function onMouseDown(event:MouseEvent):void

Dispaches mouse down event. if the shift key is down - then the mouse handler is set in rubberband mode.

Parameters
event:MouseEvent
onMouseMove()method 
public function onMouseMove(event:MouseEvent):void

Dispatches the onMouseMove mouse event.

Parameters
event:MouseEvent
onMouseOut()method 
public function onMouseOut(event:MouseEvent):void

Dispatches the onMouseOut mouse event.

Parameters
event:MouseEvent
onMouseOver()method 
public function onMouseOver(event:MouseEvent):void

Dispatches the onMouseOver mouse event.

Parameters
event:MouseEvent
onMouseUp()method 
public function onMouseUp(event:MouseEvent):void

Dispatches the onMouseUp mouse event.

Parameters
event:MouseEvent
onMouseWheel()method 
public function onMouseWheel(event:MouseEvent):void

Dispatches the onMouseWheel mouse event and adjusts the map scale.

Parameters
event:MouseEvent — the MouseEvent that triggered the method
Event detail
rubberBandevent 
Event object type: com.esri.aws.awx.events.RubberBandEvent
RubberBandEvent.type property = com.esri.aws.awx.events.RubberBandEvent.RUBBER_BAND

The user has drawn a box using the RubberBandMouseHandler.