com.moximedia.aims
Class AimsChartSymbol

java.lang.Object
  com.moximedia.aims.AimsChartSymbol

All Implemented Interfaces:

AimsSymbol, java.lang.Cloneable, java.io.Serializable

public class AimsChartSymbol

extends java.lang.Object

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

Implementation of an ArcIMS ChartSymbol.

See Also:

Serialized Form

Constructor Summary

AimsChartSymbol()
Creates new AimsChartSymbol

Method Summary

void	addChartValue(AimsChartValue cv) Adds a chart value object to the collection.
java.lang.Object	clone() Creates a copy of this symbol.
boolean	getAntialiasing() Gets the value of the attribute antialiasing.
java.util.Vector	getChartValues() Gets the collection of chart values.
int	getMaxSize() Gets the value of the attribute maxSize.
int	getMaxValue() Gets the value of the attribute maxValue.
int	getMinSize() Gets the value of the attribute minSize.
int	getMinValue() Gets the value of the attribute maxSize.
java.lang.String	getMode() Gets the value of the attribute mode.
AimsColor	getOutline() Gets the value of the attribute outline.
AimsColor	getShadow() Gets the value of the attribute shadow.
int	getSize() Gets the value of the attribute size.
java.lang.String	getSizeField() Gets the value of the attribute sizeField.
double	getTransparency() Gets the value of the attribute transparency.
void	highlight(AimsColor highlightColor, double transparency) Sets the symbol to the specified highlight color.
boolean	isModified() Returns a boolean value indicating whether the object has been modified by the user since it was loaded from the map service.
void	setAntialiasing(boolean antialiasing) Sets the value of attribute antialiasing.
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setMaxSize(int size) Sets the value of attribute maxSize.
void	setMaxValue(int value) Sets the value of attribute maxValue.
void	setMinSize(int size) Sets the value of attribute minSize.
void	setMinValue(int value) Sets the value of attribute minValue.
void	setMode(java.lang.String mode) Sets the value of attribute mode.
void	setModified(boolean isModified) Sets the modified flag of the object, indicating that it needs to be sent to the map server when the map is refreshed.
void	setOutline(AimsColor color) Sets the value of attribute outline.
void	setShadow(AimsColor color) Sets the value of attribute shadow.
void	setSize(int size) Sets the value of attribute size.
void	setSizeField(java.lang.String sizeField) Sets the value of attribute sizeField.
void	setTransparency(double transparency) Sets the value of attribute transparency.
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	toString() Returns a text representation of of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsChartSymbol

public AimsChartSymbol()

Creates new AimsChartSymbol

Method Detail

clone

public java.lang.Object clone()

Creates a copy of this symbol.

Specified by:

clone in interface AimsSymbol

Returns:

An object that is a copy of this symbol. The object must be cast to an AimsChartSymbol before use.

addChartValue

public void addChartValue(AimsChartValue cv)

Adds a chart value object to the collection.

Parameters:

cv - The AimsChartValue object to add.

getAntialiasing

public boolean getAntialiasing()

Gets the value of the attribute antialiasing.

Returns:

The value of the attribute antialiasing.

getChartValues

public java.util.Vector getChartValues()

Gets the collection of chart values.

Returns:

A Vector containing the chart values.

getMaxSize

public int getMaxSize()

Gets the value of the attribute maxSize.

Returns:

The value of the attribute maxSize.

getMaxValue

public int getMaxValue()

Gets the value of the attribute maxValue.

Returns:

The value of the attribute maxValue.

getMinSize

public int getMinSize()

Gets the value of the attribute minSize.

Returns:

The value of the attribute minSize.

getMinValue

public int getMinValue()

Gets the value of the attribute maxSize.

Returns:

The value of the attribute maxSize.

getMode

public java.lang.String getMode()

Gets the value of the attribute mode.

Returns:

The value of the attribute mode.

getOutline

public AimsColor getOutline()

Gets the value of the attribute outline.

Returns:

The value of the attribute outline.

getShadow

public AimsColor getShadow()

Gets the value of the attribute shadow.

Returns:

The value of the attribute shadow.

getSize

public int getSize()

Gets the value of the attribute size.

Returns:

The value of the attribute size.

getSizeField

public java.lang.String getSizeField()

Gets the value of the attribute sizeField.

Returns:

The value of the attribute sizeField.

getTransparency

public double getTransparency()

Gets the value of the attribute transparency.

Returns:

The value of the attribute transparency.

isModified

public boolean isModified()

Returns a boolean value indicating whether the object has been modified by the user since it was loaded from the map service.

Specified by:

isModified in interface AimsSymbol

Returns:

True if modified, otherwise false.

setAntialiasing

public void setAntialiasing(boolean antialiasing)

Sets the value of attribute antialiasing.

Parameters:

antialiasing - The value of attribute antialiasing.

setMaxSize

public void setMaxSize(int size)

Sets the value of attribute maxSize.

Parameters:

size - The value of attribute maxSize.

setMaxValue

public void setMaxValue(int value)

Sets the value of attribute maxValue.

Parameters:

value - The value of attribute maxValue.

setMinSize

public void setMinSize(int size)

Sets the value of attribute minSize.

Parameters:

size - The value of attribute minSize.

setMinValue

public void setMinValue(int value)

Sets the value of attribute minValue.

Parameters:

value - The value of attribute minValue.

setMode

public void setMode(java.lang.String mode)

Sets the value of attribute mode.

Parameters:

mode - The value of attribute mode. Valid values are "pie" and "bar".

setModified

public void setModified(boolean isModified)

Sets the modified flag of the object, indicating that it needs to be sent to the map server when the map is refreshed.

Specified by:

setModified in interface AimsSymbol

Parameters:

isModified - True if the object has been modified.

setOutline

public void setOutline(AimsColor color)

Sets the value of attribute outline.

Parameters:

color - The value of attribute outline.

setSize

public void setSize(int size)

Sets the value of attribute size.

Parameters:

size - The value of attribute size.

setSizeField

public void setSizeField(java.lang.String sizeField)

Sets the value of attribute sizeField.

Parameters:

sizeField - The value of attribute sizeField.

setShadow

public void setShadow(AimsColor color)

Sets the value of attribute shadow.

Parameters:

color - The value of attribute shadow.

setTransparency

public void setTransparency(double transparency)

Sets the value of attribute transparency.

Parameters:

transparency - The value of attribute transparency. Valid value is between 0 and 1 inclusive.

setAxlAttribute

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

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.

name - The AXL attribute name.

value - The AXL attribute value.

toString

public java.lang.String toString()

Returns a text representation of of this class.

Specified by:

toString in interface AimsSymbol

Returns:

A string describing the class

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsSymbol

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsSymbol

Parameters:

env - The AimsEnvironment object used to generate the proper AXL for the ArcIMS version in use.

Returns:

The AXL string to refresh this object.

highlight

public void highlight(AimsColor highlightColor,
                      double transparency)

Sets the symbol to the specified highlight color.

Specified by:

highlight in interface AimsSymbol

Parameters:

highlightColor - The color to use for highlighting features.