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

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

All Implemented Interfaces:

Serializable

public class SimpleMarkerSymbol
extends Symbol

Used to symbolize point features using one of the predefined symbol types: CIRCLE, TRIANGLE, SQUARE, CROSS, or a STAR.

See Also:

Serialized Form

Field Summary

static String	CIRCLE
static String	CROSS
static String	SQUARE
static String	STAR
static String	TRIANGLE

Constructor Summary

SimpleMarkerSymbol()
Constructs an instance of a SimpleMarkerSymbol.

Method Summary

String	getColor() Returns the SimpleMarkerSymbol's color value.
String	getMarkerType() Returns the SimpleMarkerSymbol's type value.
String	getOutline() Returns the SimpleMarkerSymbol's outline value.
String	getShadow() Returns the SimpleMarkerSymbol's shadow value.
double	getTransparency() Returns the SimpleMarkerSymbol's transparency value.
String	getType() Abstract method returns the type of symbol that the Symbol object represents.
long	getWidth() Returns the SimpleMarkerSymbol's width value.
boolean	isAntialiasing() Returns true if the SimpleMarkerSymbol's antialiasing value is set to true.
boolean	isOverlap() Returns True if the SimpleMarkerSymbol's overlap value is set to true.
boolean	isUseCentroid() Returns true if the SimpleMarkerSymbol's usecentroid value is set to true.
void	setAntialiasing(boolean value) Sets the SimpleMarkerSymbol's antialiasing value.
void	setColor(String value) Sets the SimpleMarkerSymbol's color value.
void	setMarkerType(String value) Sets the SimpleMarkerSymbol's type value.
void	setOutline(String value) Sets the SimpleMarkerSymbol's outline value.
void	setOverlap(boolean value) Sets the SimpleMarkerSymbol's overlap value.
void	setShadow(String value) Sets the SimpleMarkerSymbol's shadow value.
void	setTransparency(double value) Sets the SimpleMarkerSymbol's transparency value.
void	setUseCentroid(boolean value) Sets the SimpleMarkerSymbol's usecentroid value.
void	setWidth(long value) Sets the SimpleMarkerSymbol's width value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CIRCLE

public static final String CIRCLE

See Also:

Constant Field Values

TRIANGLE

public static final String TRIANGLE

See Also:

Constant Field Values

SQUARE

public static final String SQUARE

See Also:

Constant Field Values

CROSS

public static final String CROSS

See Also:

Constant Field Values

STAR

public static final String STAR

See Also:

Constant Field Values

Constructor Detail

SimpleMarkerSymbol

public SimpleMarkerSymbol()

Constructs an instance of a SimpleMarkerSymbol.

SimpleMarkerSymbol simpleMarker = new SimpleMarkerSymbol();

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 SimpleMarkerSymbol's transparency value.

simpleMarker.setTransparency(1.0);

Parameters:

value - the transparency value.

See Also:

getTransparency()

setAntialiasing

public void setAntialiasing(boolean value)

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

simpleMarker.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()

setUseCentroid

public void setUseCentroid(boolean value)

Sets the SimpleMarkerSymbol's usecentroid value.

simpleMarker.setUseCentroid(false);

Parameters:

value - the usecentroid value.

See Also:

isUseCentroid()

setOutline

public void setOutline(String value)

Sets the SimpleMarkerSymbol's outline value.

simpleMarker.setOutline("255,0,0");

Parameters:

value - the outline value.

See Also:

getOutline()

setShadow

public void setShadow(String value)

Sets the SimpleMarkerSymbol's shadow value.

simpleMarker.setShadow(255,0,0");

Parameters:

value - the shadow value.

See Also:

getShadow()

setColor

public void setColor(String value)

Sets the SimpleMarkerSymbol's color value.

simpleMarker.setColor(100,0,0");

Parameters:

value - the color value.

See Also:

getColor()

setMarkerType

public void setMarkerType(String value)

Sets the SimpleMarkerSymbol's type value.

simpleMarker.setMarkerType("circle");

Parameters:

value - the SimpleMarkerSymbols type.

See Also:

getMarkerType()

setWidth

public void setWidth(long value)

Sets the SimpleMarkerSymbol's width value. Example:

simpleMarker.setWidth(25);

Parameters:

value - the SimpleMarkerSymbols width.

See Also:

getWidth()

getWidth

public long getWidth()

Returns the SimpleMarkerSymbol's width value. Example:

long width = simpleMarker.getWidth();

Returns:

long

See Also:

setWidth(long)

getTransparency

public double getTransparency()

Returns the SimpleMarkerSymbol's transparency value. Example:

double transparency = simpleMarker.getTransparency();

Returns:

double

See Also:

setTransparency(double)

isAntialiasing

public boolean isAntialiasing()

Returns true if the SimpleMarkerSymbol's antialiasing value is set to true. Example:

  if(simpleMarker.isAntialiasing() == true){
  simpleMarker.setAntialiasing(false);
  

Returns:

boolean

See Also:

setAntialiasing(boolean)

isUseCentroid

public boolean isUseCentroid()

Returns true if the SimpleMarkerSymbol's usecentroid value is set to true. Example:

  if(simpleMarker.isUseCentroid() == false){
  simpleMarker.setUseCentroid(true);
  

Returns:

boolean

See Also:

setUseCentroid(boolean)

getOutline

public String getOutline()

Returns the SimpleMarkerSymbol's outline value. Example:

String outline = simpleMarker.getOutline();

Returns:

String

See Also:

setOutline(java.lang.String)

getShadow

public String getShadow()

Returns the SimpleMarkerSymbol's shadow value. Example:

String shadow = simpleMarker.getShadow();

Returns:

String

See Also:

setShadow(java.lang.String)

getColor

public String getColor()

Returns the SimpleMarkerSymbol's color value. Example:

String color simpleMarker.getColor();

Returns:

String

See Also:

setColor(java.lang.String)

getMarkerType

public String getMarkerType()

Returns the SimpleMarkerSymbol's type value. Example:

String type = simpleMarker.getMarkerType();

Returns:

String

See Also:

setMarkerType(java.lang.String)

setOverlap

public void setOverlap(boolean value)

Sets the SimpleMarkerSymbol's overlap value. Example:

simpleMarker.setOverlap(false);

Parameters:

value - the overlap value.

See Also:

isOverlap()

isOverlap

public boolean isOverlap()

Returns True if the SimpleMarkerSymbol's overlap value is set to true. Example:

 if(simpleMarker.isOverlap() == true){
  simpleMarker.setOverlap(false);
 

Returns:

boolean

See Also:

setOverlap(boolean)