API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class Handler

Package | org.openscales.core.handler
Class | public class Handler
Implements | IHandler
Subclasses | AbstractDrawHandler, AbstractEditHandler, BorderPanHandler, ClickHandler, DragHandler, DrawHandler, FeatureClickHandler, FeatureLayerEditionHandler, WheelHandler, WMSGetFeatureInfo, ZoomBoxHandler

Handler base class

Public Properties

| Property | Defined by
--- | --- | ---
|  | active : Boolean Getter and setter of the boolean defining the activity of the handler | Handler
|  | map : Map Getter and setter of the map associated to the handler | Handler
|  | toggleHandlerActivity : Function Getter and setter of the callback function used when the handler's activity changes | Handler

Public Methods

| Method | Defined by
--- | --- | ---
|  | Handler(map:Map = null, active:Boolean = false) Constructor of the handler. | Handler

Protected Methods

| Method | Defined by
--- | --- | ---
|  | registerListeners():void Add the listeners to the associated map | Handler
|  | unregisterListeners():void Remove the listeners to the associated map | Handler

Property detail

active | property

`active:Boolean` [read-write]

Getter and setter of the boolean defining the activity of the handler

Implementation
`public function get active():Boolean`
`public function set active(value:Boolean):void`

map | property |

`map:Map` [read-write]

Getter and setter of the map associated to the handler

Implementation
`public function get map():Map`
`public function set map(value:Map):void`

toggleHandlerActivity | property |

`toggleHandlerActivity:Function` [read-write]

Getter and setter of the callback function used when the handler's activity changes

Implementation
`public function get toggleHandlerActivity():Function`
`public function set toggleHandlerActivity(value:Function):void`
Constructor detail

Handler | () | constructor

`public function Handler(map:Map = null, active:Boolean = false)`

Constructor of the handler.

Parameters

| `map:Map` (default = `null`)`` — the map associated to the handler
| `active:Boolean` (default = `false`)`` — boolean defining if the handler is active or not (default=false)

Method detail

registerListeners | () | method

`protected function registerListeners():void`

Add the listeners to the associated map

unregisterListeners | () | method |

`protected function unregisterListeners():void`

Remove the listeners to the associated map