com.moximedia.aims
Class AimsLayerListLegend

java.lang.Object
  extended bycom.moximedia.aims.AimsLayerListLegend
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class AimsLayerListLegend
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Stores the properties of a layer's layer list legend.

Author:
Doug Cates - www.moximedia.com
See Also:
Serialized Form

Constructor Summary
AimsLayerListLegend()
          Creates a new instance of AimsLayerListLegend
 
Method Summary
 java.lang.Object clone()
          Gets a clone of this object.
 AimsLayerListLegend getCopy()
          Gets a copy of this object.
 int getHeight()
          Gets the height for the legend.
 double getMaxScale()
          Gets the maximum displayable scale for the legend.
 double getMinScale()
          Gets the minimum displayable scale for the legend.
 java.lang.String getUrl()
          Gets the url for the legend.
 int getWidth()
          Gets the widthfor the legend.
 void setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value, java.lang.String layerPath, java.lang.String imfPath)
          Sets one of the attributes of this object using a string value.
 void setHeight(int height)
          Sets the height for the legend.
 void setMaxScale(double scale)
          Sets the maximum displayable scale for the legend.
 void setMinScale(double scale)
          Sets the minimum displayable scale for the legend.
 void setUrl(java.lang.String url)
          Sets the url for the legend.
 void setWidth(int width)
          Sets the width for the legend.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AimsLayerListLegend

public AimsLayerListLegend()
Creates a new instance of AimsLayerListLegend

Method Detail

clone

public java.lang.Object clone()
Gets a clone of this object.

Returns:
The clone.

getCopy

public AimsLayerListLegend getCopy()
Gets a copy of this object.

Returns:
The copy.

getHeight

public int getHeight()
Gets the height for the legend.

Returns:
The height.

setHeight

public void setHeight(int height)
Sets the height for the legend.

Parameters:
height - The width.

getMaxScale

public double getMaxScale()
Gets the maximum displayable scale for the legend.

Returns:
The maximum scale. Note that the value is inclusive.

setMaxScale

public void setMaxScale(double scale)
Sets the maximum displayable scale for the legend.

Parameters:
scale - The maximum scale. Note that the value is exclusive.

getMinScale

public double getMinScale()
Gets the minimum displayable scale for the legend.

Returns:
The minimum scale.

setMinScale

public void setMinScale(double scale)
Sets the minimum displayable scale for the legend.

Parameters:
scale - The minimum scale.

getUrl

public java.lang.String getUrl()
Gets the url for the legend.

Returns:
The url.

setUrl

public void setUrl(java.lang.String url)
Sets the url for the legend.

Parameters:
url - The URL.

getWidth

public int getWidth()
Gets the widthfor the legend.

Returns:
The width.

setWidth

public void setWidth(int width)
Sets the width for the legend.

Parameters:
width - The width.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value,
                            java.lang.String layerPath,
                            java.lang.String imfPath)
Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:
tag - The AXL element tag containing this attribute (not used).
name - The AXL attribute name.
value - The AXL attribute value.
layerPath - The path to the layer configuration file.
imfPath - The path to IMF.


Internet Mapping Framework for ArcIMS Java Object Model API (v5.0.004)
Copyright © 2005 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.