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

Package | org.openscales.core.handler.mouse
Class | public class BorderPanHandler
Inheritance | BorderPanHandler Handler

Handler that pan the map when the mouse cursor is close of the borders

Public Properties
Hide Inherited Public Properties
Show Inherited 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
|  | ratio : int | BorderPanHandler
|  | toggleHandlerActivity : Function Getter and setter of the callback function used when the handler's activity changes | Handler

Public Methods

| Method | Defined by
--- | --- | ---
|  | BorderPanHandler(map:Map = null, active:Boolean = true, ratio:int = 20) | BorderPanHandler

Protected Methods

| Method | Defined by
--- | --- | ---
|  | registerListeners():void | BorderPanHandler
|  | unregisterListeners():void | BorderPanHandler

Property detail

ratio | property

`ratio:int` [read-write]Implementation
`public function get ratio():int`
`public function set ratio(value:int):void`
Constructor detail

BorderPanHandler | () | constructor

`public function BorderPanHandler(map:Map = null, active:Boolean = true, ratio:int = 20)`Parameters

| `map:Map` (default = `null`)``
| `active:Boolean` (default = `true`)``
| `ratio:int` (default = `20`)``

Method detail

registerListeners | () | method

`protected override function registerListeners():void`

unregisterListeners | () | method |

`protected override function unregisterListeners():void`