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

Package | org.openscales.core.configuration
Class | public class Configuration
Implements | IConfiguration

Sample XML OpenScales configuration format. Have a look to openscales-core/src/test/resources/configuration/sampleMapConfOk.xml for a sample valid XML file TODO : create an XML schema Don't forget : the map is create in actionScript, so values in the XML for the size are in pixel. If you want to use the map in your flex application (and thus use widht and height in percent), you'll have to redefine the size in you mxml.

Public Properties

| Property | Defined by
--- | --- | ---
|  | catalog : XMLList [read-only] | Configuration
|  | config : XML | Configuration
|  | controls : XMLList [read-only] | Configuration
|  | custom : XML [read-only] | Configuration
|  | handlers : XMLList [read-only] | Configuration
|  | layersFromCatalog : Array [read-only] | Configuration
|  | layersFromMap : Array [read-only] | Configuration
|  | securities : XMLList [read-only] | Configuration

Protected Properties

| Property | Defined by
--- | --- | ---
|  | _config : XML | Configuration

Public Methods

| Method | Defined by
--- | --- | ---
|  | Configuration(config:XML = null) | Configuration
|  | beginConfigureMap(map:Map):void | Configuration
|  | configureMap(map:Map):void | Configuration
|  | endConfigureMap(map:Map):void | Configuration
|  | middleConfigureMap(map:Map):void | Configuration
|  | parseLayer(xmlNode:XML):Layer | Configuration

Protected Methods

| Method | Defined by
--- | --- | ---
|  | parseControl(xmlNode:XML):Control | Configuration
|  | parseHandler(xmlNode:XML):Handler | Configuration
|  | parseSecurity(xmlNode:XML, map:Map):AbstractSecurity | Configuration

Property detail

catalog | property

`catalog:XMLList` [read-only]Implementation
`public function get catalog():XMLList`

_config | property |

`protected var _config:XML`

config | property |

`config:XML` [read-write]Implementation
`public function get config():XML`
`public function set config(value:XML):void`

controls | property |

`controls:XMLList` [read-only]Implementation
`public function get controls():XMLList`

custom | property |

`custom:XML` [read-only]Implementation
`public function get custom():XML`

handlers | property |

`handlers:XMLList` [read-only]Implementation
`public function get handlers():XMLList`

layersFromCatalog | property |

`layersFromCatalog:Array` [read-only]Implementation
`public function get layersFromCatalog():Array`

layersFromMap | property |

`layersFromMap:Array` [read-only]Implementation
`public function get layersFromMap():Array`

securities | property |

`securities:XMLList` [read-only]Implementation
`public function get securities():XMLList`
Constructor detail

Configuration | () | constructor

`public function Configuration(config:XML = null)`Parameters

| `config:XML` (default = `null`)``

Method detail

beginConfigureMap | () | method

`public function beginConfigureMap(map:Map):void` Parameters

| `map:Map`

configureMap | () | method |

`public function configureMap(map:Map):void` Parameters

| `map:Map`

endConfigureMap | () | method |

`public function endConfigureMap(map:Map):void` Parameters

| `map:Map`

middleConfigureMap | () | method |

`public function middleConfigureMap(map:Map):void` Parameters

| `map:Map`

parseControl | () | method |

`protected function parseControl(xmlNode:XML):Control` Parameters

| `xmlNode:XML`

Returns

| `Control`

parseHandler | () | method |

`protected function parseHandler(xmlNode:XML):Handler` Parameters

| `xmlNode:XML`

Returns

| `Handler`

parseLayer | () | method |

`public function parseLayer(xmlNode:XML):Layer` Parameters

| `xmlNode:XML`

Returns

| `Layer`

parseSecurity | () | method |

`protected function parseSecurity(xmlNode:XML, map:Map):AbstractSecurity` Parameters

| `xmlNode:XML`
| `map:Map`

Returns

| `AbstractSecurity`