com.esri.aims.mtier.model.map.layer.renderer.symbol
Class TrueTypeMarkerSymbol

java.lang.Object
  |
  +--com.esri.aims.mtier.model.map.layer.renderer.symbol.Symbol
        |
        +--com.esri.aims.mtier.model.map.layer.renderer.symbol.TrueTypeMarkerSymbol
All Implemented Interfaces:
Serializable

public class TrueTypeMarkerSymbol
extends Symbol

Used to symbolize point features using TrueType symbols.

See Also:
Serialized Form

Field Summary
static String ARITHMETIC
          Defines the method of calculating angles as Arithmetic.
static String BOLD
           
static String BOLDITALIC
           
static String GEOGRAPHIC
          Defines the method of calculating angles as Geographic.
static String ITALIC
           
static String MOD_ARITHMETIC
          Defines the method of calculating angles as Mod_Arithmetic.
static String OUTLINE
           
static String REGULAR
           
static String UNDERLINE
           
 
Constructor Summary
TrueTypeMarkerSymbol()
          Constructs an instance of TrueTypeMarkerSymbol.
 
Method Summary
 double getAngle()
          Returns the TrueTypeMarkerSymbol's angle value.
 String getAngleField()
          Returns the TrueTypeMarkerSymbol's angle field value.
 long getCharacter()
          Returns the TrueTypeMarkerSymbol's character value.
 String getFont()
          Returns the TrueTypeMarkerSymbol's font value.
 String getFontColor()
          Returns the TrueTypeMarkerSymbol's font color value.
 long getFontSize()
          Returns the TrueTypeMarkerSymbol's font size value.
 String getFontStyle()
          Returns the TrueTypeMarkerSymbol's font style value.
 String getGlowing()
          Returns the TrueTypeMarkerSymbol's glowing color value.
 String getOutline()
          Returns the TrueTypeMarkerSymbol's outline color value.
 String getRotateMethod()
          Returns the TrueTypeMarkerSymbol's rotate method value.
 String getShadow()
          Returns the TrueTypeMarkerSymbol's shadow color value.
 double getTransparency()
          Returns the TrueTypeMarkerSymbol's transparency value.
 String getType()
          Abstract method returns the type of symbol that the Symbol object represents.
 boolean isAntialiasing()
          Determines if the TrueTypeMarkerSymbol's antialiasing value is set.
 boolean isOverlap()
          Determines if the TrueTypeMarkerSymbol's overlap value is set.
 boolean isUseCentroid()
          Determines if the TrueTypeMarkerSymbol's usecentroid value is set.
 void setAngle(double value)
          Sets the TrueTypeMarkerSymbol's angle value.
 void setAngleField(String value)
          Sets the field in the database that contains the angle of rotation for a TrueTypeMarkerSymbol.
 void setAntialiasing(boolean value)
          Sets the TrueTypeMarkerSymbol's antialiasing value.
 void setCharacter(long value)
          Sets the TrueTypeMarkerSymbol's character value.
 void setFont(String value)
          Sets the TrueTypeMarkerSymbol's font value.
 void setFontColor(String value)
          Sets the TrueTypeMarkerSymbol's font color value.
 void setFontSize(long value)
          Sets the TrueTypeMarkerSymbol's font size value.
 void setFontStyle(String value)
          Sets the TrueTypeMarkerSymbol's fontstyle value.
 void setGlowing(String color)
          Sets the TrueTypeMarkerSymbol's glowing color value.
 void setOutline(String value)
          Sets the TrueTypeMarkerSymbol's outline color value.
 void setOverlap(boolean value)
          Sets the TrueTypeMarkerSymbol's overlap value, which determines if labels can overlap this symbol.
 void setRotateMethod(String value)
          Sets the TrueTypeMarkerSymbol's rotate method value.
 void setShadow(String value)
          Sets the TrueTypeMarkerSymbol's shadow color value.
 void setTransparency(double value)
          Sets the percentage of transparency for this TrueTypeMarkerSymbol.
 void setUseCentroid(boolean value)
          Sets the TrueTypeMarkerSymbol's usecentroid value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REGULAR

public static final String REGULAR
See Also:
Constant Field Values

BOLD

public static final String BOLD
See Also:
Constant Field Values

ITALIC

public static final String ITALIC
See Also:
Constant Field Values

UNDERLINE

public static final String UNDERLINE
See Also:
Constant Field Values

OUTLINE

public static final String OUTLINE
See Also:
Constant Field Values

BOLDITALIC

public static final String BOLDITALIC
See Also:
Constant Field Values

GEOGRAPHIC

public static final String GEOGRAPHIC
Defines the method of calculating angles as Geographic.

See Also:
Constant Field Values

ARITHMETIC

public static final String ARITHMETIC
Defines the method of calculating angles as Arithmetic.

See Also:
Constant Field Values

MOD_ARITHMETIC

public static final String MOD_ARITHMETIC
Defines the method of calculating angles as Mod_Arithmetic.

See Also:
Constant Field Values
Constructor Detail

TrueTypeMarkerSymbol

public TrueTypeMarkerSymbol()
Constructs an instance of TrueTypeMarkerSymbol.

TrueTypeMarkerSymbol trueType = new TrueTypeMarkerSymbol();

Method Detail

getType

public String getType()
Description copied from class: Symbol
Abstract method returns the type of symbol that the Symbol object represents.

Specified by:
getType in class Symbol
Returns:
String

setTransparency

public void setTransparency(double value)
Sets the percentage of transparency for this TrueTypeMarkerSymbol.

trueType.setTransparency(1.0);

Parameters:
value - the transparency value. 1.0 is 0 percent transparent. 0.0 is 100 percent transparent.
See Also:
getTransparency(), getTransparency()

setUseCentroid

public void setUseCentroid(boolean value)
Sets the TrueTypeMarkerSymbol's usecentroid value. By default, a marker symbol used on polygon layers draws markers at all polygon vertices. If usecentroid is True, the marker is placed in the centroid of the polygon. If multiple polygon parts exist, the marker falls on the part with the biggest area.

trueType.setUseCentroid(false);

Parameters:
value - the boolean value- True or False.
See Also:
isUseCentroid()

setAntialiasing

public void setAntialiasing(boolean value)
Sets the TrueTypeMarkerSymbol's antialiasing value. Note that the time to generate a map may significantly increase when this property is set to True. Example:
trueType.setAntialiasing(false);

Parameters:
value - the antialiasing value that is used to make edges of labels and symbols smoother. When set to True, antialiasing is active.
See Also:
isAntialiasing()

setFont

public void setFont(String value)
Sets the TrueTypeMarkerSymbol's font value. Example:
trueType.setFont("arial");

Parameters:
value - the font value.
See Also:
getFont()

setFontSize

public void setFontSize(long value)
Sets the TrueTypeMarkerSymbol's font size value. Example:
trueType.setFontSize(15);

Parameters:
value - the font size value.
See Also:
getFontSize()

setFontColor

public void setFontColor(String value)
Sets the TrueTypeMarkerSymbol's font color value. Example:
trueType.setFontColor("100,0,0");

Parameters:
value - the font color value.
See Also:
getFontColor()

setOutline

public void setOutline(String value)
Sets the TrueTypeMarkerSymbol's outline color value. Example:
trueType.setOutline("45,0,0");

Parameters:
value - the outline color value.
See Also:
getOutline()

setShadow

public void setShadow(String value)
Sets the TrueTypeMarkerSymbol's shadow color value. Example:
trueType.setShadow("85,0,0");

Parameters:
value - the shadow color value.
See Also:
getShadow()

setAngle

public void setAngle(double value)
Sets the TrueTypeMarkerSymbol's angle value.

trueType.setAngle(45.0);

Parameters:
value - the angle value.
See Also:
getAngle()

setCharacter

public void setCharacter(long value)
Sets the TrueTypeMarkerSymbol's character value.

trueType.setCharacter(55);

Parameters:
value - the character value.
See Also:
getCharacter()

setFontStyle

public void setFontStyle(String value)
Sets the TrueTypeMarkerSymbol's fontstyle value.

trueType.setFontStyle("BOLD");

Parameters:
value - the fontstyle value.
See Also:
getFontStyle()

setGlowing

public void setGlowing(String color)
Sets the TrueTypeMarkerSymbol's glowing color value.

trueType.setGlowing("100,0,0");

Parameters:
color - the glowing color value.
See Also:
getGlowing()

setOverlap

public void setOverlap(boolean value)
Sets the TrueTypeMarkerSymbol's overlap value, which determines if labels can overlap this symbol. When True, labels can overlap this symbol.

trueType.setOverlap(false);

Parameters:
value - the overlap value.
See Also:
isOverlap()

setRotateMethod

public void setRotateMethod(String value)
Sets the TrueTypeMarkerSymbol's rotate method value. Three methods of calculating angles are available and apply to both angle and anglefield. Example:
trueType.setRotateMethod("geographic");

Parameters:
value - the rotateMethod - geographic, arithmetic, or mod_arithmetic.
See Also:
getRotateMethod()

setAngleField

public void setAngleField(String value)
Sets the field in the database that contains the angle of rotation for a TrueTypeMarkerSymbol. The field can be in a layer table or in a joined table. Example:
trueType.setAngleField("rotate");

Parameters:
value - the angleField value.
See Also:
getAngleField()

getTransparency

public double getTransparency()
Returns the TrueTypeMarkerSymbol's transparency value. Example:
double transparency = trueType.getTransparency();

Returns:
double
See Also:
setTransparency(double)

isUseCentroid

public boolean isUseCentroid()
Determines if the TrueTypeMarkerSymbol's usecentroid value is set. Example:
 if(trueType.isUseCentroid() == false){
  trueType.setUseCentroid(true);
 } 

Returns:
boolean
See Also:
setUseCentroid(boolean)

isAntialiasing

public boolean isAntialiasing()
Determines if the TrueTypeMarkerSymbol's antialiasing value is set. Example:
 if(trueType.isAntialiasing() == false){
  trueType.setAntialiasing(true);
  

Returns:
boolean
See Also:
setAntialiasing(boolean)

getFont

public String getFont()
Returns the TrueTypeMarkerSymbol's font value. Example:
String font = trueType.getFont();

Returns:
String
See Also:
setFont(java.lang.String)

getFontSize

public long getFontSize()
Returns the TrueTypeMarkerSymbol's font size value. Example:
long fontSize = trueType.getFontSize();

Returns:
long
See Also:
setFontSize(long)

getFontColor

public String getFontColor()
Returns the TrueTypeMarkerSymbol's font color value.

String fontColor = trueType.getFontColor();

Returns:
String
See Also:
setFontColor(java.lang.String)

getOutline

public String getOutline()
Returns the TrueTypeMarkerSymbol's outline color value.

String outline = trueType.getOutline();

Returns:
String
See Also:
setOutline(java.lang.String)

getShadow

public String getShadow()
Returns the TrueTypeMarkerSymbol's shadow color value. Example:
String shadow = trueType.getShadow();

Returns:
String
See Also:
setShadow(java.lang.String)

getAngle

public double getAngle()
Returns the TrueTypeMarkerSymbol's angle value. Example:
double angle = trueType.getAngle();

Returns:
double
See Also:
setAngle(double)

getCharacter

public long getCharacter()
Returns the TrueTypeMarkerSymbol's character value. Example:
long character = trueType.getCharacter();

Returns:
long
See Also:
setCharacter(long)

getFontStyle

public String getFontStyle()
Returns the TrueTypeMarkerSymbol's font style value.

String fontStyle = trueType.getFontStyle();

Returns:
String
See Also:
setFontStyle(java.lang.String)

getGlowing

public String getGlowing()
Returns the TrueTypeMarkerSymbol's glowing color value.

String glowing = trueType.getGlowing();

Returns:
String
See Also:
setGlowing(java.lang.String)

isOverlap

public boolean isOverlap()
Determines if the TrueTypeMarkerSymbol's overlap value is set. Example:
if(trueType.isOverlap() == true){
  trueType.setOverlap(false);
 }
 

Returns:
boolean
See Also:
setOverlap(boolean)

getRotateMethod

public String getRotateMethod()
Returns the TrueTypeMarkerSymbol's rotate method value. Example:
 String rotateMethod = trueType.getRotateMethod();
 

Returns:
String
See Also:
setRotateMethod(java.lang.String)

getAngleField

public String getAngleField()
Returns the TrueTypeMarkerSymbol's angle field value. Example:
 String angleField = trueType.getAngleField();
 

Returns:
String
See Also:
setAngleField(java.lang.String)