Moxi Media Inc.
<tools> Discussion Forum
IMF Developer's Guide » Site Configuration » <tools>  

The <tools> element is used to define a set of map tools. The tools element should contain multiple elements with button and tool definitions. Spaces can also be added between the buttons and tools on the toolbar.

You may define multiple toolsets with different names. Each toolset can contain a different set of tools and a separate help document to describe the tools. To open a toolset other than default when the site is started, follow the following example:

<tool-frame url="$IMF/imfTools.jsp?toolset=markup" />

To use the default toolset, the toolset argument above can be omitted, or called with the toolset named "default". To switch toolsets from a tool in the toolset, define a button as follows: 

<button name="Standard Tools"
        url="$IMF/imfTools.jsp?toolset=default"
        target="toolFrame"
        hint="Standard Tools"
        status="Shows the standard tool set."
        graphic="$IMF/tools/tools_close.gif"
        width="16" height="16" />

Frequency Parent Elements (this element is valid within):
PRS+ <site-config>
   

Frequency Child Elements:
O+ <button>
O+ <space>
O+ <tool>
   

Frequency Description (in this context)
PRS+ The <tools> element must appear one or more times within the parent <site-config> element in the specified sequence.
O+ The child element may appear zero or more times within the <tool> element in any order. However, at least one tool or button must be defined.
   

Attributes Description
active The name of the tool that is active when the site opens. Required.
description A text description of the toolset for use in the imfToolsets.jsp script that can be shown to the user to change toolsets.
help The help document for the toolset. Optional, defaults to "$IMF/imfHelp.jsp".
toolset The name of the toolset, made up by the designer. Use "default" if there is only one toolset defined. Required.
   

Example: 

<tools toolset="default" active="Zoom In" help="$IMF/imfHelp.jsp" description="The general set of basic map navigation tools.">
  <button name="Full Extent" url="JavaScript:fullExtent();" target="mapFrame" hint="Full Extent" help="$IMF/help/fullExtentButton.txt" status="Zoom to the designed full extent of this map." graphic="$IMF/tools/zoomfull.gif" width="16" height="16"/>
  <tool name="Zoom In" hint="Zoom In" help="$IMF/help/zoomInTool.txt" status="Zoom in to the point you click or the rectangle that you specify." graphic="$IMF/tools/zoomin_1.gif" active-graphic="$IMF/tools/zoomin_2.gif" width="16" height="16"/>
  <tool name="Zoom Out" hint="Zoom Out" help="$IMF/help/zoomOutTool.txt" status="Zoom out to the point you click or the zoom the window into an rectangle that you specify." graphic="$IMF/tools/zoomout_1.gif" active-graphic="$IMF/tools/zoomout_2.gif" width="16" height="16"/>
  <tool name="Pan" hint="Pan" help="$IMF/help/panTool.txt" status="Centre the map at the point you click or drag the map." graphic="$IMF/tools/pan_1.gif" active-graphic="$IMF/tools/pan_2.gif" width="16" height="16"/>
  <button name="Zoom Previous" url="JavaScript:previousExtent();" target="toolFrame" hint="Zoom Previous" help="$IMF/help/zoomPreviousButton.txt" status="Zoom to the extent of this map before your last extent change." graphic="$IMF/tools/zoomlast.gif" width="16" height="16"/>
  <button name="Index Map" url="$IMF/imfIndexMapCrosshair.jsp" target="dataFrame" hint="Index Map" status="Open an overview map that shows the position of the main map." graphic="$IMF/tools/toggleov.gif"/>
  <button name="Print" url="$IMF/imfPrintMapTemplateForm.jsp" target="dataFrame" hint="Print to PDF" help="$IMF/help/printMapButton.txt" status="Prepares a scaled map in PDF format." graphic="$IMF/tools/print_1.gif" width="16" height="16"/>
  <button name="Email" url="$IMF/imfEmailButton.jsp" target="dataFrame" hint="Email" help="$IMF/help/emailButton.txt" status="Send this map to someone by e-mail." graphic="$IMF/tools/mail_1.gif" width="16" height="16"/>
  <button name="Save Session" url="$IMF/imfSessionSaveToClient.jsp" target="dataFrame" hint="Save Session" status="Saves the current map settings for you to restore later." graphic="$IMF/tools/save_1.gif" width="16" height="16"/>
  <button name="Open Session" url="$IMF/imfSessionRestoreForm.jsp" target="dataFrame" hint="Open Session" status="Opens a project session saved on your server." graphic="$IMF/tools/open_1.gif" width="16" height="16"/>
  <space/>
  <tool name="Identify" hint="Identify" help="$IMF/help/identifyTool.txt" status="Display information about the features that you can click the map." graphic="$IMF/tools/identify_1.gif" active-graphic="$IMF/tools/identify_2.gif" width="16" height="16"/>
  <tool name="Drill Down Identify" hint="Identify visible" help="$IMF/help/drillIdentifyTool.txt" status="Display information about the features for all the visible layers where you click the map." graphic="$IMF/tools/drill_1.gif" active-graphic="$IMF/tools/drill_2.gif" width="16" height="16"/>
  <button name="Map Tips" url="$IMF/imfMapTipToggle.jsp" target="hiddenFrame" hint="Map Tips" status="Shows data from features when you hover the mouse over the map." graphic="$IMF/tools/maptips_off.gif" width="16" height="16"/>
  <tool name="Select" hint="Select" help="$IMF/help/selectTool.txt" status="Display information about the features that you can click the map." shape="box" graphic="$IMF/tools/select_1.gif" active-graphic="$IMF/tools/select_2.gif" width="16" height="16"/>
  <tool name="Select Radius" shape="point" handler="$IMF/imfSelectRadius.jsp" hint="Select Radius" status="Selects features within a distance of where you click on the map." graphic="$IMF/tools/select_circle_1.gif" active-graphic="$IMF/tools/select_circle_2.gif" width="16" height="16"/>
  <button name="Clear" url="$IMF/imfClear.jsp" target="dataFrame" hint="Clear Selection" help="$IMF/help/clearButton.txt" status="Unselects features and clears user added graphics." graphic="$IMF/tools/clearhighlight_1.gif"/>
  <space/>
  <tool name="Measure" shape="line" handler="$IMF/imfMeasure.jsp" hint="Measure Distance" options="units=feet" help="$IMF/help/measureTool.txt" status="Measures the distance between points where you click." graphic="$IMF/tools/measure_1.gif" active-graphic="$IMF/tools/measure_2.gif" width="16" height="16"/>
  <tool name="Measure Area" handler="$IMF/imfMeasureArea.jsp" shape="polygon" hint="Measure Area" options="units=feet" help="$IMF/help/measureAreaTool.txt" status="Measures the area of the polygon you draw." graphic="$IMF/tools/measurearea_1.gif" active-graphic="$IMF/tools/measurearea_2.gif" width="16" height="16" />
  <space/>
  <tool name="Point Markup" hint="Point Markup" shape="point" handler="$IMF/imfMarkupToolPoint.jsp" status="Adds user-defined points to the map." help="$IMF/help/markupPointTool.txt" graphic="$IMF/tools/markup_point1.gif" active-graphic="$IMF/tools/markup_point2.gif" width="18" height="18"/>
  <tool name="Line Markup" hint="Line Markup" shape="line" handler="$IMF/imfMarkupToolLine.jsp" status="Adds user-defined lines to the map." help="$IMF/help/markupLineTool.txt" graphic="$IMF/tools/markup_line1.gif" active-graphic="$IMF/tools/markup_line2.gif" width="18" height="18"/>
  <tool name="Rectangle Markup" hint="Rectangle Markup" shape="box" handler="$IMF/imfMarkupToolRectangle.jsp" status="Adds user-defined rectangles to the map." help="$IMF/help/markupRectangleTool.txt" graphic="$IMF/tools/markup_rect1.gif" active-graphic="$IMF/tools/markup_rect2.gif" width="18" height="18"/>
  <tool name="Polygon Markup" hint="Polygon Markup" shape="polygon" handler="$IMF/imfMarkupToolPolygon.jsp" status="Adds user-defined polygon to the map." help="$IMF/help/markupPolygonTool.txt" graphic="$IMF/tools/markup_polygon1.gif" active-graphic="$IMF/tools/markup_polygon2.gif" width="18" height="18"/>
  <tool name="TextMarkup" hint="Text Markup" shape="point" handler="$IMF/imfMarkupToolText.jsp" status="Adds user-defined text to the map." help="$IMF/help/markupTextTool.txt" graphic="$IMF/tools/markup_text1.gif" active-graphic="$IMF/tools/markup_text2.gif" width="18" height="18"/>
  <tool name="LabelMarkup" hint="Label Markup" shape="point" handler="$IMF/imfMarkupToolLabel.jsp" status="Adds a label from the feature table of a layer to the map at the point you click." help="$IMF/help/markupLabelTool.txt" graphic="$IMF/tools/markup_label1.gif" active-graphic="$IMF/tools/markup_label2.gif" width="18" height="18"/>
  <button name="Grid Markup" url="$IMF/imfGridMarkupForm.jsp" target="dataFrame" hint="Grid Markup" status="Adds a user defined grid to the map." help="$IMF/help/markupGridButton.txt" graphic="$IMF/tools/markup_grid1.gif" width="18" height="18"/>
  <tool name="Erase Markup" hint="Erase Markup" shape="box" handler="$IMF/imfMarkupToolErase.jsp" status="Removes user markup from the map using a point or a box." help="$IMF/help/markupEraseTool.txt" graphic="$IMF/tools/markup_erase1.gif" active-graphic="$IMF/tools/markup_erase2.gif" width="18" height="18"/>
  <button name="Clear" url="$IMF/imfClear.jsp" target="dataFrame" hint="Clear Selection" help="$IMF/help/clearButton.txt" status="Unselects features and clears user added graphics." graphic="$IMF/tools/clearhighlight_1.gif"/>
</tools>

Valid HTML 4.01!