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

Package | org.openscales.core.handler.feature
Class | public class FeatureClickHandler
Inheritance | FeatureClickHandler Handler

Depracated, should be removed in favor of SelectFeaturesHandler This handler has been created in particurlaly for The edition mode It allows the user to differenciate click from double click and drag/drop

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
|  | click : Function click callback function | FeatureClickHandler
|  | doubleclick : Function double click callback function | FeatureClickHandler
|  | map : Map Getter and setter of the map associated to the handler | Handler
|  | startDrag : Function drag callback function | FeatureClickHandler
|  | stopDrag : Function drop callback function | FeatureClickHandler
|  | toggleHandlerActivity : Function Getter and setter of the callback function used when the handler's activity changes | Handler

Public Methods

| Method | Defined by
--- | --- | ---
|  | FeatureClickHandler(map:Map = null, active:Boolean = false) Constructor | FeatureClickHandler
|  | addControledFeature(feature:Feature):void Add an array of features in the feature click handler controled features | FeatureClickHandler
|  | addControledFeatures(features:Array):void Add a feature in the feature click handler controled features | FeatureClickHandler
|  | dropMouseUp(evt:MouseEvent):void | FeatureClickHandler
|  | removeControledFeature(feature:Feature):void This function is used for removing a feature from the the feature click handler controled features | FeatureClickHandler
|  | removeControledFeatures(features:Array = null):void This function is used for removing an array of features from the the feature click handler controled features | FeatureClickHandler

Protected Methods

| Method | Defined by
--- | --- | ---
|  | mouseDown(evt:FeatureEvent):void The MouseDown Listener | FeatureClickHandler
|  | mouseUp(evt:FeatureEvent):void MouseUp Listener | FeatureClickHandler
|  | registerListeners():void | FeatureClickHandler
|  | unregisterListeners():void | FeatureClickHandler

Property detail

click | property

`click:Function` [read-write]

click callback function

Implementation
`public function get click():Function`
`public function set click(value:Function):void`

doubleclick | property |

`doubleclick:Function` [read-write]

double click callback function

Implementation
`public function get doubleclick():Function`
`public function set doubleclick(value:Function):void`

startDrag | property |

`startDrag:Function` [read-write]

drag callback function

Implementation
`public function get startDrag():Function`
`public function set startDrag(value:Function):void`

stopDrag | property |

`stopDrag:Function` [read-write]

drop callback function

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

FeatureClickHandler | () | constructor

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

Constructor

Parameters

| `map:Map` (default = `null`)`` — Map object
| `active:Boolean` (default = `false`)`` — to activate or deactivate the handler

Method detail

addControledFeature | () | method

`public function addControledFeature(feature:Feature):void`

Add an array of features in the feature click handler controled features

Parameters

| `feature:Feature` — array of features to add

addControledFeatures | () | method |

`public function addControledFeatures(features:Array):void`

Add a feature in the feature click handler controled features

Parameters

| `features:Array` — feature to add

dropMouseUp | () | method |

`public function dropMouseUp(evt:MouseEvent):void` Parameters

| `evt:MouseEvent`

mouseDown | () | method |

`protected function mouseDown(evt:FeatureEvent):void`

The MouseDown Listener

Parameters

| `evt:FeatureEvent`

mouseUp | () | method |

`protected function mouseUp(evt:FeatureEvent):void`

MouseUp Listener

Parameters

| `evt:FeatureEvent`

registerListeners | () | method |

`protected override function registerListeners():void`

removeControledFeature | () | method |

`public function removeControledFeature(feature:Feature):void`

This function is used for removing a feature from the the feature click handler controled features

Parameters

| `feature:Feature` — feature to remove

removeControledFeatures | () | method |

`public function removeControledFeatures(features:Array = null):void`

This function is used for removing an array of features from the the feature click handler controled features

Parameters

| `features:Array` (default = `null`)`` — array of features to remove

unregisterListeners | () | method |

`protected override function unregisterListeners():void`