Library Reference  

ArcGIS Server Java ADF Web Control Tag Library

List of tags in tag library

context
fieldValidator
geocode
htmlBase
identifyResults
map
noCache
northArrow
overview
pageLayout
scaleBar
scroller
toc

Introduction

This tag library contains JavaServer Faces component tags for all UIComponents defined by the ArcGIS server Java ADF. The tag attributes can be divided into three categories:

The tag prefix used in all the examples is "ags:". The prefix value should match the value assigned in the tag library directive in your JSP file, for example, <%@ taglib uri="http://www.esri.com/arcgis/webcontrols" prefix="ags" %>.

More information about JavaServer Faces and the Java ADF is available in Chapter 6, Developing Web Applications with Java, in the ArcGIS Server Administrator and Developer Guide.

Conventions for interpreting the tags are given at the end of this document.

Changes in 9.0 SP2

All controls can be placed on a page using relative positioning. This is the default. Prior to this release, controls were placed on the page using absolute positioning. Values for the height, width, left, and top attributes that were required before are no longer required.

Absolute positioning. When absolute positioning is used, the browser places the control on the page at the x,y pixel location defined by the left and top of the control. For example, if the left value is 5 and the top value is 10, the top left corner of the control is placed 5 pixels from the left and 10 pixels from the top of the upper left-hand corner of the page. Valid values for absolute positioning are integer values 0 or higher for the left and top attributes in a control.

Relative positioning. When relative positioning is used, the browser places the control in the next available place in the flow of the page. For example, if two controls are used, the second control would be placed immediately to the right of the first control. An HTML table can be used to place the controls in the desired location on the page. To use relative positioning, set the value of the left and top attributes of a control to -1.

Changes in 9.1


context

Parent tags:

None

Syntax

<ags:context  

     Attributes used by the server:
     (r) id ="string"
     dataFrame ="Default in map file"
     preserve ="true | false"  [true]
     resource ="string"
     resourceType ="map | geocode"  [map]
     unboundClassName ="string"
>

     (m) <ags:geocode... />
     (m) <ags:identify_results... />
     (m) <ags:map... />
     (m) <ags:north_arrow... />
     (m) <ags:overview... />
     (m) <ags:pagelayout... />
     (m) <ags:scale_bar... />
     (m) <ags:scroller... />
     (m) <ags:toc... />

</ags:context >
(r): Attribute is required.
(m):  Subtag can be used multiple times.


Description:

Establishes and maintains a connection with the GIS server.

Notes:

Attribute Descriptions for context:

Attribute Usage
dataFrame Specifies a dataframe other than the default. The default is the active data frame when the map file is saved.
id Programmatic name of the control.
preserve By default, the context is stored in session. When preserve is "true", when dynamically switching the "resource" to a second context, the old context is saved. When switching back to the first context, it is loaded from session and preserved in the same state where it was left, i.e., zoomed to a certain location. Note that saving contexts takes up memory. When preserve is "false", old contexts are not maintained in session after a new one is specified. If you do not need to preserve contexts or want to minimize memory usage, set preserve to "false".
resource Name of server object in the form of ServerObject@Server. For example, a map server object named "world" on a server named "esrimaps" is represented as "world@esrimaps".
resourceType A server object can be either a map or geocode type. Map types are used for generating maps and acting on map data. Geocode types allow for address matching.
unboundClassName Specifies the name of the class that implements an unbound case, which is a custom class for using the Web controls outside of ArcGIS Server. An example would be accessing an ArcIMS service. The custom class would represent the top level context needed to access ArcIMS through the context tag. Other classes would need to be implemented to make the rest of the tags in the library functional with ArcIMS.

The Java Application Developer Framework (ADF), by default, works with the AGSWebContext, which is the default implementation of the abstract WebContext. Users can make the ADF work with their own implementation of the WebContext by specifying the fully classified class name of their custom implementation using unboundClassName. The context control and its child controls will then work with this new implementation of the WebContext. For more information, refer to the "Accessing ArcIMS service" sample under Server Development|Web Applications in the ArcGIS Developer Help.


Sample

When controls are nested within the context.
<ags:noCache />
<html>
<head>
      <ags:htmlBase />
</head>
<body>
<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
      <ags:map ... />
      <ags:overview ... />
      <ags:toc ... />
</ags:context>
</body>
</html>

When controls are buddied. In this example, each buddied control references the context control using the contextId attribute.
<ags:noCache />
<html>
<head>
      <ags:htmlBase />
</head>
<body>
<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" />

<ags:map contextId="mapContext"... />
<ags:overview contextId="mapContext"... />
<ags:toc contextId="mapContext"... />
</body>
</html>


Back to top


fieldValidator

Parent tags:

None

Syntax

<ags:fieldValidator  

     Attributes used by the server:
     allowDigits ="true | false"  [true]
     allowLetters ="true | false"  [true]
     specialCharacters ="string"
>

     No Child Elements
</ags:fieldValidator >


Description:

Validates strings in input fields.

Attribute Descriptions for fieldValidator:

Attribute Usage
allowDigits Users are allowed to input number characters.
allowLetters Users are allowed to input letter characters.
specialCharacters A list of special characters allowed in a string.
  • No separator is needed between characters.
  • White space is considered a special character.
  • Double quotes must be preceded by a backslash (\").
  • A backslash must be represented as two backslashes (\\).
In the following example, a single quote, a double quote, and a space are permitted.

fieldValidator specialCharacters="'\" "


Sample

<ags:context id="searchContext" resource="NorthAmericaMap@MyMachineName">

  <jsfh:inputText id="txtSearch" value="#{sessionScope['searchContext'].attributes['esriAGSFindResults'].searchString}" >

    <ags:fieldValidator specialCharacters=".' " />

  </jsfh:inputText>

  <jsfh:commandButton id="cmdSearch" action="#{sessionScope['searchContext'].attributes['esriAGSFindResults'].doFind}" value="Find"/>

</ags:context>



Back to top


geocode

Parent tags:

context  

Syntax

<ags:geocode  

     Attributes used by the server:
     minimumCandidateScore ="0 - 100"  [Default in locator file]
     minimumMatchScore ="0 - 100"  [Default in locator file]
     showAllCandidates ="true | false"  [false]
     xslFile ="string"  [geocode.xsl]

     Attributes used by the client:
     cssClass ="string"
     height ="integer"
     left ="-1, 0 - NNN"  [-1]
     top ="-1, 0 - NNN"  [-1]
     width ="integer"

     Attributes used by both the client and server:
     contextId ="string"
     id ="string"
     mapContextId ="string"
     visible ="true | false"  [true]
>

     No Child Elements
</ags:geocode >


Description:

Renders the input fields that allow you to enter address information. This control works with the address style from the locator to determine the input fields to display. For example, if the address style is US Streets with Zone, the control will render an address and ZIP code text box. The results of a geocode operation are put into a data table.

Notes:

Attribute Descriptions for geocode:

Attribute Usage
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a geocode context is referenced, an error results.
cssClass Cascading style sheet class.
height Height of control in pixels.
id Programmatic name of the control.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
mapContextId ID of the map context to which this control is buddied. The geocode control needs access to the map context to display the "Map" button in the geocoded results. The map context must be placed on the page before the geocode control can reference it.
minimumCandidateScore When a geocoding service searches for likely candidates in the reference data, it uses this threshold to determine whether a potential candidate should be considered. Candidates that yield a match score lower than this threshold will not be considered. The minimum candidate score for a geocoding service is a value between 0 and 100. The default value for the geocode server object is the same as when you created the locator. You can override the value set in the locator by setting a different value for minimumCandidateScore.
minimumMatchScore The minimum match score setting, a value between 0 and 100, lets you control how well addresses have to match their most likely candidate in the reference data in order to be considered matched. A perfect match yields a score of 100. A match score between 75 and 100 can generally be considered a good match. An address below the minimum match score is considered to have no match. The default value for the geocode server object is the same as when you created the locator. You can override the value set in the locator by setting a different value for minimumMatchScore.
showAllCandidates Lists all of the candidates that the geocoding service generated regardless of the score set in minimumMatchScore. By default, only the candidates that meet or exceed the minimum match score are shown.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the geocode control. By default, geocode in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

When geocode and dataTable are in separate contexts.
<ags:context id="geocodeContext" resource="locator@localhost" resourceType="geocode">
    <ags:geocode id="geocode1" left="45" top="15" width="688">
        <jsfc:attribute name="fieldAlias:Street" value="Address" />
        <jsfc:attribute name="fieldAlias:Zone" value="ZIP Code" />
    </ags:geocode>
</ags:context>
<ags:context id="mapContext" resource="map@localhost">
    <!- Map control ->
    <ags:map .../>
    <!- Geocode result Data Table ->
    <jsfh:dataTable id="geocodeTable"
        binding="#{sessionScope['geocodeContext'].webGeocode.results.dataComponent}"
        value="#{sessionScope['geocodeContext'].webGeocode.results.resultRows}"
        rendered="#{sessionScope['geocodeContext'].webGeocode.results.count > 0}" >
    </jsfh:dataTable>

    <!- Geocode result Scroller Component ->
    <ags:scroller id="idScroller" dataComponent="geocodeTable" left="300" top="250" height="20" width="400" ... />
</ags:context>

When controls are buddied. In this example, the map control references the map context, and the geocode control references both the geocode and map contexts, using the contextId and mapContextId attributes, respectively.
<!- Geocode context ->
<ags:context id="geocodeContext" resource="locator@localhost" resourceType="geocode" />

<!- Map context ->
<ags:context id="mapContext" resource="map@localhost" />

<!- Geocode control ->
<ags:geocode id="geocode1" contextId="geocodeContext" mapContextId="mapContext" left="45" top="15" width="688">
    <jsfc:attribute name="fieldAlias:Street" value="Address" />
    <jsfc:attribute name="fieldAlias:Zone" value="ZIP Code" />
</ags:geocode>

<!- Map control ->
<ags:map contextId="mapContext" .../>

<!- Geocode result Data Table ->
<jsfh:dataTable id="geocodeTable"
    binding="#{sessionScope['geocodeContext'].webGeocode.results.dataComponent}"
    value="#{sessionScope['geocodeContext'].webGeocode.results.resultRows}"
    rendered="#{sessionScope['geocodeContext'].webGeocode.results.count > 0}" >
    </jsfh:dataTable>

<!- Geocode result Scroller Component ->
<ags:scroller id="idScroller" dataComponent="geocodeTable" left="300" top="250" height="20" width="400" ... />

When geocode and dataTable are in the same context.
<ags:context id="geocodeContext" resource="Redlands_Locator@mymachine" resourceType="geocode">
    <ags:geocode id="myGeocode" left="0" top="0" width="688">
        <jsfc:attribute name="fieldAlias:Street" value="Address" />
        <jsfc:attribute name="fieldAlias:Zone" value="ZIP Code" />
    </ags:geocode>

    <P>&nbsp;</P>

    <!-- Geocode result Data Table -->
    <jsfh:dataTable id="geocodeTable"
        binding="#{sessionScope['geocodeContext'].webGeocode.results.dataComponent}"
        value="#{sessionScope['geocodeContext'].webGeocode.results.resultRows}"
        rendered="#{sessionScope['geocodeContext'].webGeocode.results.count > 0}">
    </jsfh:dataTable>

</ags:context>


Back to top


htmlBase

Parent tags:

None

Syntax

<ags:htmlBase >
     No Attributes

     No Child Elements
</ags:htmlBase >


Description:

Generates an HTML <BASE href=". . ." /> tag to support relative URL references.

Notes:

 

Sample

<ags:noCache />
<html>
<head>
    <ags:htmlBase />
</head>
<body>...</body>
</html>


Back to top


identifyResults

Parent tags:

None

Syntax

<ags:identifyResults  

     Attributes used by the server:
     xslFile ="string"  [identifyResults.xsl]

     Attributes used by the client:
     cssClass ="string"
     height ="integer"  [530]
     left ="-1, 0 - NNN"  [-1]
     top ="-1, 0 - NNN"  [-1]
     width ="integer"  [600]

     Attributes used by both the client and server:
     contextId ="string"
     id ="string"
     visible ="true | false"  [true]
>

     No Child Elements
</ags:identifyResults >


Description:

Displays the results from the interaction of the identify tool.

Attribute Descriptions for identifyResults:

Attribute Usage
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
cssClass Cascading style sheet class.
height Height of control in pixels.
id Programmatic name of the control.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the identifyResults control. By default, identifyResults.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
    <ags:overview ... />
    <ags:toc ... />
    <ags:map id="Map0" ... />
    
    <ags:identifyResults id="myIdentifyResults" left="30" top="10" width="500" height="500" cssClass="identifyClass" />
    <img name="identifyImage" src="graphics/identify.gif" onmousedown="MapPoint('Map0', 'Identify');" / >
    
    <ags:scaleBar ... />
    <ags:northArrow ... />
</ags:context>


Back to top


map

Parent tags:

context  

Syntax

<ags:map  

     Attributes used by the server:
     copyrightFontBold ="true | false"  [false]
     copyrightFontColorRGB ="0,0,0 - 255,255,255"  [0,0,0]
     copyrightFontItalic ="true | false"  [false]
     copyrightFontName ="string"  [Arial]
     copyrightFontSize ="integer"  [12]
     copyrightLeft ="integer"
     copyrightText ="string"
     copyrightTop ="integer"
     imageFormat ="JPG | GIF | PNG | PNG24 | BMP"  [PNG]
     toolItemCollection ="string"  [default]
     useMIMEData ="true | false"  [true]
     xslFile ="string"  [map.xsl]

     Attributes used by the client:
     borderColor ="color"
     borderStyle ="NotSet | None | Dotted | Dashed | Double | Groove | Inset | Outset | Ridge | Solid"
     borderWidth ="integer"  [0]
     cssClass ="string"
     dragBoxColor ="color"  [DarkGray]
     dragLineWidth ="integer"  [3]
     left ="-1, 0 - NNN"  [-1]
     toolTip ="string"
     top ="-1, 0 - NNN"  [-1]

     Attributes used by both the client and server:
     (r) id ="string"
     activeTool ="string"
     contextId ="string"
     height ="integer"  [400]
     visible ="True | False"  [True]
     width ="integer"  [400]
>

     No Child Elements
</ags:map >
(r): Attribute is required.


Description:

Displays the map on the page.

Attribute Descriptions for map:

Attribute Usage
activeTool The active tool in the Web application. In the client code, activeTool calls the approriate Javascript method. In the server code, activeTool calls the appropriate server-side tool action.
borderColor Border color around control. Defining colors using hexadecimal values (#80F0C0) is recommended. The border is not shown unless borderWidth and borderStyle have values.
borderStyle Border style around control in pixels. The border is not shown unless borderWidth also has a value. When borderWidth does have a value, borderStyle defaults to "solid".
borderWidth Border width around control in pixels. This attribute must be set in the JSP tag. It cannot be set in the cssClass or the associated XSL file. The border width is needed in the calculations for the output and must be present before generating the control. This process can take place only in the JSP tag.
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
copyrightFontBold Determines whether copyright text is bolded.
copyrightFontColorRGB Copyright text color. The color is defined by its red, green, and blue values, which range in value from 0 to 255:  copyrightFontColorRGB="0,255,0"
copyrightFontItalic Determines whether copyright text is italicized.
copyrightFontName Font name used for copyright text. The name is case sensitive. If font name uses "&", use "&amp;" instead. For example, ESRI Transportation & Civic should be written as ESRI Transportation &amp; Civic.
copyrightFontSize Font size used for copyright text.
copyrightLeft Left position on map in pixels to place copyright text.
copyrightText Copyright text string included on map.
copyrightTop Top position on map in pixels to place copyright text.
cssClass Cascading style sheet class.
dragBoxColor Color to use for area of interest box when zooming or selecting features. Defining colors using hexadecimal values (#80F0C0) is recommended.
dragLineWidth The width in pixels of the drag box used for zooming to or selecting features.
height Height of control in pixels.
id Programmatic name of the control.
imageFormat Image format for output.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
toolItemCollection Points to an xml file that contains information on the tools. The default value is "default", and this point to a file name default.xml in the WEB-INF/classes/tools directory. A value of "mytools" would point to a file name mytools.xml in the same WEB-INF/classes/tools directory.
toolTip Tool tip text string.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
useMIMEData When set to "false", all generated images are written to the designated output directory. The output directory must be visible to both the ServerObject and the Web server.

When set to "true", the data is delivered from the ServerObject in byte arrays. The Java Application Developer Framework provides a delivery mechanism to transfer this set of bytes to the Web pages. During this process, the bytes are cached to disk or held in session memory. When you deploy a Web application, you can specify a cache directory using the "cache_directory" property in the arcgis_webapps.properties file. This file is located in the <web_app_name>/WEB-INF/classes directory. This directory must have write permissions to use disk caching. If the property is not set, the bytes are held in the Web session's memory.

When useMIMEData is "true", Netscape browser users may find that the map and associated images do not refresh as expected. This is because the URL remains the same, and Netscape, by default, re-uses the image from a previous draw. Users should set the Netscape cache so that it checks for a new page during each refresh. To set this up, go to Edit > Preferences > Advanced > Cache and under "Compare the page in the cache to the page on the network", select "Every time I view the page".
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the map control. By default, map.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

When controls are nested within the context.
<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
    <ags:overview ... />
    <ags:toc ... />

    <ags:map id="myMap1" left="16" top="30" width="500" height="500" visible="True" imageFormat="JPG" copyrightText="(c) 2004. Use freely." activeTool="ZoomOut" borderColor="green" borderStyle="dashed" borderWidth="5" toolTip="North America Map" dragLineWidth="1" dragBoxColor="CC00FF"/>

    <ags:scaleBar ... />
    <ags:northArrow ... />
</ags:context>

When controls are buddied. In this example, each buddied control references the context control using the contextId attribute.
<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" />
<ags:overview contextId="mapContext"... />
<ags:toc contextId="mapContext"... />

<ags:map id="myMap1" contextId="mapContext" left="16" top="30" width="500" height="500" visible="True" imageFormat="JPG" copyrightText="(c) 2004. Use freely activeTool="ZoomOut" borderColor="green" borderStyle="dashed" borderWidth="5" toolTip="North America Map" dragLineWidth="1 dragBoxColor="CC00FF"/>

<ags:scaleBar contextId="mapContext"... />
<ags:northArrow contextId="mapContext"... />


Back to top


noCache

Parent tags:

None

Syntax

<ags:noCache >
     No Attributes

     No Child Elements
</ags:noCache >


Description:

Prevents a browser from caching the generated page.

Notes:

 

Sample

<ags:noCache />
<html>
<head>
    <ags:htmlBase />
</head>


Back to top


northArrow

Parent tags:

None

Syntax

<ags:northArrow  

     Attributes used by the server:
     charIndex ="integer"  [177]
     fontColorRGB ="0,0,0 - 255,255,255"  [0,0,0]
     fontName ="string"  [ESRI North]
     imageFormat ="JPG | GIF | PNG | PNG24 | BMP"  [PNG]
     size ="integer"  [60]
     useMIMEData ="true | false"  [true]
     xslFile ="string"  [northArrow.xsl]

     Attributes used by the client:
     borderColor ="color"
     borderStyle ="NotSet | None | Dotted | Dashed | Double | Groove | Inset | Outset | Ridge | Solid"
     borderWidth ="integer"  [0]
     cssClass ="string"
     left ="-1, 0 - NNN"  [-1]
     toolTip ="string"
     top ="-1, 0 - NNN"  [-1]

     Attributes used by both the client and server:
     contextId ="string"
     height ="integer"  [100]
     id ="string"
     visible ="true | false"  [true]
     width ="integer"  [100]
>

     No Child Elements
</ags:northArrow >


Description:

Displays the selected north arrow on the page.

Attribute Descriptions for northArrow:

Attribute Usage
borderColor Border color around control. Defining colors using hexadecimal values (#80F0C0) is recommended. The border is not shown unless borderWidth and borderStyle have values.
borderStyle Border style around control in pixels. The border is not shown unless borderWidth also has a value. When borderWidth does have a value, borderStyle defaults to "solid".
borderWidth Border width around control in pixels. This attribute must be set in the JSP tag. It cannot be set in the cssClass or the associated XSL file. The border width is needed in the calculations for the output and must be present before generating the control. This process can take place only in the JSP tag.
charIndex Index value of character or symbol in a given font set.
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
cssClass Cascading style sheet class.
fontColorRGB North arrow color. The color is defined by its red, green, and blue values, which range in value from 0 to 255:  fontColorRGB="0,255,0"
fontName Font name used. The name is case sensitive. If font name uses "&", use "&amp;" instead. For example, ESRI Transportation & Civic should be written as ESRI Transportation &amp; Civic.
height Height of control in pixels.
id Programmatic name of the control.
imageFormat Image format for output.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
size Sets the size of the north arrow in points.
toolTip Tool tip text string.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
useMIMEData When set to "false", all generated images are written to the designated output directory. The output directory must be visible to both the ServerObject and the Web server.

When set to "true", the data is delivered from the ServerObject in byte arrays. The Java Application Developer Framework provides a delivery mechanism to transfer this set of bytes to the Web pages. During this process, the bytes are cached to disk or held in session memory. When you deploy a Web application, you can specify a cache directory using the "cache_directory" property in the arcgis_webapps.properties file. This file is located in the <web_app_name>/WEB-INF/classes directory. This directory must have write permissions to use disk caching. If the property is not set, the bytes are held in the Web session's memory.

When useMIMEData is "true", Netscape browser users may find that the map and associated images do not refresh as expected. This is because the URL remains the same, and Netscape, by default, re-uses the image from a previous draw. Users should set the Netscape cache so that it checks for a new page during each refresh. To set this up, go to Edit > Preferences > Advanced > Cache and under "Compare the page in the cache to the page on the network", select "Every time I view the page".
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the northArrow control. By default, northArrow.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
    <ags:map ... />    
    <ags:overview ... />

    <ags:northArrow id="myNorthArrow1" left="400" top="230" width="50" height="60" charIndex="199" fontName="Esri North"     fontColorRGB="255,0,255" cssClass="northArrowClass" borderColor="FF00FF" borderStyle="solid" borderWidth="1" toolTip="North is 90 Degrees     Up" />

    <ags:scaleBar ... />
</ags:context>


Back to top


overview

Parent tags:

context  

Syntax

<ags:overview  

     Attributes used by the server:
     dataFrame ="string"
     imageFormat ="JPG | GIF | PNG | PNG24 | BMP"  [PNG]
     resource ="string"
     showFullExtent ="true | false"  [true]
     useMIMEData ="true | false"  [true]
     xslFile ="string"  [overview.xsl]

     Attributes used by the client:
     borderColor ="color"
     borderStyle ="NotSet | None | Dotted | Dashed | Double | Groove | Inset | Outset | Ridge | Solid"
     borderWidth ="integer"  [0]
     cssClass ="string"
     dragBoxColor ="color"  [Red]
     dragLineWidth ="integer"  [3]
     left ="-1, 0 - NNN"  [-1]
     toolTip ="string"
     top ="-1, 0 - NNN"  [-1]

     Attributes used by both the client and server:
     contextId ="string"
     height ="integer"  [200]
     id ="string"
     visible ="true | false"  [true]
     width ="integer"  [200]
>

     No Child Elements
</ags:overview >


Description:

Displays the overview map of the associated map, and draws a rectangle representing the current area of interest.

Attribute Descriptions for overview:

Attribute Usage
borderColor Border color around control. Defining colors using hexadecimal values (#80F0C0) is recommended. The border is not shown unless borderWidth and borderStyle have values.
borderStyle Border style around control in pixels. The border is not shown unless borderWidth also has a value. When borderWidth does have a value, borderStyle defaults to "solid".
borderWidth Border width around control in pixels. This attribute must be set in the JSP tag. It cannot be set in the cssClass or the associated XSL file. The border width is needed in the calculations for the output and must be present before generating the control. This process can take place only in the JSP tag.
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
cssClass Cascading style sheet class.
dataFrame Name of data frame to use to calculate the extent for the overview map. The default behavior of the overview map is to show the full extent image of the focus map. If dataFrame is specified, then the overview map shows the full extent image of this data frame for all data frames in the server object.
dragBoxColor Color to use for area of interest box. Defining colors using hexadecimal values (#80F0C0) is recommended.
dragLineWidth The width in pixels of the area of interest box.
height Height of control in pixels.
id Programmatic name of the control.
imageFormat Image format for output.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
resource Name of server object in the form of ServerObject@Server. For example, a map server object named "world" on a server named "esrimaps" is represented as "world@esrimaps".
showFullExtent Sets whether the overview map should show at full extent or the intial map extent.
toolTip Tool tip text string.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
useMIMEData When set to "false", all generated images are written to the designated output directory. The output directory must be visible to both the ServerObject and the Web server.

When set to "true", the data is delivered from the ServerObject in byte arrays. The Java Application Developer Framework provides a delivery mechanism to transfer this set of bytes to the Web pages. During this process, the bytes are cached to disk or held in session memory. When you deploy a Web application, you can specify a cache directory using the "cache_directory" property in the arcgis_webapps.properties file. This file is located in the <web_app_name>/WEB-INF/classes directory. This directory must have write permissions to use disk caching. If the property is not set, the bytes are held in the Web session's memory.

When useMIMEData is "true", Netscape browser users may find that the map and associated images do not refresh as expected. This is because the URL remains the same, and Netscape, by default, re-uses the image from a previous draw. Users should set the Netscape cache so that it checks for a new page during each refresh. To set this up, go to Edit > Preferences > Advanced > Cache and under "Compare the page in the cache to the page on the network", select "Every time I view the page".
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the overview control. By default, overview.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
    <ags:map ... />

    <ags:overview id="myOverviewMap1" left="32" top="6" height="150" width="225" resource="WorldMap@mySecondMachineName" visible="True"     imageFormat="PNG24" cssClass="overviewClass" borderColor="rgb(255,255,0)" borderStyle="inset" borderWidth="3" toolTip="Global Overview"     dragBoxColor="Gray" dragLineWidth="1" />

    <ags:scaleBar ... />
    <ags:toc ... />
</ags:context>


Back to top


pageLayout

Parent tags:

context  

Syntax

<ags:pageLayout  

     Attributes used by the server:
     imageFormat ="JPG | GIF | PNG | PNG24 | BMP"  [PNG]
     toolItemCollection ="string"  [default]
     useMIMEData ="true | false"  [true]
     xslFile ="string"  [pageLayout.xsl]

     Attributes used by the client:
     borderColor ="color"
     borderStyle ="NotSet | None | Dotted | Dashed | Double | Groove | Inset | Outset | Ridge | Solid"
     borderWidth ="integer"  [0]
     cssClass ="string"
     dragBoxColor ="color"  [DarkGray]
     dragLineWidth ="integer"  [3]
     left ="-1, 0 - NNN"  [-1]
     toolTip ="string"
     top ="-1, 0 - NNN"  [-1]

     Attributes used by both the client and server:
     (r) id ="string"
     activeTool ="string"
     contextId ="string"
     height ="integer"  [400]
     visible ="true | false"  [true]
     width ="integer"  [400]
>

     No Child Elements
</ags:pageLayout >
(r): Attribute is required.


Description:

Displays the page layout.

Attribute Descriptions for pageLayout:

Attribute Usage
activeTool The active tool in the Web application. In the client code, activeTool calls the approriate Javascript method. In the server code, activeTool calls the appropriate server-side tool action.
borderColor Border color around control. Defining colors using hexadecimal values (#80F0C0) is recommended. The border is not shown unless borderWidth and borderStyle have values.
borderStyle Border style around control in pixels. The border is not shown unless borderWidth also has a value. When borderWidth does have a value, borderStyle defaults to "solid".
borderWidth Border width around control in pixels. This attribute must be set in the JSP tag. It cannot be set in the cssClass or the associated XSL file. The border width is needed in the calculations for the output and must be present before generating the control. This process can take place only in the JSP tag.
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
cssClass Cascading style sheet class.
dragBoxColor Color to use for area of interest box when zooming or selecting features. Defining colors using hexadecimal values (#80F0C0) is recommended.
dragLineWidth The width in pixels of the drag box used for zooming to or selecting features.
height Height of control in pixels.
id Programmatic name of the control.
imageFormat Image format for output.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
toolItemCollection Points to an xml file that contains information on the tools. The default value is "default", and this point to a file name default.xml in the WEB-INF/classes/tools directory. A value of "mytools" would point to a file name mytools.xml in the same WEB-INF/classes/tools directory.
toolTip Tool tip text string.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
useMIMEData When set to "false", all generated images are written to the designated output directory. The output directory must be visible to both the ServerObject and the Web server.

When set to "true", the data is delivered from the ServerObject in byte arrays. The Java Application Developer Framework provides a delivery mechanism to transfer this set of bytes to the Web pages. During this process, the bytes are cached to disk or held in session memory. When you deploy a Web application, you can specify a cache directory using the "cache_directory" property in the arcgis_webapps.properties file. This file is located in the <web_app_name>/WEB-INF/classes directory. This directory must have write permissions to use disk caching. If the property is not set, the bytes are held in the Web session's memory.

When useMIMEData is "true", Netscape browser users may find that the map and associated images do not refresh as expected. This is because the URL remains the same, and Netscape, by default, re-uses the image from a previous draw. Users should set the Netscape cache so that it checks for a new page during each refresh. To set this up, go to Edit > Preferences > Advanced > Cache and under "Compare the page in the cache to the page on the network", select "Every time I view the page".
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the pageLayout control. By default, pageLayout.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags::context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >

    <ags:pageLayout id="myPageLayout1" left="20" top="30" heigh="500" width="400" visible="True" imageFormat="GIF" cssClass="pageLayoutClass"     activeTool="PageMapZoomOut" borderColor="FF66CC" borderStyle="Groove" borderWidth="10" toolTip="North America Page Layout"     dragLineWidth="2" dragBoxColor="Magenta" />

    <ags:toc ... />
</ags:context>


Back to top


scaleBar

Parent tags:

None

Syntax

<ags:scaleBar  

     Attributes used by the server:
     barColorRGB ="0,0,0 - 255,255,255"
     barHeight ="1.0 - nnn"  [6.0]
     divisions ="1 - nnn"  [2]
     divisionsBeforeZero ="0 - nnn"  [1]
     fontBold ="true | false"  [false]
     fontColorRGB ="0,0,0 - 255,255,255"  [0,0,0]
     fontItalic ="true | false"  [false]
     fontName ="string"  [Arial]
     fontSize ="integer"  [12]
     imageFormat ="JPG | GIF | PNG | PNG24 | BMP"  [PNG]
     subdivisions ="0 - nnn"  [2]
     type ="Alternating | DoubleAlternating | Hollow | ScaleLine | SingleDivision | SteppedScaleLine"  [Alternating]
     units ="miles | feet | kilometers | meters | centimeters | decimaldegrees | decimeters | inches | millimeters | nauticalmiles | points | yards"  [miles]
     useMIMEData ="true | false"  [true]
     xslFile ="string"  [scaleBar.xsl]

     Attributes used by the client:
     borderColor ="color"
     borderStyle ="NotSet | None | Dotted | Dashed | Double | Groove | Inset | Outset | Ridge | Solid"
     borderWidth ="integer"  [0]
     cssClass ="string"
     left ="-1, 0 - NNN"  [-1]
     toolTip ="string"
     top ="-1, 0 - NNN"  [-1]

     Attributes used by both the client and server:
     contextId ="string"
     height ="integer"  [40]
     id ="string"
     visible ="true | false"  [true]
     width ="integer"  [300]
>

     No Child Elements
</ags:scaleBar >


Description:

Displays the scale bar of the associated map.

Attribute Descriptions for scaleBar:

Attribute Usage
barColorRGB Scale bar color. The color is defined by its red, green, and blue values, which range in value from 0 to 255:  barColorRGB="0,255,0"
barHeight Sets the bar height of the control in points. Value should be 1.0 or greater.
borderColor Border color around control. Defining colors using hexadecimal values (#80F0C0) is recommended. The border is not shown unless borderWidth and borderStyle have values.
borderStyle Border style around control in pixels. The border is not shown unless borderWidth also has a value. When borderWidth does have a value, borderStyle defaults to "solid".
borderWidth Border width around control in pixels. This attribute must be set in the JSP tag. It cannot be set in the cssClass or the associated XSL file. The border width is needed in the calculations for the output and must be present before generating the control. This process can take place only in the JSP tag.
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
cssClass Cascading style sheet class.
divisions Sets the total number of divisions in the scale bar. The value should be 1 or greater.
divisionsBeforeZero Sets the number of divisions before zero in the scale bar. The value should be 0 or greater.
fontBold Determines whether font is bolded.
fontColorRGB Scale bar font color. The color is defined by its red, green, and blue values, which range in value from 0 to 255:  fontColorRGB="0,255,0"
fontItalic Determines whether font is italicized.
fontName Font name used. The name is case sensitive. If font name uses "&", use "&amp;" instead. For example, ESRI Transportation & Civic should be written as ESRI Transportation &amp; Civic.
fontSize Font size used in display.
height Height of control in pixels.
id Programmatic name of the control.
imageFormat Image format for output.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
subdivisions Sets the number of subdivisions in the scale bar. The value should be 0 or greater.
toolTip Tool tip text string.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
type Scale bar format.
units Units used for calculating scale.
useMIMEData When set to "false", all generated images are written to the designated output directory. The output directory must be visible to both the ServerObject and the Web server.

When set to "true", the data is delivered from the ServerObject in byte arrays. The Java Application Developer Framework provides a delivery mechanism to transfer this set of bytes to the Web pages. During this process, the bytes are cached to disk or held in session memory. When you deploy a Web application, you can specify a cache directory using the "cache_directory" property in the arcgis_webapps.properties file. This file is located in the <web_app_name>/WEB-INF/classes directory. This directory must have write permissions to use disk caching. If the property is not set, the bytes are held in the Web session's memory.

When useMIMEData is "true", Netscape browser users may find that the map and associated images do not refresh as expected. This is because the URL remains the same, and Netscape, by default, re-uses the image from a previous draw. Users should set the Netscape cache so that it checks for a new page during each refresh. To set this up, go to Edit > Preferences > Advanced > Cache and under "Compare the page in the cache to the page on the network", select "Every time I view the page".
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the scaleBar control. By default, scaleBar.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
    <ags:map ... />
    <ags:overview ... />

    <ags:scaleBar id="myScaleBar1" left="100" top="300" width="150" height="50" cssClass="scaleBarClass" imageFormat="JPG" fontName="Tahoma"     fontSize="11" fontBold="true" fontItalic="false" fontColorRGB="0,0,150" barColorRGB="0,0,150" type="SteppedScaleLine" units="kilometers"     borderWidth="0" toolTip="Scale in Kilometers" />

    <ags:northArrow ... />
</ags:context>


Back to top


scroller

Parent tags:

None

Syntax

<ags:scroller  

     Attributes used by the server:
     (r) dataComponent ="string"
     xslFile ="string"  [scroller.xsl]

     Attributes used by the client:
     cssClass ="string"
     height ="integer"
     left ="-1, 0 - NNN"  [-1]
     top ="-1, 0 - NNN"  [-1]
     width ="integer"

     Attributes used by both the client and server:
     id ="string"
>

     No Child Elements
</ags:scroller >
(r): Attribute is required.


Description:

Implements paging for a data table of results, such as results from a search or buffer operation.

Attribute Descriptions for scroller:

Attribute Usage
cssClass Cascading style sheet class.
dataComponent The UIData component to associate with the scroller.
height Height of control in pixels.
id Programmatic name of the control.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
width Width of control in pixels.
xslFile References an xsl file associated with the scroller control. By default, scroller in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags:context id="searchContext" resource="NorthAmericaMap@MyMachineName">

    <jsfh:commandButton id="cmdSearch" action="#{sessionScope['searchContext'].attributes['esriAGSFindResults'].doFind}" value="Find"/>

    <!-- Find results Data table -->
    <jsfh:dataTable id="findTable"
        binding="#{sessionScope['searchContext'].attributes['esriAGSFindResults'].dataComponent}"
        value="#{sessionScope['searchContext'].attributes['esriAGSFindResults'].resultRows}"
        var="result"
        rendered="#{sessionScope['searchContext'].attributes['esriAGSFindResults'].count > 0}"
    >
        <jsfh:column id="colHeader1">
            <jsfc:facet name="header"><jsfh:outputText value="Value" /></jsfc:facet>
            <jsfh:outputText  value="#{result.value}" />
        </jsfh:column>
        <jsfh:column id="colHeader2">
            <jsfc:facet name="header"><jsfh:outputText value="Field" /></jsfc:facet>
            <jsfh:outputText value="#{result.field}" />
        </jsfh:column>
        <jsfh:column id="colHeader3">
            <jsfc:facet name="header"><jsfh:outputText value="Layer" /></jsfc:facet>
            <jsfh:outputText value="#{result.layerName}" />
        </jsfh:column>
    </jsfh:dataTable>

    <!-- Find result Scroller Component -->
    <ags:scroller id="idScroller" dataComponent="findTable" left="300" top="240" height="20" width="400" cssClass="scrollerClass" />

</ags:context>


Back to top


toc

Parent tags:

context  

Syntax

<ags:toc  

     Attributes used by the server:
     autoPostBack ="true | false"  [true]
     expandAllDataFrames ="true | false"  [false]
     expandLevel ="-1, 0 - nnn"  [-1]
     imageFormat ="JPG | GIF | PNG | PNG24 | BMP"  [PNG]
     showAllDataFrames ="true | false"  [true]
     useMIMEData ="true | false"  [true]
     xslFile ="string"  [toc.xsl]

     Attributes used by the client:
     backColor ="color"
     borderColor ="color"
     borderStyle ="NotSet | None | Dotted | Dashed | Double | Groove | Inset | Outset | Ridge | Solid"
     borderWidth ="integer"  [0]
     collapsedImageURL ="string"
     cssClass ="string"
     expandedImageURL ="string"
     fontColor ="color"
     fontFamily ="string"
     fontSize ="integer"
     fontStyle ="normal | italic"
     fontWeight ="bold | bolder | lighter | normal | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900"
     height ="integer"  [300]
     indent ="integer"  [5]
     left ="-1, 0 - NNN"  [-1]
     minusImage ="string"  [images/minus.gif]
     plusImage ="string"  [images/plus.gif]
     selectedImageURL ="string"
     showPlus ="true | false"  [true]
     toolTip ="string"
     top ="-1, 0 - NNN"  [-1]
     width ="integer"  [200]

     Attributes used by both the client and server:
     contextId ="string"
     id ="string"
     visible ="true | false"  [true]
>

     No Child Elements
</ags:toc >


Description:

Displays the Table of Contents of the associated map.

Attribute Descriptions for toc:

Attribute Usage
autoPostBack Causes an automatic postback when there is a change in state.
backColor Background color of area represented by the control. Defining colors using hexadecimal values (#80F0C0) is recommended.
borderColor Border color around control. Defining colors using hexadecimal values (#80F0C0) is recommended. The border is not shown unless borderWidth and borderStyle have values.
borderStyle Border style around control in pixels. The border is not shown unless borderWidth also has a value. When borderWidth does have a value, borderStyle defaults to "solid".
borderWidth Border width around control in pixels. This attribute must be set in either the associated XSL file or as a JSP tag attribute. It cannot be set in the cssClass. The border width is needed in the calculations for the output and must be present before the output is rendered. The cssClass gets processed after the output is rendered. If border width is set in both the JSP tag and the XSL file, the JSP value takes precedence.
collapsedImageURL Image to represent a collapsed node in the TOC tree.
contextId ID of the context to which this control is buddied.  For example, to associate this control when context id="myContext",  then specify "myContext" for the contextId value for this control.  If contextId is not set, the control defaults to the first context listed on the page.  If a context other than a map context is referenced, an error results.
cssClass Cascading style sheet class.
expandAllDataFrames When set to "false", only the focus map?s data frame is expanded. When set to "true", all data frames are expanded.
expandedImageURL Image to represent an expanded node in the TOC tree.
expandLevel Sets the number of levels to be expanded by default. The default (-1) is to expand to the deepest level of the table of contents, which shows the swatches. Other valid values are integers 0 or greater. The maximum value depends on the number of levels in a given map document.
fontColor Font color used in control. Defining colors using hexadecimal values (#80F0C0) is recommended.
fontFamily Font name used. The name is case sensitive. If font name uses "&", use "&amp;" instead. For example, ESRI Transportation & Civic should be written as ESRI Transportation &amp; Civic.
fontSize Font size used in control.
fontStyle Determines whether font is normal or italicized.
fontWeight Font boldness. Different values may not appear to be different in a browser but will appear different when printed. A value of 100 is very light, and a value of 900 is very dark.
height Height of control in pixels.
id Programmatic name of the control.
imageFormat Image format for output.
indent Number of spaces to indent in the TOC hierarchy.
left When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the left position on the page in pixels.
minusImage Location of clickable image representing an expanded node in the table of contents. When clicked, the node collapses.
plusImage Location of clickable image representing a collapsed node in the table of contents. When clicked, the node expands.
selectedImageURL Image to represent an selected node in the TOC tree.
showAllDataFrames By default, only the selected or default data frame is included in the TOC. When set to "true", all data frames for the map server object are included in the TOC.
showPlus Determines whether the TOC shows "+" or "-" buttons next to expandable nodes.
toolTip Tool tip text string.
top When a value of "-1" is used, the control is placed on the page using relative positioning. If a value 0 or greater is used, the control is placed on the page using absolute positioning. The value represents the top position on the page in pixels.
useMIMEData When set to "false", all generated images are written to the designated output directory. The output directory must be visible to both the ServerObject and the Web server.

When set to "true", the data is delivered from the ServerObject in byte arrays. The Java Application Developer Framework provides a delivery mechanism to transfer this set of bytes to the Web pages. During this process, the bytes are cached to disk or held in session memory. When you deploy a Web application, you can specify a cache directory using the "cache_directory" property in the arcgis_webapps.properties file. This file is located in the <web_app_name>/WEB-INF/classes directory. This directory must have write permissions to use disk caching. If the property is not set, the bytes are held in the Web session's memory.

When useMIMEData is "true", Netscape browser users may find that the map and associated images do not refresh as expected. This is because the URL remains the same, and Netscape, by default, re-uses the image from a previous draw. Users should set the Netscape cache so that it checks for a new page during each refresh. To set this up, go to Edit > Preferences > Advanced > Cache and under "Compare the page in the cache to the page on the network", select "Every time I view the page".
visible Determines whether control is visible when page is first accessed.
width Width of control in pixels.
xslFile References an xsl file associated with the toc control. By default, toc.xsl in the WEB-INF/classes/xsl directory is used, and no value needs to be assigned to this attribute. If you want to use a different xsl with the map control, you must reference the new xsl file. For example, if the xsl file is named myxsl.xsl, it should be placed in the WEB-INF/classes/xsl directory, and the value "myxsl.xsl" should be assigned to this attribute.


Sample

<ags:context id="mapContext" resource="NorthAmericaMap@MyMachineName" dataFrame="USA" resourceType="map" >
    <ags:map ... />
    <ags:overview ... />

    <ags:toc id="myTOC1" left="13" top="8" width="200" height="400" showAllDataFrames="True" visible="True" imageFormat="PNG" cssClas="theTocClass"     backColor="EEEEEE" borderColor="CCCCCC" borderStyle="dotted" borderWidth="2" toolTip="Table of Contents" fontColor="black" fontFamily="Garamond"     indent="3" selectedImageURL="siteImages/yellowTarget.gif" showPlus="true" />

    <ags:scaleBar ... />
</ags:context>


Back to top



Additional information

Conventions

The tag library structure includes the tag name, attributes, and any nested tags.

Tag Name

<ags:overview  (1)  

    Attributes used by the server:  (3)
    dataFrame="string"
    imageFormat="JPG | GIF | PNG | PNG24 | BMP" [PNG]
    ...

    Attributes used by the client:  (3)
    (r) left="integer"
    (r) top="integer"
    borderColor="color"
    ...

    Attributes used by both the client and server:  (3)
    id="string"
    visible="true | false" [true]
    ...
>

     No Child Elements  (4)
</ags:overview >  (2)
(r): Attribute is required.
  1. The opening tag starts with a less than symbol (<) and is followed by its name. Note that all tag names must be preceded by a prefix. The prefix used in all the examples is "ags:". The prefix value should match the value assigned in the JSP tag library directive, for example, <%@ taglib uri="http://www.esri.com/arcgis/webcontrols" prefix="ags" %>, in your JSP file. Tag names are case sensitive. The opening tag ends with a greater than symbol (>).
  2. The closing tag is similar to the opening tag. It begins with the less than symbol and a forward slash (/) and is followed by the prefix and its name. The tag ends with a greater than symbol.
  3. If the tag includes any attributes, they are included after the opening tag. Attributes are divided into three types: attributes used by the server, the client, and both the client and server.
  4. Any nested tags are inserted before the closing element.

Attributes

    (1) dataFrame="string" (4)
    imageFormat="JPG | GIF | PNG | PNG24 | BMP" (2)   [PNG] (3)

  1. Attributes are case sensitive. If the attribute is required, it is preceded by "(r)".
  2. If an attribute has a defined list of valid values, all possible values are listed. Only one value can be used at a time. Attribute values are always placed inside of double quotes (").
  3. If the attribute has a default value, it is listed in brackets after the attribute list or type.
  4. If an attribute does not have a list of known values, the value type is listed such as double, integer, string, and color.

Back to top


Defining colors

A color value can be defined in one of three ways:

Back to top