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

Package | org.openscales.core.events
Class | public class FeatureEvent
Inheritance | FeatureEvent OpenScalesEvent flash.events.Event

Event related to a Feature.

Public Properties

| Property | Defined by
--- | --- | ---
|  | ctrlPressed : Boolean [read-only] To know if ctrl key is pressed | FeatureEvent
|  | feature : Feature Feature concerned by the event. | FeatureEvent
|  | features : Array Features concerned by the event. | FeatureEvent

Public Methods

| Method | Defined by
--- | --- | ---
|  | FeatureEvent(type:String, feature:Feature, ctrlStatus:Boolean = false, bubbles:Boolean = false, cancelable:Boolean = false, bounds:Bounds = null) FeatureEvent constructor | FeatureEvent

Public Constants

| Constant | Defined by
--- | --- | ---
|  | EDITION_POINT_FEATURE_DRAG_START : String = "org.openscales.editionFeature.dragstart" [static] Event type dispatched when we start dragging of a temporary features | FeatureEvent
|  | EDITION_POINT_FEATURE_DRAG_STOP : String = "org.openscales.editionFeature.dragstop" [static] Event type dispatched when we stop dragging of a temporary features | FeatureEvent
|  | FEATURE_CLICK : String = "openscales.feature.click" [static] Event type dispatched when a click occur on a feature. | FeatureEvent
|  | FEATURE_DELETING : String = "openscales.feature.deleting" [static] Event type dispatched when a feature is deleting | FeatureEvent
|  | FEATURE_DOUBLECLICK : String = "openscales.feature.doubleclick" [static] Event type dispatched when a double click occur on a feature. | FeatureEvent
|  | FEATURE_DRAGGING : String = "openscales.feature.dragging" [static] Event type dispatched while dragging a feature. | FeatureEvent
|  | FEATURE_DRAG_START : String = "openscales.feature.dragstart" [static] Event type dispatched when a feature's dragging start | FeatureEvent
|  | FEATURE_DRAG_STOP : String = "openscales.feature.dragstop" [static] Event type dispatched when a feature's dragging stop | FeatureEvent
|  | FEATURE_INSERT : String = "openscales.feature.insert" [static] Event type dispatched after inserting a new feature. | FeatureEvent
|  | FEATURE_MOUSEDOWN : String = "openscales.feature.mousedown" [static] Event type dispatched when left mouse button is down over a feature. | FeatureEvent
|  | FEATURE_MOUSEMOVE : String = "openscales.feature.mousemove" [static] Event type dispatched when the cursor is moving over a feature. | FeatureEvent
|  | FEATURE_MOUSEUP : String = "openscales.feature.mouseup" [static] Event type dispatched when left mouse button is up over a feature. | FeatureEvent
|  | FEATURE_OUT : String = "openscales.feature.out" [static] Event type dispatched when the cursor is leaving a feature. | FeatureEvent
|  | FEATURE_OVER : String = "openscales.feature.over" [static] Event type dispatched when the cursor is over a feature. | FeatureEvent
|  | FEATURE_PRE_INSERT : String = "openscales.feature.preinsert" [static] Event type dispatched before inserting a new feature. | FeatureEvent
|  | FEATURE_SELECTED : String = "openscales.feature.selected" [static] Event type dispatched when one or more features are selected. | FeatureEvent
|  | FEATURE_SHOW_INFORMATIONS : String = "org.openscales.feature.showinformations" [static] Event type dispatched when a feature is selected, and we want to update information in FeatureInfo component | FeatureEvent
|  | FEATURE_UNSELECTED : String = "org.openscales.feature.unselected" [static] Event type dispatched when one or more features are unselected. | FeatureEvent

Property detail

ctrlPressed | property

`ctrlPressed:Boolean` [read-only]

To know if ctrl key is pressed

The default value is `false`.

Implementation
`public function get ctrlPressed():Boolean`

feature | property |

`feature:Feature` [read-write]

Feature concerned by the event. If the event concern multiple features, the first one is returned.

Implementation
`public function get feature():Feature`
`public function set feature(value:Feature):void`

features | property |

`features:Array` [read-write]

Features concerned by the event. If only one feature is concerned, you should use the feature (without s) getter and setter.

Implementation
`public function get features():Array`
`public function set features(value:Array):void`
Constructor detail

FeatureEvent | () | constructor

`public function FeatureEvent(type:String, feature:Feature, ctrlStatus:Boolean = false, bubbles:Boolean = false, cancelable:Boolean = false, bounds:Bounds = null)`

FeatureEvent constructor

Parameters

| `type:String` — event
| `feature:Feature` — to determinates if the handler is active
| `ctrlStatus:Boolean` (default = `false`)``
| `bubbles:Boolean` (default = `false`)``
| `cancelable:Boolean` (default = `false`)``
| `bounds:Bounds` (default = `null`)``

Constant detail

EDITION_POINT_FEATURE_DRAG_START | constant

`public static const EDITION_POINT_FEATURE_DRAG_START:String = "org.openscales.editionFeature.dragstart"`

Event type dispatched when we start dragging of a temporary features

EDITION_POINT_FEATURE_DRAG_STOP | constant |

`public static const EDITION_POINT_FEATURE_DRAG_STOP:String = "org.openscales.editionFeature.dragstop"`

Event type dispatched when we stop dragging of a temporary features

FEATURE_CLICK | constant |

`public static const FEATURE_CLICK:String = "openscales.feature.click"`

Event type dispatched when a click occur on a feature.

FEATURE_DELETING | constant |

`public static const FEATURE_DELETING:String = "openscales.feature.deleting"`

Event type dispatched when a feature is deleting

FEATURE_DOUBLECLICK | constant |

`public static const FEATURE_DOUBLECLICK:String = "openscales.feature.doubleclick"`

Event type dispatched when a double click occur on a feature.

FEATURE_DRAGGING | constant |

`public static const FEATURE_DRAGGING:String = "openscales.feature.dragging"`

Event type dispatched while dragging a feature.

FEATURE_DRAG_START | constant |

`public static const FEATURE_DRAG_START:String = "openscales.feature.dragstart"`

Event type dispatched when a feature's dragging start

FEATURE_DRAG_STOP | constant |

`public static const FEATURE_DRAG_STOP:String = "openscales.feature.dragstop"`

Event type dispatched when a feature's dragging stop

FEATURE_INSERT | constant |

`public static const FEATURE_INSERT:String = "openscales.feature.insert"`

Event type dispatched after inserting a new feature.

FEATURE_MOUSEDOWN | constant |

`public static const FEATURE_MOUSEDOWN:String = "openscales.feature.mousedown"`

Event type dispatched when left mouse button is down over a feature.

FEATURE_MOUSEMOVE | constant |

`public static const FEATURE_MOUSEMOVE:String = "openscales.feature.mousemove"`

Event type dispatched when the cursor is moving over a feature.

FEATURE_MOUSEUP | constant |

`public static const FEATURE_MOUSEUP:String = "openscales.feature.mouseup"`

Event type dispatched when left mouse button is up over a feature.

FEATURE_OUT | constant |

`public static const FEATURE_OUT:String = "openscales.feature.out"`

Event type dispatched when the cursor is leaving a feature.

FEATURE_OVER | constant |

`public static const FEATURE_OVER:String = "openscales.feature.over"`

Event type dispatched when the cursor is over a feature.

FEATURE_PRE_INSERT | constant |

`public static const FEATURE_PRE_INSERT:String = "openscales.feature.preinsert"`

Event type dispatched before inserting a new feature.

FEATURE_SELECTED | constant |

`public static const FEATURE_SELECTED:String = "openscales.feature.selected"`

Event type dispatched when one or more features are selected.

FEATURE_SHOW_INFORMATIONS | constant |

`public static const FEATURE_SHOW_INFORMATIONS:String = "org.openscales.feature.showinformations"`

Event type dispatched when a feature is selected, and we want to update information in FeatureInfo component

FEATURE_UNSELECTED | constant |

`public static const FEATURE_UNSELECTED:String = "org.openscales.feature.unselected"`

Event type dispatched when one or more features are unselected.