Copyright URL.

Gets or sets the URL Request object that will be used to download copyright data.

Flag that, indicates whether to use default language & settings data without loading it from the server.

Defines the class that will be used by settings parser to create new map type.

The default value is com.afcomponents.umap.providers::MapType.

Defines the class that will be used by settings parser to create new tile layer.

The default value is com.afcomponents.umap.providers::TileLayer.

Language URL.

Gets or sets the URL Request object that will be used to download language data.

Reference to the URLLoader object that is used for loading data.

Indicates current loading state.

Can be one of the following:

Settings URL.

Gets or sets the URL Request object that will be used to download settings data.

Creates new XMLProvider object.

You should never use this class directly, instead use subclassing. You can specify URLRequest objects which will be used instead of the default ones.

Frees the resources accuired by the Provider.

Returns default copyright string.

Abstract function. Returns default copyright URL Request object.

Abstract function. Returns default language data for the Provider to parse.

Abstract function. Returns default language URL Request object.

Abstract function. Returns default settings data for the Provider to parse.

Abstract function. Returns default settings URL Request object.

Initializes the provider and starts the loading process.

Loads copyright information for the specified area from the url defined by the copyrightURL property. If copyright url is undefined, copyights are taken form the current map type's getCopyrights() call.

Please note that the copyright will not be loaded right away, instead it will be queued until the loader thread has finished loading the previous request. If a new request will be recieved before the queued request has started loading, only the newest request will be queued, and the older one will be discarded.

This method has a default implemetation: it just adds all the properties to the url and loads it. The properties include: map center, bounds if the map view, zoom level and map event. Map event can be one of the following constants, or an empty string:

Here is the template url (properties are in the square brackets):

[copyrightURL]?bounds=[bounds.width],[bounds.height]¢er=[lat],[lng]&zoom=[zoom]&event=[event]

After URL Request object is ready it should be loaded with loadNextCopyright(request) method.

Loads the queued copyright request. If the parameter is specified, overwrites the queued request.

Abstract method. Override it for custom copyright data parser. Don't forget to dispatch ControlEvent.COPYRIGHT_CHANGED event with the new copyright information.

Abstract method. Override it for language data parser.

Parses the XML data with the provider settings. Override it for custom settings data parser.

This method has a default implementation. It will define map types out of a XML data. Parameters

      <UMapProvider>
          <logo>http://myserver.com/provider_logo.png</logo>                       <!-- Provider logo -->
              <mapType>
                  <!-- Define new map type -->
                  <name>myMapType</name>                                           <!-- Map type name -->
                  <caption>My Map Type</caption>                                   <!-- Map type caption -->
                  <errorMessage>No tile.</errorMessage>                            <!-- Error message if tile is unavailable -->
                  <copyrightMessage>\x26#169;2008 - MyCompany Ltd.</copyrightMessage>    <!-- Default copyright message -->
                  <textColor>0x000000</textColor>                                  <!-- RGB color of the copyright string -->
                  <linkColor>0x7777CC</linkColor>                                  <!-- RGB color of the terms of use link -->
                  <layer>
                      <!-- Define new tile layer -->
                      <url><![CDATA[[server]/[version]/x[x]_y[y]_zoom[z].png]]></url>     <!-- Tile image URL (with wildcards) -->
                      <maxZoom>18</maxZoom>                                        <!-- Maximum zoom level -->
                      <type>com.afcomponents.umap.providers::TileLayer</type>        <!-- TileLayer class -->
                      <alpha>1.0</alpha>                                           <!-- Layer opacity [0..1] -->
                      <minZoom>1</minZoom>                                         <!-- Minimum zoom level -->
                      <noError>false</noError>                                     <!-- Display error message? -->
                      <version>ap.60</version>                                     <!-- Value for [version] wildcard -->
                      <servers>
                          <!-- Define one or more tile servers -->
                          <url>http://myserver.com/tiles</url>                     <!-- Server URL -->
                          <!-- more urls here -->
                      </servers>
                  </layer>
                  <!-- more layers here -->
              </mapType>
              <!-- more map types here -->
      </UmapProvider>

The Provider.LOADING_COPYRIGHT constant defines the value of the loadingState property of the Provider object that indicates that copyright information is being loaded at the moment.

The Provider.LOADING_IDLE constant defines the value of the loadingState property of the Provider object that indicates that no loading occurs at the moment.

The Provider.LOADING_LANGUAGE constant defines the value of the loadingState property of the Provider object that indicates that language file is being loaded at the moment.

The Provider.LOADING_SETTINGS constant defines the value of the loadingState property of the Provider object that indicates that settings file is being loaded at the moment.