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

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

This handler is used to have an edition Mode Which allow to modify all types of geometries

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | active : Boolean [write-only] inheritDoc | FeatureLayerEditionHandler
|  | layerToEdit : FeatureLayer The layer concerned by the Modification | FeatureLayerEditionHandler
|  | map : Map [write-only] inheritDoc | FeatureLayerEditionHandler
|  | toggleHandlerActivity : Function Getter and setter of the callback function used when the handler's activity changes | Handler

Public Methods

| Method | Defined by
--- | --- | ---
|  | FeatureLayerEditionHandler(map:Map = null, layer:FeatureLayer = null, active:Boolean = false, editPoint:Boolean = true, editPath:Boolean = true, editPolygon:Boolean = true) Handler of edition mode | FeatureLayerEditionHandler

Protected Methods

| Method | Defined by
--- | --- | ---
|  | editionModeStart():Boolean Start the edition Mode | FeatureLayerEditionHandler
|  | editionModeStop():Boolean Stop the edition Mode | FeatureLayerEditionHandler
|  | registerListeners():void | FeatureLayerEditionHandler
|  | unregisterListeners():void | FeatureLayerEditionHandler

Property detail

active | property

`active:Boolean` [write-only]

inheritDoc

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

layerToEdit | property |

`layerToEdit:FeatureLayer` [read-write]

The layer concerned by the Modification

Implementation
`public function get layerToEdit():FeatureLayer`
`public function set layerToEdit(value:FeatureLayer):void`

map | property |

`map:Map` [write-only]

inheritDoc

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

FeatureLayerEditionHandler | () | constructor

`public function FeatureLayerEditionHandler(map:Map = null, layer:FeatureLayer = null, active:Boolean = false, editPoint:Boolean = true, editPath:Boolean = true, editPolygon:Boolean = true)`

Handler of edition mode

Parameters

| `map:Map` (default = `null`)`` — to know if the edition of point is allowed
| `layer:FeatureLayer` (default = `null`)`` — to know if the edition of path is allowed
| `active:Boolean` (default = `false`)`` — to know if the edition of polygon is allowed
| `editPoint:Boolean` (default = `true`)``
| `editPath:Boolean` (default = `true`)``
| `editPolygon:Boolean` (default = `true`)``

Method detail

editionModeStart | () | method

`protected function editionModeStart():Boolean`

Start the edition Mode

Returns

| `Boolean`

editionModeStop | () | method |

`protected function editionModeStop():Boolean`

Stop the edition Mode

Returns

| `Boolean`

registerListeners | () | method |

`protected override function registerListeners():void`

unregisterListeners | () | method |

`protected override function unregisterListeners():void`