Class kaTool

Object
   |
   +--kaTool

Direct Known Subclasses:

kaNavigator

class kaTool

kaTool API.
An API for building tools that work with kaMap. To create a new tool, you need to have included this file first. Next create a function to instantiate your new tool. All object construction functions must include a parameter that references the kaMap object on which they operate.
The object construction function must call the kaTool constructor using the following syntax:

kaTool.apply( this, [oKaMap] );

where oKaMap is the name of the parameter to the constructor function. You should then set the tool's name (this.name) and overload any functions for mouse handling etc.
Defined in kaTool.js

Field Detail

bInfoTool

Object bInfoTool

info tools get all events all the time

kaMap

Object kaMap

the instance of kaMap on which this tool operates

name

Object name

the name of this tool

wheelMinus

Object wheelMinus

wheelPlus

Object wheelPlus

kaTool

kaTool( <Object> oKaMap )

Parameters:
oKaMap - the instance of kaMap on which this tool should operate

activate

void activate()

activate this tool. Activating the tool causes any existing tools to be deactivated.

adjustPixPosition

Array adjustPixPosition( <Integer> x, <Integer> y )

adjust a page-relative pixel position into a kaMap relative pixel position

Parameters:
x - the x page coordinate to convert
y - the y page coordinate to convert

Returns:
return an array containing the converted coordinates

cancelEvent

Object cancelEvent(<Event> e)

provide a cross-platform method of cancelling events, including stopping of event bubbling and propagation.

Parameters:
e - the event to cancel

deactivate

void deactivate()

deactivate this tool.

isInfoTool

Object isInfoTool()

is this an info tool or a regular tool?

ondblclick

Object ondblclick(<Event> e)

handle mouse doubleclicks on the viewport of the kaMap. This method does nothing and should be overloaded by subclasses.

Parameters:
e - the mouse event object

onkeypress

Object onkeypress(<Event> e)

handle keypress events. Keypress events are normally dispatched here rather than in a sub-class.

Parameters:
e - the keypress event object

onmousedown

Object onmousedown(<Event> e)

handle mouse down events on the viewport of the kaMap. This method does nothing and should be overloaded by subclasses.

Parameters:
e - the mouse event object

onmousemove

Object onmousemove(<Event> e)

handle mouse movement over the viewport of the kaMap. This method does nothing and should be overloaded by subclasses.

Parameters:
e - the mouse event object

onmouseout

Object onmouseout(<Event> e)

handle the mouse leaving the kaMap viewport. This is a method releases the keypress handler and should be called from any sub class that overloads this method.

Parameters:
e - the mouse event

onmouseover

Object onmouseover(<Event> e)

handle the mouse moving over the kaMap viewport. This is a method does nothing and should be overloaded in a subclass

Parameters:
e - the mouse event

onmouseup

Object onmouseup(<Event> e)

handle mouse up events on the viewport of the kaMap. This method does nothing and should be overloaded by subclasses.

Parameters:
e - the mouse event object

onmousewheel

void onmousewheel(<Event> e)

Handle mouse wheel events over the viewport of the kaMap. This applies a function set by the setMouseWheel function. If the function is null, do nothing. (Mod D Badke)

Parameters:
e - the mouse event object

setMouseWheel

void setMouseWheel(<array> minusSet, <array> plusSet)

Set the object and function to call when the mouse wheel event triggers. The parameters are saved in the tool object this is called for, and only affect that tool.

Parameters:
minusSet - - parameters for negative wheel scroll plusSet and minusSet are arrays of structure: [0] - object to apply function for or null [1] - function to apply [2] - function arguments or null for no arguments Set minusSet and/or plusSet to null to disable that scroll direction. eg: --disable mouse wheel for navigator tool: myKaNavigator.setMouseWheel(null, null); --set navigator tool to zoom (same as default action): myKaNavigator.setMouseWheel([myKaMap, myKaMap.zoomIn, null], [myKaMap, myKaMap.zoomOut, null]); (New D Badke)
plusSet - - parameters for positive wheel scroll