| Package | org.openscales.core.control |
| Class | public class DataOriginators |
| Inheritance | DataOriginators  Control flash.display.Sprite |
| Property | Defined By | ||
|---|---|---|---|
 | active : Boolean | Control | |
| isReduced : Boolean
Indicates if the control display is normal or reduced
| Control | |
| map : Map [override]
Set the map linked to this DataOriginators control
| DataOriginators | ||
| originators : Vector.<DataOriginator>
Number of layers refering to a same originator. | DataOriginators | ||
| originatorsLayersCount : HashMap
Number of layers refering to a same originator. | DataOriginators | ||
| position : Pixel | Control | |
| Method | Defined By | ||
|---|---|---|---|
DataOriginators(position:Pixel = null)
Constructor of the class DataOriginators. | DataOriginators | ||
addOriginator(originator:DataOriginator):void
Add an originator in the list
If the originator exist : increment its layers count
Else add The originator in the list and set the layers count to 1
| DataOriginators | ||
addOriginators(layer:Layer):void
Add all originators of one layer
If the originator exist : increment its layers count
Else add The originator in the list and set the layers count to 1
| DataOriginators | ||
destroy():void [override]
| DataOriginators | ||
| draw():void | Control | |
findOriginatorByKey(key:String):DataOriginator
Find an originator in the originators list by its key. | DataOriginators | ||
onLayerChanged(event:LayerEvent):void
Call when a layerEvent occur
Three LayerEvent are handled :
LAYER_ADDED
LAYER_REMOVED
LAYER_VISIBLE_CHANGED
After this events originators have to be updated
| DataOriginators | ||
onMapChanged(event:MapEvent):void
Call when a MapEvent occur
MapEvent handled :
MOVE_END
After this events originators have to be updated. | DataOriginators | ||
| onMapLanguageChange(event:I18NEvent):void
to be overrided in sub classes
| Control | |
onOriginatorListChange(event:LayerEvent):void
Call when an LayerEvent.LAYER_CHANGED_ORIGINATORS occur (when the originators list of a layer changed)
LayerEvent handled : LAYER_CHANGED_ORIGINATORS
After this events originators have to be updated. | DataOriginators | ||
removeAll():void
Remove all the originators. | DataOriginators | ||
removeOriginator(originator:DataOriginator):void
Remove an originator in the list
If the originator layers count is > 1, decrement it
Else remove the originator from the list
| DataOriginators | ||
removeOriginators(layer:Layer):void
Remove all originators of a given layer. | DataOriginators | ||
| Control | ||
| toggleDisplay(event:Event = null):void | Control | |
updateOriginators():void
Update the current list of originators according to the current layers in the map. | DataOriginators | ||
| map | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesmap:Map[override] Set the map linked to this DataOriginators control
public function get map():Map public function set map(value:Map):void| originators | property |
originators:Vector.<DataOriginator>Number of layers refering to a same originator.
public function get originators():Vector.<DataOriginator> public function set originators(value:Vector.<DataOriginator>):void| originatorsLayersCount | property |
originatorsLayersCount:HashMapNumber of layers refering to a same originator.
public function get originatorsLayersCount():HashMap public function set originatorsLayersCount(value:HashMap):void| DataOriginators | () | Constructor |
public function DataOriginators(position:Pixel = null)Constructor of the class DataOriginators. The current layers on the map are use to create the fisrt list of originators This first list of originator is made by calling generateLinkedList.
Parametersposition:Pixel (default = null) |
| addOriginator | () | method |
public function addOriginator(originator:DataOriginator):voidAdd an originator in the list If the originator exist : increment its layers count Else add The originator in the list and set the layers count to 1
Parameters
originator:DataOriginator — The DataOriginator to add in the list
|
| addOriginators | () | method |
public function addOriginators(layer:Layer):voidAdd all originators of one layer If the originator exist : increment its layers count Else add The originator in the list and set the layers count to 1
Parameters
layer:Layer — The layer which contains a list of originators to add.
|
| destroy | () | method |
override public function destroy():void
| findOriginatorByKey | () | method |
public function findOriginatorByKey(key:String):DataOriginatorFind an originator in the originators list by its key.
Parameters
key:String — key of the searched originator.
|
DataOriginator — The DataOriginator corresponding to the given name if find
else return null
|
| onLayerChanged | () | method |
public function onLayerChanged(event:LayerEvent):voidCall when a layerEvent occur Three LayerEvent are handled : LAYER_ADDED LAYER_REMOVED LAYER_VISIBLE_CHANGED After this events originators have to be updated
Parameters
event:LayerEvent — The event received.
|
| onMapChanged | () | method |
public function onMapChanged(event:MapEvent):voidCall when a MapEvent occur MapEvent handled : MOVE_END After this events originators have to be updated.
Parameters
event:MapEvent — The event received.
|
| onOriginatorListChange | () | method |
public function onOriginatorListChange(event:LayerEvent):voidCall when an LayerEvent.LAYER_CHANGED_ORIGINATORS occur (when the originators list of a layer changed) LayerEvent handled : LAYER_CHANGED_ORIGINATORS After this events originators have to be updated.
Parameters
event:LayerEvent — The event received.
|
| removeAll | () | method |
public function removeAll():voidRemove all the originators.
| removeOriginator | () | method |
public function removeOriginator(originator:DataOriginator):voidRemove an originator in the list If the originator layers count is > 1, decrement it Else remove the originator from the list
Parameters
originator:DataOriginator — The DataOriginator to remove from the list
|
| removeOriginators | () | method |
public function removeOriginators(layer:Layer):voidRemove all originators of a given layer. If the originator layers count is > 1, decrement it Else remove the originator from the list
Parameters
layer:Layer — The layer which contains the originators list to remove.
|
| updateOriginators | () | method |
public function updateOriginators():voidUpdate the current list of originators according to the current layers in the map. Reset the layers counters to zero. Remove originator if no layer refer to it anymore. Add an originator if a layer refer to one which is not in the list. or increment the number of layers for the existing originator.