com.moximedia.aims
Class AimsHashLineSymbol

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

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

Implementation of an ArcIMS HashLineSymbol.

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

Field Summary
 
Fields inherited from interface com.moximedia.aims.AimsSymbol
SYMBOL_TYPE_CALLOUTMARKER, SYMBOL_TYPE_CHART, SYMBOL_TYPE_GRADIENTFILL, SYMBOL_TYPE_HASHLINE, SYMBOL_TYPE_RASTERFILL, SYMBOL_TYPE_RASTERMARKER, SYMBOL_TYPE_RASTERSHIELD, SYMBOL_TYPE_SHIELD, SYMBOL_TYPE_SIMPLELINE, SYMBOL_TYPE_SIMPLEMARKER, SYMBOL_TYPE_SIMPLEPOLYGON, SYMBOL_TYPE_TEXT, SYMBOL_TYPE_TEXTMARKER, SYMBOL_TYPE_TRUETYPEMARKER
 
Constructor Summary
AimsHashLineSymbol()
          Creates new SimpleLineSymbol with no arguments
 
Method Summary
 java.lang.Object clone()
          Creates a copy of this symbol.
 boolean getAntialiasing()
          Gets the value of attribute antialiasing
 AimsColor getColor()
          Gets the value of attribute color
 int getInterval()
          Gets the value of attribute interval
 int getLineThickness()
          Gets the value of attribute lineThichness
 boolean getOverlap()
          Gets the value of attribute overlap
 int getSymbolType()
          Returns an indicator of what type of symbol this is.
 int getTickThickness()
          Gets the value of attribute tickThichness
 double getTransparency()
          Gets the value of attribute transparency
 java.lang.String getType()
          Gets the value of attribute type
 int getWidth()
          Gets the value of attribute width
 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 setColor(AimsColor color)
          Sets the value of attribute color.
 void setInterval(int interval)
          Sets the value of attribute interval.
 void setLineThickness(int lineThickness)
          Sets the value of attribute lineThickness.
 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 setTickThickness(int tickThickness)
          Sets the value of attribute tickThickness.
 void setTransparency(double transparency)
          Sets the value of attribute transparency.
 void setType(java.lang.String type)
          Sets the value of attribute type.
 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 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

AimsHashLineSymbol

public AimsHashLineSymbol()
Creates new SimpleLineSymbol 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 AimsHashLineSymbol before use.

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.

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

setColor

public void setColor(AimsColor color)
Sets the value of attribute color.

Parameters:
color - The attribute value.

getColor

public AimsColor getColor()
Gets the value of attribute color

Returns:
The value of attribute color

setInterval

public void setInterval(int interval)
Sets the value of attribute interval.

Parameters:
interval - The attribute value.

getInterval

public int getInterval()
Gets the value of attribute interval

Returns:
The value of attribute interval

setLineThickness

public void setLineThickness(int lineThickness)
Sets the value of attribute lineThickness.

Parameters:
lineThickness - The attribute value.

getLineThickness

public int getLineThickness()
Gets the value of attribute lineThichness

Returns:
The value of attribute lineThichness

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

setTickThickness

public void setTickThickness(int tickThickness)
Sets the value of attribute tickThickness.

Parameters:
tickThickness - The attribute value.

getTickThickness

public int getTickThickness()
Gets the value of attribute tickThichness

Returns:
The value of attribute tickThichness

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

setType

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

Parameters:
type - The attribute value.

getType

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

Returns:
The value of attribute type

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

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.

getSymbolType

public int getSymbolType()
Returns an indicator of what type of symbol this is.

Specified by:
getSymbolType in interface AimsSymbol
Returns:
An enumerated value indicating the type of symbol this is. Always returns AimsSymbol.SYMBOL_TYPE_HASHLINE.


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