Class adf.MapKeyNavigation

Extends adf.MapToolItem.

Defined in: MapToolItem.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.MapKeyNavigation(id, toolName, panSpeed) This ToolItem uses adf.KeyInputAction to perform map navigation using keyboard shortcuts.

Field Summary
Field Attributes	Field Name and Description
	action The adf.Action associated with the ToolItem
	id The id of the ToolItem
	name The name of the ToolItem

Fields borrowed from class adf.MapToolItem:: blockMapPan, blockMapZoom, control
Fields borrowed from class adf.ToolItem:: clientPostBack, defaultImage, defaultStyle, disabledImage, disabledStyle, element, hoverImage, hoverStyle, isActive, isCommand, isDisabled, isMarker, selectedImage, selectedStyle, showLoading, toolTip

Method Summary
Method Attributes	Method Name and Description
	activate() Activates the ToolItem and the associated adf.KeyInputAction
	continuousAction(keyCode) Callback function which navigates the map whenever the 'UP', 'DOWN', 'LEFT' or 'RIGHT' key is pressed
	postAction(keyCode) This function zooms or recenters the map based on the keys pressed.

Methods borrowed from class adf.MapToolItem:: deactivate

Class Detail

adf.MapKeyNavigation(id, toolName, panSpeed)

This ToolItem uses adf.KeyInputAction to perform map navigation using keyboard shortcuts. The adf.ToolItem#clientPostBack determines whether the request to the web server will be sent through partial postback (AJAX) or full postback. The following table lists the keyboard shortcuts

Esc	Cancel current action
+ (Plus)	Zoom in to map
- (Minus)	Zoom out of map
Cursor Upper-left/Home	Pan upper left
Arrow Up	Pan up
Arrow Upper-right/Page Up	Pan upper right
Arrow Right	Pan right
Arrow Lower-right/Page Down	Pan lower right
Arrow Down	Pan down
Arrow Lower-left/End	Pan lower left
Arrow Left	Pan left

Parameters:
{String} id: The id of the tool
{String} toolName: The name of the tool
{Number} panSpeed: The rate at which th map is panned

Field Detail

{adf.Action} action

The adf.Action associated with the ToolItem

Default Value:: adf.KeyInputAction

{String} id

The id of the ToolItem

{String} name

The name of the ToolItem

Method Detail

activate()

Activates the ToolItem and the associated adf.KeyInputAction

continuousAction(keyCode)

Callback function which navigates the map whenever the 'UP', 'DOWN', 'LEFT' or 'RIGHT' key is pressed

Parameters:
{Number} keyCode

postAction(keyCode)

This function zooms or recenters the map based on the keys pressed.

Parameters:
{Number} keyCode

Classes

Class adf.MapKeyNavigation