com.moximedia.aims
Class AimsGradientFillSymbol

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

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

Implementation of an ArcIMS GradientFillSymbol.

Author:
Doug Cates doug@moximedia.com
See Also:
Serialized Form

Constructor Summary
AimsGradientFillSymbol()
          Creates new SimplePolygonSymbol with no arguments
 
Method Summary
 java.lang.Object clone()
          Creates a copy of this symbol.
 boolean getAntialiasing()
          Gets the value of attribute antialiasing
 AimsColor getFinishColor()
          Gets the value of attribute finishColor
 boolean getOverlap()
          Gets the value of attribute overlap
 AimsColor getStartColor()
          Gets the value of attribute startColor
 double getTransparency()
          Gets the value of attribute transparency
 java.lang.String getType()
          Gets the value of attribute type
 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 antialising.
 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 setFinishColor(AimsColor finishColor)
          Sets the value of attribute finishColor.
 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 setOverlap(boolean overlap)
          Sets the value of attribute overlap.
 void setStartColor(AimsColor startColor)
          Sets the value of attribute startColor.
 void setTransparency(double transparency)
          Sets the value of attribute transparency.
 void setType(java.lang.String type)
          Sets the value of attribute type.
 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

AimsGradientFillSymbol

public AimsGradientFillSymbol()
Creates new SimplePolygonSymbol with no arguments

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 AimsGradientFillSymbol before use.

setAntialiasing

public void setAntialiasing(boolean antialiasing)
Sets the value of attribute antialising.

Parameters:
antialiasing - The attribute value.

getAntialiasing

public boolean getAntialiasing()
Gets the value of attribute antialiasing

Returns:
The value of attribute antialiasing

setStartColor

public void setStartColor(AimsColor startColor)
Sets the value of attribute startColor.

Parameters:
startColor - The attribute value.

getStartColor

public AimsColor getStartColor()
Gets the value of attribute startColor

Returns:
The value of attribute startColor

setFinishColor

public void setFinishColor(AimsColor finishColor)
Sets the value of attribute finishColor.

Parameters:
finishColor - The attribute value.

getFinishColor

public AimsColor getFinishColor()
Gets the value of attribute finishColor

Returns:
The value of attribute finishColor

setType

public void setType(java.lang.String type)
Sets the value of attribute type.

Parameters:
type - The attribute value, one of "bdiagonal", "diagonal", "horizontal" or "vertical".

getType

public java.lang.String getType()
Gets the value of attribute type

Returns:
The value of attribute type

setOverlap

public void setOverlap(boolean overlap)
Sets the value of attribute overlap.

Parameters:
overlap - The attribute value.

getOverlap

public boolean getOverlap()
Gets the value of attribute overlap

Returns:
The value of attribute overlap

setTransparency

public void setTransparency(double transparency)
Sets the value of attribute transparency.

Parameters:
transparency - The attribute value.

getTransparency

public double getTransparency()
Gets the value of attribute transparency

Returns:
The value of 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.

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.

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.


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.