Interface modules

MapTron 1207 requires the installation of interface modules. The modules allows users to interact with the locator application. Without the modules, a blank area would appear on the web page.

Standard modules are supplied with the product package. These modules allow the user to initiate a search by specifying criteria and view / interact with the result set.

Interface modules are loaded and configured at startup. All modules are loaded, typically stacked one over the other in the order specified in the startup XML file. Modules are loaded "hidden" except for the one that is to "show" in the starting interface.

Fig 3.5a Loading interface modules
 
Loading the modules
The startup XML file MapTron1207.xml is edited to load modules as described in figure 3.5b below. The <loadmodule> tag is used for each module to be loaded. These tags are inserted after setting the application preferences.

<loadmodule name="RLV1d" option="hide">
</loadmodule>

<loadmodule name="SZS1a" option="show">
</loadmodule>

Fig 3.5b Loading of modules

Note that each module is named as specified by the name attribute. The name corresponds to part of the filename such that "RLV1d" loads module file MT1207mod-RLV1d.swf from the modules folder. The standard modules (RLV - Results List View) and (SZS - Search Zip State) are supplied with the product package.

The option attribute sets the module visibility after loading. This attribute is set to either "hide" or "show". Module stacking order is as specified in the XML startup file, first is on bottom. Stacking order is usually not a concern.

 
Configuring a module

Interface modules are configured when fully loaded into the MapTron1207 application. Configuration is set by the <prefs> tag contained within the <loadmodule></loadmodule> tags. Figure 3.5c shows basic setup. Specifics on configuring each module is detailed in section 4 of this manual.

Any XML placed between the <loadmodule></loadmodule> tags is transferred to the module specified by the name attribute when the module is loaded. The individual modules then execute the XML instructions.

<loadmodule name="RLV1d" option="hide">

<prefs
search_module_name="SZS1a"
new_search_button="on"
info_link_prefix="http://www.example.com?loc="
email_handler="js"
link_handler="js"
/>

</loadmodule>

<loadmodule name="SZS1a" option="show">

<prefs
destination_module_name="RLV1d"
destination_error_module="RLV1d"
/>

</loadmodule>

Fig 3.5c Configuring modules
 
MT1207 Application <loadmodule>
AttributeValues / Range Default 1 Notes
name text   2
option show, hide show  
Notes
  1. Default value persists if attribute is omitted from tag.
  2. Module name corresponds to module file name.
Table 3.5d Tag Reference