The <layer-list-icon> element is used to specify one or more user-defined icons
to appear on the layer list page beside the name of a given layer or group. The element
is used to specify the graphic image and document that will be called when the icon is
clicked by the user.
The script will be called with several extra parameters, foid = folder object id, goid =
group object id (if applicable), and loid = layer object id (if applicable). These values
may be helpful for dynamic scripts that handle multiple layers or groups.
| Frequency |
Description (in this context) |
|
PO+ |
The <layer-list-icon> element may appear zero or more times within the parent element in any order. |
|
POS+ |
The <layer-list-icon> element may appear zero or more times within the parent element in the specified sequence. |
| |
|
|
|
Attributes |
Description |
|
hint |
The text to display in the status bar when the user's mouse is over the graphic.
|
|
image-height |
The height of the graphic used in the layer list, in pixels. Required.
|
|
image-url |
The URL of the graphic used in the layer list. The URL can start with the special variable
$IMF to specify that the document is relative to the IMF installation directory. Absolute
URLs may also be used. URLs that don't start with http: or $IMF are resolved relative to
the location of the XML file. Required.
|
|
image-width |
The width of the graphic used in the layer list, in pixels. Required.
|
|
script-url |
The URL that will be called when the user clicks on the icon image in the layer list.
The URL can start with the special variable $IMF to specify that the document is
relative to the IMF installation directory. Absolute URLs may also be used. URLs
that don't start with http: or $IMF are resolved relative to the location of the
XML file. Required.
|
|
target-frame |
The name of the IMF viewer frame that the script will be executed in. If the name
is not a standard IMF frame, the document will be opened in a new window. Required.
|
|
use-layer-visibility |
An indicator of whether the layer list icon should only be shown when the layer is
visible. Valid values are "true" or "false". Required.
|
| |
|
|
Example:
<layer name="Some Layer" .....>
<layer-list-icon
image-heigh="12"
image-url="myIconImage.gif"
image-width= 12"
script-url="myIconScript.jsp"
target-frame="hiddenFrame"
use-layer-visibility="false"/>
</layer>
