com.moximedia.aims
Class AimsLegend

java.lang.Object
  com.moximedia.aims.AimsLegend

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsLegend

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

Implementation of an ArcIMS Legend. There is one legend associated with an AimsMap object.

Author:

Doug Cates doug@moximedia.com

See Also:

Serialized Form

Constructor Summary

AimsLegend()
Creates new Legend

Method Summary

java.lang.Object	clone()
boolean	getAntialiasing() Gets the legend text antialiasing setting.
boolean	getAutoExtend() Gets the value of attribute autoExtend
AimsColor	getBackgroundColor() Gets the value of attribute backgroundColor
boolean	getCanSplit() Gets the value of attribute canSplit
int	getCellSpacing() Gets the value of attribute cellSpacing
int	getColumns() Gets the value of attribute columns
boolean	getDisplay() Gets the value of attribute display
java.lang.String	getFile() Gets the file of the legend of the last map produced.
java.lang.String	getFont() Gets the value of attribute font
int	getHeight() Gets the value of attribute height
java.lang.String	getImageType() Gets the image type as indicated by the type attribute of a GET_IMAGE response.
int	getLayerFontSize() Gets the value of attribute layerFontSize
boolean	getReverseOrder() Gets the value of attribute reverseOrder
java.lang.String	getSplitText() Gets the value of attribute splitText
int	getSwatchHeight() Gets the value of attribute swatchHeight
int	getSwatchWidth() Gets the value of attribute swatchWidth
java.lang.String	getTitle() Gets the value of attribute title
int	getTitleFontSize() Gets the value of attribute titleFontSize
AimsColor	getTransColor() Gets the value of attribute transColor
java.lang.String	getUrl() Gets the url of the legend of the last map produced.
int	getValueFontSize() Gets the value of attribute valueFontSize
int	getWidth() Gets the value of attribute width
boolean	isModified()
void	setAntialiasing(boolean doAntialiasing) Sets whether the legend text is antialiased.
void	setAutoExtend(boolean autoExtend) Sets the value of attribute autoExtend.
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value, java.lang.String server) Sets one of the attributes of this object using a string value.
void	setBackgroundColor(AimsColor backgroundColor) Sets the value of attribute backgroundColor.
void	setCanSplit(boolean canSplit) Sets the value of attribute canSplit.
void	setCellSpacing(int cellSpacing) Sets the value of attribute cellSpacing.
void	setColumns(int columns) Sets the value of attribute columns.
void	setDisplay(boolean display) Sets the value of attribute display.
void	setFile(java.lang.String file) Sets the file name of the image response.
void	setFont(java.lang.String font) Sets the value of attribute font.
void	setHeight(int height) Sets the value of attribute height.
void	setLayerFontSize(int layerFontSize) Sets the value of attribute layerFontSize.
void	setReverseOrder(boolean reverseOrder) Sets the value of attribute reverseOrder.
void	setSplitText(java.lang.String splitText) Sets the value of attribute splitText.
void	setSwatchHeight(int swatchHeight) Sets the value of attribute swatchHeight.
void	setSwatchWidth(int swatchWidth) Sets the value of attribute swatchWidth.
void	setTitle(java.lang.String title) Sets the value of attribute title.
void	setTitleFontSize(int titleFontSize) Sets the value of attribute titleFontSize.
void	setTransColor(AimsColor transColor) Sets the value of attribute transColor.
void	setUrl(java.lang.String url) Sets the url of the image response.
void	setValueFontSize(int valueFontSize) Sets the value of attribute valueFontSize.
void	setWidth(int width) Sets the value of attribute width.
java.lang.String	toAxlString() Returns the AXL string to refresh this object.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object.
java.lang.String	toAxlString(AimsMap map)
java.lang.String	toAxlString(AimsMap map, AimsEnvironment env) Returns the AXL string to refresh this object.
java.lang.String	toString() Returns a text representation of of this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AimsLegend

public AimsLegend()

Creates new Legend

Method Detail

clone

public java.lang.Object clone()

setAntialiasing

public void setAntialiasing(boolean doAntialiasing)

Sets whether the legend text is antialiased.

Parameters:

doAntialiasing - The antialiasing setting.

getAntialiasing

public boolean getAntialiasing()

Gets the legend text antialiasing setting.

Returns:

True if antialising is used, otherwise false.

getFile

public java.lang.String getFile()

Gets the file of the legend of the last map produced.

Returns:

The value of attribute file

setFile

public void setFile(java.lang.String file)

Sets the file name of the image response.

Parameters:

file - The file name of the image.

getUrl

public java.lang.String getUrl()

Gets the url of the legend of the last map produced.

Returns:

The value of attribute url

setUrl

public void setUrl(java.lang.String url)

Sets the url of the image response.

Parameters:

url - The URL to the image.

setAutoExtend

public void setAutoExtend(boolean autoExtend)

Sets the value of attribute autoExtend.

Parameters:

autoExtend - The attribute value.

getAutoExtend

public boolean getAutoExtend()

Gets the value of attribute autoExtend

Returns:

The value of attribute autoExtend

getBackgroundColor

public AimsColor getBackgroundColor()

Gets the value of attribute backgroundColor

Returns:

The value of attribute backgroundColor

setBackgroundColor

public void setBackgroundColor(AimsColor backgroundColor)

Sets the value of attribute backgroundColor.

Parameters:

backgroundColor - The attribute value.

setCanSplit

public void setCanSplit(boolean canSplit)

Sets the value of attribute canSplit.

Parameters:

canSplit - The attribute value.

getCanSplit

public boolean getCanSplit()

Gets the value of attribute canSplit

Returns:

The value of attribute canSplit

setCellSpacing

public void setCellSpacing(int cellSpacing)

Sets the value of attribute cellSpacing.

Parameters:

cellSpacing - The attribute value.

getCellSpacing

public int getCellSpacing()

Gets the value of attribute cellSpacing

Returns:

The value of attribute cellSpacing

setColumns

public void setColumns(int columns)

Sets the value of attribute columns.

Parameters:

columns - The attribute value.

getColumns

public int getColumns()

Gets the value of attribute columns

Returns:

The value of attribute columns

setDisplay

public void setDisplay(boolean display)

Sets the value of attribute display.

Parameters:

display - The attribute value.

getDisplay

public boolean getDisplay()

Gets the value of attribute display

Returns:

The value of attribute display

getImageType

public java.lang.String getImageType()

Gets the image type as indicated by the type attribute of a GET_IMAGE response.

Returns:

The image type, or null.

setFont

public void setFont(java.lang.String font)

Sets the value of attribute font.

Parameters:

font - The attribute value.

getFont

public java.lang.String getFont()

Gets the value of attribute font

Returns:

The value of attribute font

setHeight

public void setHeight(int height)

Sets the value of attribute height.

Parameters:

height - The attribute value.

getHeight

public int getHeight()

Gets the value of attribute height

Returns:

The value of attribute height

setLayerFontSize

public void setLayerFontSize(int layerFontSize)

Sets the value of attribute layerFontSize.

Parameters:

layerFontSize - The attribute value.

getLayerFontSize

public int getLayerFontSize()

Gets the value of attribute layerFontSize

Returns:

The value of attribute layerFontSize

setReverseOrder

public void setReverseOrder(boolean reverseOrder)

Sets the value of attribute reverseOrder.

Parameters:

reverseOrder - The attribute value.

getReverseOrder

public boolean getReverseOrder()

Gets the value of attribute reverseOrder

Returns:

The value of attribute reverseOrder

setSplitText

public void setSplitText(java.lang.String splitText)

Sets the value of attribute splitText.

Parameters:

splitText - The attribute value.

getSplitText

public java.lang.String getSplitText()

Gets the value of attribute splitText

Returns:

The value of attribute splitText

setSwatchHeight

public void setSwatchHeight(int swatchHeight)

Sets the value of attribute swatchHeight.

Parameters:

swatchHeight - The attribute value.

getSwatchHeight

public int getSwatchHeight()

Gets the value of attribute swatchHeight

Returns:

The value of attribute swatchHeight

setSwatchWidth

public void setSwatchWidth(int swatchWidth)

Sets the value of attribute swatchWidth.

Parameters:

swatchWidth - The attribute value.

getSwatchWidth

public int getSwatchWidth()

Gets the value of attribute swatchWidth

Returns:

The value of attribute swatchWidth

setTitle

public void setTitle(java.lang.String title)

Sets the value of attribute title.

Parameters:

title - The attribute value.

getTitle

public java.lang.String getTitle()

Gets the value of attribute title

Returns:

The value of attribute title

setTitleFontSize

public void setTitleFontSize(int titleFontSize)

Sets the value of attribute titleFontSize.

Parameters:

titleFontSize - The attribute value.

getTitleFontSize

public int getTitleFontSize()

Gets the value of attribute titleFontSize

Returns:

The value of attribute titleFontSize

getTransColor

public AimsColor getTransColor()

Gets the value of attribute transColor

Returns:

The value of attribute transColor

setTransColor

public void setTransColor(AimsColor transColor)

Sets the value of attribute transColor.

Parameters:

transColor - The attribute value.

setValueFontSize

public void setValueFontSize(int valueFontSize)

Sets the value of attribute valueFontSize.

Parameters:

valueFontSize - The attribute value.

getValueFontSize

public int getValueFontSize()

Gets the value of attribute valueFontSize

Returns:

The value of attribute valueFontSize

setWidth

public void setWidth(int width)

Sets the value of attribute width.

Parameters:

width - The attribute value.

getWidth

public int getWidth()

Gets the value of attribute width

Returns:

The value of attribute width

isModified

public boolean isModified()

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value,
                            java.lang.String server)

Sets one of the attributes of this object using a string value. This method can only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

toString

public java.lang.String toString()

Returns a text representation of of this object.

Returns:

A string describing the object

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsMap map)

toAxlString

public java.lang.String toAxlString(AimsMap map,
                                    AimsEnvironment env)

Returns the AXL string to refresh this object.

Returns:

The AXL string to refresh this object.