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

java.lang.Object
  com.esri.aims.mtier.model.map.layer.renderer.symbol.Symbol
      com.esri.aims.mtier.model.map.layer.renderer.symbol.TextSymbol

All Implemented Interfaces:

Serializable

public class TextSymbol
extends Symbol

This object is used to label point, line, and polygon layers.

See Also:

Serialized Form

Field Summary

static String	ALLLOWER
static String	ALLUPPER
static String	BOLD
static String	BOLDITALIC
static String	ITALIC
static String	NONE
static String	OUTLINE
static String	REGULAR
static String	TITLECAPS
static String	UNDERLINE

Constructor Summary

TextSymbol()
Constructs an instance of a TextSymbol object.

Method Summary

String	getBlockout() Returns the TextSymbols blockout color value.
String	getFont() Returns the TextSymbol's font value.
String	getFontColor() Returns the TextSymbol's font color value.
long	getFontSize() Returns the TextSymbol's font size value.
String	getFontStyle() Returns the TextSymbol's fontstyle value.
String	getGlowing() Returns the TextSymbols glowing color value.
long	getInterval() Returns the TextSymbol's interval value.
String	getOutline() Returns the TextSymbol's outline color value.
String	getPrintMode() Returns the TextSymbol's print mode value.
String	getShadow() Returns the TextSymbols shadow color value.
double	getTransparency() Returns the TextSymbol's transparency value.
String	getType() Abstract method returns the type of symbol that the Symbol object represents.
boolean	isAntialiasing() Returns True if TextSymbol's antialiasing value is set to True.
void	setAntialiasing(boolean value) Sets the TextSymbol's antialiasing value.
void	setBlockout(String value) Sets the TextSymbol's blockout color value.
void	setFont(String value) Sets the TextSymbol's font value.
void	setFontColor(String value) Sets the TextSymbol's font color value.
void	setFontSize(long value) Sets the TextSymbol's font size value.
void	setFontStyle(String value) Sets the TextSymbol's fontstyle value.
void	setGlowing(String value) Sets the TextSymbol's glowing color value.
void	setInterval(long value) Sets the TextSymbol's distance in pixels from point 0.
void	setOutline(String value) Sets the TextSymbol's outline color value.
void	setPrintMode(String value) Sets the TextSymbol's print mode, which determines how labels are printed.
void	setShadow(String value) Sets the TextSymbol's shadow color value.
void	setTransparency(double value) Sets the percentage of transparency of this TextSymbol.

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

TITLECAPS

public static final String TITLECAPS

See Also:

Constant Field Values

ALLUPPER

public static final String ALLUPPER

See Also:

Constant Field Values

ALLLOWER

public static final String ALLLOWER

See Also:

Constant Field Values

NONE

public static final String NONE

See Also:

Constant Field Values

Constructor Detail

TextSymbol

public TextSymbol()

Constructs an instance of a TextSymbol object.

TextSymbol text = new TextSymbol();

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 of this TextSymbol.

text.setTransparency(1.0);

Parameters:

value - the transparency value. 1.0 is 0 percent transparent. 0.0 is 100 percent transparent.

See Also:

getTransparency()

setAntialiasing

public void setAntialiasing(boolean value)

Sets the TextSymbol's antialiasing value. Note that the time to generate a map may significantly increase when this property is set to True.

text.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 TextSymbol's font value.

text.setFont("arial");

Parameters:

value - the font value.

See Also:

getFont()

setFontSize

public void setFontSize(long value)

Sets the TextSymbol's font size value.

text.setFontSize(15);

Parameters:

value - the font size value.

See Also:

getFontSize()

setFontColor

public void setFontColor(String value)

Sets the TextSymbol's font color value.

text.setFontColor("255,0,0");

Parameters:

value - the font color value.

See Also:

getFontColor()

setOutline

public void setOutline(String value)

Sets the TextSymbol's outline color value.

text.setOutline("100,0,0");

Parameters:

value - the outline color value.

See Also:

getOutline()

setGlowing

public void setGlowing(String value)

Sets the TextSymbol's glowing color value.

text.setGlowing("50,0,0");

Parameters:

value - the glowing color value.

See Also:

getGlowing()

setShadow

public void setShadow(String value)

Sets the TextSymbol's shadow color value.

text.setShadow("45,0,0");

Parameters:

value - the shadow color value.

See Also:

getShadow()

setBlockout

public void setBlockout(String value)

Sets the TextSymbol's blockout color value.

text.setBlockout("78,0,0");

Parameters:

value - the blockout color value.

See Also:

getBlockout()

setInterval

public void setInterval(long value)

Sets the TextSymbol's distance in pixels from point 0.

text.setInterval(5);

Parameters:

value - the interval.

See Also:

getInterval()

setPrintMode

public void setPrintMode(String value)

Sets the TextSymbol's print mode, which determines how labels are printed. Example:

text.setPrintMode("allupper");

Parameters:

value - the print mode - 'none', 'alllower', 'llupper', 'itlecase'. For example, if 'none' is used, no change is made to the label: Welcome to ArcIMS.

See Also:

getPrintMode()

setFontStyle

public void setFontStyle(String value)

Sets the TextSymbol's fontstyle value. Example:

text.setFontStyle("BOLD");

Parameters:

value - the fontstyle value.

See Also:

getFontStyle()

getTransparency

public double getTransparency()

Returns the TextSymbol's transparency value. Example:

double transparency = text.getTransparency();

Returns:

double

See Also:

setTransparency(double)

isAntialiasing

public boolean isAntialiasing()

Returns True if TextSymbol's antialiasing value is set to True. Example:

 if(text.isAntialiasing() == true){
  text.setAntialiasing(false);
 }
 

Returns:

boolean

See Also:

setAntialiasing(boolean)

getFont

public String getFont()

Returns the TextSymbol's font value. Example:

String font = text.getFont();

Returns:

String

See Also:

setFont(java.lang.String)

getFontSize

public long getFontSize()

Returns the TextSymbol's font size value. Example:

long fontSize = text.getFontSize();

Returns:

long

See Also:

setFontSize(long)

getFontColor

public String getFontColor()

Returns the TextSymbol's font color value. Example:

String fontColor = text.getFontColor();

Returns:

String

See Also:

setFontColor(java.lang.String)

getOutline

public String getOutline()

Returns the TextSymbol's outline color value. Example:

String outline = text.getOutline();

Returns:

String

See Also:

setOutline(java.lang.String)

getGlowing

public String getGlowing()

Returns the TextSymbols glowing color value. Example:

String glowing = text.getGlowing();

Returns:

String

See Also:

setGlowing(java.lang.String)

getShadow

public String getShadow()

Returns the TextSymbols shadow color value. Example:

String shadow = text.getShadow();

Returns:

String

See Also:

setShadow(java.lang.String)

getBlockout

public String getBlockout()

Returns the TextSymbols blockout color value. Example:

String blockout = text.getBlockout();

Returns:

String

See Also:

setBlockout(java.lang.String)

getInterval

public long getInterval()

Returns the TextSymbol's interval value. Example:

long interval = text.getInterval();

Returns:

long

See Also:

setInterval(long)

getPrintMode

public String getPrintMode()

Returns the TextSymbol's print mode value. Example:

String printmode = text.getPrintMode();

Returns:

String

See Also:

setPrintMode(java.lang.String)

getFontStyle

public String getFontStyle()

Returns the TextSymbol's fontstyle value. Example:

String fontStyle = text.getFontStyle();

Returns:

String

See Also:

setFontStyle(java.lang.String)