Module description

Module to handle search results. Displays partial result set in list view, each page lists part of result set. Interface includes start-previous-next-end buttons to view pages in result set.

The information displayed is constructed from the <location> attributes (fields) for the result set. See section 3.4.1 for attribute reference.

List items contain buttons for each location in result set. Buttons display additional information on mouseover and performs other actions when clicked. Buttons are dimmed when no data is present or attribute is missing.

Distance calculation are shown for distance searches, sorted by distance. Attribute search does not produce distance information.

Fig 4.2.1a Module
Configuring the module
The module is configured when loaded into the locator application. Section 3.5 describes the use of the <loadmodule> tag to load a module into the the application. The table and figure below describes the code set between the opening <loadmodule> and closing </loadmodule> tags. All code set within the <loadmodule> tag is directed to the module when the module is completely loaded and initialized.

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

<prefs
search_module_name="SZS1a"
new_search_button="on"
email_handler="js"
link_handler="js"
/>

</loadmodule>
Fig 4.2.1b Configuring module
Module RLV1 <prefs>
AttributeValues / Range Default 1 Notes
distance_units mi, km mi 2
search_module_name text, module name   3
new_search_button off, on off 3
info_target _blank
_top
_self
_parent
or frame name 		_blank 4
info_link_prefix URL   7
email_target _self or _blank _self 5
email_handler js, flash js 6
website_target _blank
_top
_self
_parent
or frame name 		_blank 4
map_target _blank
_top
_self
_parent
or frame name 		_blank 4
map_link_prefix URL   7
link_handler js, flash flash 6
dim_IEWM_btn integer, percent 50 8
Notes
  1. Default value persists if attribute is omitted from tag.
  2. Distance units (miles or kilometers) for distance searches only.
  3. Hides or shows the search button. Search button shows the specified module.
  4. Window to target links from list item buttons I-@-W-M. Targeting controlled by JavaScript if email_handler or link_handler is set to js.
  5. Internet explorer sometimes handles mailto: links from Flash incorrectly. Default setup is to call on JavaScript function on email clicks, the email_handler is set to js by default.
  6. Email and link handlers can either be directly from Flash (flash) or via JavaScript (js). JavaScript function may be edited if needed when value is set to js. Window targeting is controlled by JavaScript if link_handler is specified as js.
  7. Prefix URL is added to the beginning of a link. This allows <location> data to only contain the remaining portion of a link.
  8. Inactive I-@-W-M list item buttons are dimmed. This attribute controls dim level (0 is invisible) of inactive buttons
Table 4.2.1c Tag Reference