com.moximedia.aims
Class AimsTextSymbol

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

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

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
AimsTextSymbol()
          Creates new TextSymbol
 
Method Summary
 java.lang.Object clone()
          Creates a copy of this symbol.
 boolean getAntialiasing()
          Gets the value of attribute antialiasing
 AimsColor getBlockOut()
          Gets the value of attribute blockOut
 java.lang.String getFont()
          Gets the value of attribute font
 AimsColor getFontColor()
          Gets the value of attribute fontColor
 int getFontSize()
          Gets the value of attribute fontSize
 java.lang.String getFontStyle()
          Gets the value of attribute fontStyle
 AimsColor getGlowing()
          Gets the value of attribute glowing
 int getInterval()
          Gets the value of attribute interval
 AimsColor getOutline()
          Gets the value of attribute outline
 java.lang.String getPrintMode()
          Gets the value of attribute printMode
 AimsColor getShadow()
          Gets the value of attribute shadow
 int getSymbolType()
          Returns an indicator of what type of symbol this is.
 double getTransparency()
          Gets the value of attribute transparency
 void highlight(AimsColor highlightColor, double transparency)
           
 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 setBlockOut(AimsColor color)
          Sets the value of attribute blockOut.
 void setFont(java.lang.String font)
          Sets the value of attribute font.
 void setFontColor(AimsColor color)
          Sets the value of attribute fontColor.
 void setFontSize(double fontSize)
          Sets the value of attribute fontSize.
 void setFontStyle(java.lang.String fontStyle)
          Sets the value of attribute fontStyle.
 void setGlowing(AimsColor color)
          Sets the value of attribute glowing.
 void setInterval(int interval)
          Sets the value of attribute interval.
 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 setPrintMode(java.lang.String printMode)
          Sets the value of attribute printMode.
 void setShadow(AimsColor color)
          Sets the value of attribute shadow.
 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

AimsTextSymbol

public AimsTextSymbol()
Creates new TextSymbol

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 AimsTextSymbol 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

setBlockOut

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

Parameters:
color - The attribute value.

getBlockOut

public AimsColor getBlockOut()
Gets the value of attribute blockOut

Returns:
The value of attribute blockOut

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

setFontColor

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

Parameters:
color - The attribute value.

getFontColor

public AimsColor getFontColor()
Gets the value of attribute fontColor

Returns:
The value of attribute fontColor

setFontSize

public void setFontSize(double fontSize)
Sets the value of attribute fontSize.

Parameters:
fontSize - The attribute value.

getFontSize

public int getFontSize()
Gets the value of attribute fontSize

Returns:
The value of attribute fontSize

setFontStyle

public void setFontStyle(java.lang.String fontStyle)
Sets the value of attribute fontStyle.

Parameters:
fontStyle - The attribute value.

getFontStyle

public java.lang.String getFontStyle()
Gets the value of attribute fontStyle

Returns:
The value of attribute fontStyle

setGlowing

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

Parameters:
color - The attribute value.

getGlowing

public AimsColor getGlowing()
Gets the value of attribute glowing

Returns:
The value of attribute glowing

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

setOutline

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

Parameters:
color - The attribute value.

getOutline

public AimsColor getOutline()
Gets the value of attribute outline

Returns:
The value of attribute outline

setPrintMode

public void setPrintMode(java.lang.String printMode)
Sets the value of attribute printMode.

Parameters:
printMode - The attribute value.

getPrintMode

public java.lang.String getPrintMode()
Gets the value of attribute printMode

Returns:
The value of attribute printMode

setShadow

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


getShadow

public AimsColor getShadow()
Gets the value of attribute shadow

Returns:
The value of attribute shadow

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
Returns:
The AXL string to refresh this object.

highlight

public void highlight(AimsColor highlightColor,
                      double transparency)
Specified by:
highlight in interface AimsSymbol

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_TEXT.


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.