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

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

All Implemented Interfaces:

Serializable

public class TextMarkerSymbol
extends Symbol

Adds Static text to an acetate layer.

See Also:

Serialized Form

Field Summary

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

Constructor Summary

TextMarkerSymbol()

Method Summary

double	getAngle() Returns the TextMarkerSymbol's angle value.
String	getBlockout() Returns the TextMarkerSymbols blockout value.
String	getFont() Returns the TextMarkerSymbol's font value.
String	getFontColor() Returns the TextMarkerSymbol's font color value.
long	getFontSize() Returns the TextMarkerSymbol's fontsize value.
String	getFontStyle() Returns the TextMarkerSymbol's font style value.
String	getGlowing() Returns the TextMarkerSymbol's glowing value.
String	getHAlignment() Returns the TextMarkerSymbol's horizontal alignment value.
long	getInterval() Returns the TextMarkerSymbol's interval value.
String	getOutline() Returns the TextMarkerSymbol's outline value.
String	getPrintMode() Returns the TextMarkerSymbol's print mode value.
String	getShadow() Returns the TextMarkerSymbol's shadow color value.
double	getTransparency() Returns the TextMarkerSymbol's transparency value.
String	getType() Abstract method returns the type of symbol that the Symbol object represents.
String	getVAlignment() Returns the TextMarkerSymbol's vertical alignment value.
boolean	isAntialiasing() Returns true if the TextMarkerSymbol's transparency value is set to true.
boolean	isOverlap() Returns true if the TextMarkerSymbol's overlap value is set to true.
void	setAngle(double value) Sets the angle of rotation in degrees moving counterclockwise.
void	setAntialiasing(boolean value) Sets the TextMarkerSymbol's antialising value.
void	setBlockout(String value) Sets the TextMarkerSymbol's blockout color value.
void	setFont(String value) Sets the TextMarkerSymbol's font value.
void	setFontColor(String value) Sets the TextMarkerSymbol's font color value.
void	setFontSize(long value) Sets the TextMarkerSymbol's font size value.
void	setFontStyle(String value) Sets the TextMarkerSymbol's fontstyle value.
void	setGlowing(String value) Sets the TextMarkerSymbol's glowing color value.
void	setHAlignment(String value) Sets the horizontal alignment of the label when compared to the label point.
void	setInterval(long value) Sets the distance between the point and printed label.
void	setOutline(String value) Sets the TextMarkerSymbol's outline color value.
void	setOverlap(boolean value) Sets the TextMarkerSymbol's overlap, which determines if labels can overlap this symbol.
void	setPrintMode(String value) Sets the TextMarkerSymbol's print mode.
void	setShadow(String shadow) Sets the shadow color using RGB values for this symbol.
void	setTransparency(double value) Sets the percentage of transparency for this TextMarkerSymbol.
void	setVAlignment(String value) Sets the vertical alignment of the label when compared to the label point.

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

LEFT

public static final String LEFT

See Also:

Constant Field Values

CENTER

public static final String CENTER

See Also:

Constant Field Values

RIGHT

public static final String RIGHT

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

TextMarkerSymbol

public TextMarkerSymbol()

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

getTransparency

public double getTransparency()

Returns the TextMarkerSymbol's transparency value. Example:

double transparency = textMarker.getTransparency();

Returns:

double

See Also:

setTransparency(double)

isAntialiasing

public boolean isAntialiasing()

Returns true if the TextMarkerSymbol's transparency value is set to true. Example:

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

Returns:

boolean

See Also:

setAntialiasing(boolean)

isOverlap

public boolean isOverlap()

Returns true if the TextMarkerSymbol's overlap value is set to true. Example: >

 if(textMarker.isOverlap() == true){
  textMarker.setOverlap(false);
 }
 

Returns:

boolean

See Also:

setOverlap(boolean)

getFont

public String getFont()

Returns the TextMarkerSymbol's font value. Example:

String font = textMarker.getFont();

Returns:

String

See Also:

setFont(java.lang.String)

getFontSize

public long getFontSize()

Returns the TextMarkerSymbol's fontsize value. Example:

long fontSize = textMarker.getFontSize();

Returns:

long

See Also:

setFontSize(long)

getFontColor

public String getFontColor()

Returns the TextMarkerSymbol's font color value. Example:

String fontColor = textMarker.getFontColor();

Returns:

String

See Also:

setFontColor(java.lang.String)

getOutline

public String getOutline()

Returns the TextMarkerSymbol's outline value. Example:

String outline = textMarker.getOutline();

Returns:

String

See Also:

setOutline(java.lang.String)

getGlowing

public String getGlowing()

Returns the TextMarkerSymbol's glowing value. Example: >

String glowing = textMarker.getGlowing();

Returns:

String

See Also:

setGlowing(java.lang.String)

getBlockout

public String getBlockout()

Returns the TextMarkerSymbols blockout value.

String blockout = textMarker.getBlockOut();

Returns:

String

See Also:

setBlockout(java.lang.String)

getInterval

public long getInterval()

Returns the TextMarkerSymbol's interval value.

long interval = textMarker.getInterval();

Returns:

long

See Also:

setInterval(long)

getAngle

public double getAngle()

Returns the TextMarkerSymbol's angle value.

double angle = textMarker.getAngle();

Returns:

double

See Also:

setAngle(double)

getHAlignment

public String getHAlignment()

Returns the TextMarkerSymbol's horizontal alignment value. Example:

String halign = textMarker.getHAlignment();

Returns:

String

See Also:

setHAlignment(java.lang.String)

getVAlignment

public String getVAlignment()

Returns the TextMarkerSymbol's vertical alignment value. Example:

String valign = textMarker.getVAlignment();

Returns:

String

See Also:

setVAlignment(java.lang.String)

getPrintMode

public String getPrintMode()

Returns the TextMarkerSymbol's print mode value. Example:

String printMode = textMarker.getPrintMode();

Returns:

String

See Also:

setPrintMode(java.lang.String)

getFontStyle

public String getFontStyle()

Returns the TextMarkerSymbol's font style value. Example:

String style = textMarker.getFontStyle();

Returns:

String

See Also:

setFontStyle(java.lang.String)

getShadow

public String getShadow()

Returns the TextMarkerSymbol's shadow color value.

Returns:

the shadow color RGB values

setTransparency

public void setTransparency(double value)

Sets the percentage of transparency for this TextMarkerSymbol. Example:

textMarker.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 TextMarkerSymbol's antialising value. Note that the time to generate a map may significantly increase when this property is set to True. Example:

textmarker.setAntialiasing(true);

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 TextMarkerSymbol's font value. Example:

textMarker.setFont("arial");

Parameters:

value - the font value.

See Also:

getFont()

setFontSize

public void setFontSize(long value)

Sets the TextMarkerSymbol's font size value. Example:

textMarker.setFontSize(10);

Parameters:

value - the font size value.

See Also:

getFontSize()

setFontStyle

public void setFontStyle(String value)

Sets the TextMarkerSymbol's fontstyle value. Example:

textMarker.setFontStyle("BOLD");

Parameters:

value - the font style value.

See Also:

getFontStyle()

setInterval

public void setInterval(long value)

Sets the distance between the point and printed label. Example:

textMarker.setInterval(5);

Parameters:

value - the interval value.

See Also:

getInterval()

setAngle

public void setAngle(double value)

Sets the angle of rotation in degrees moving counterclockwise. Zero degree is horizontal. Example:

textMarker.setAngle(125.0);

Parameters:

value - the angle of rotation.

See Also:

getAngle()

setFontColor

public void setFontColor(String value)

Sets the TextMarkerSymbol's font color value. Example:

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

Parameters:

value - the font color value.

See Also:

getFontColor()

setOutline

public void setOutline(String value)

Sets the TextMarkerSymbol's outline color value. Example:

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

Parameters:

value - the outline color value.

See Also:

getOutline()

setGlowing

public void setGlowing(String value)

Sets the TextMarkerSymbol's glowing color value. Example:

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

Parameters:

value - the glowing color value.

See Also:

getGlowing()

setBlockout

public void setBlockout(String value)

Sets the TextMarkerSymbol's blockout color value. Example:

textMarker.setBlockout("100,0,0");

Parameters:

value - the blockout color value.

See Also:

getBlockout()

setPrintMode

public void setPrintMode(String value)

Sets the TextMarkerSymbol's print mode. Example:

textMarker.setPrintMode("titlecaps");

Parameters:

value - defines how labels are printed - 'none', or 'lllower', 'allupper', or 'titlecase'. For example if 'none' is used, no change is made to the label: Welcome to ArcIMS.

See Also:

getPrintMode()

setHAlignment

public void setHAlignment(String value)

Sets the horizontal alignment of the label when compared to the label point. Example:

textMarker.setHAlignment("left");

Parameters:

value - horizontal alignment of the label.

See Also:

getHAlignment()

setVAlignment

public void setVAlignment(String value)

Sets the vertical alignment of the label when compared to the label point. Example:

textMarker.setVAlignment("top");

Parameters:

value - the vertical alignment of the label.

See Also:

getVAlignment()

setOverlap

public void setOverlap(boolean value)

Sets the TextMarkerSymbol's overlap, which determines if labels can overlap this symbol. Example:

textMarker.setOverlap(false);

Parameters:

value - the overlap - True or False.

See Also:

isOverlap()

setShadow

public void setShadow(String shadow)

Sets the shadow color using RGB values for this symbol.

Parameters:

shadow - the shadow color