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

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

All Implemented Interfaces:

Serializable

public class SimplePolygonSymbol
extends Symbol

Represents a symbol for a polygon feature.

See Also:

Serialized Form

Field Summary

static String	BDIAGONAL
static String	BEVEL
static String	BUTT
static String	CROSS
static String	DARKGRAY
static String	DASH
static String	DASH_DOT
static String	DASH_DOT_DOT
static String	DIAGCROSS
static String	DOT
static String	FDIAGONAL
static String	GRAY
static String	HORIZONTAL
static String	LIGHTGRAY
static String	MITER
static String	ROUND
static String	SOLID
static String	SQUARE
static String	VERTICAL

Constructor Summary

SimplePolygonSymbol()
Constructs an instance of a SimplePolygonSymbol Object.

Method Summary

String	getBoundaryCapType() Returns the SimplePolygonSymbol's boundary cap type value.
String	getBoundaryColor() Returns the SimplePolygonSymbol's boundary color value.
String	getBoundaryJoinType() Returns the SimplePolygonSymbol's boundary join type value.
double	getBoundaryTransparency() Returns the SimplePolygonSymbol's transparency value.
String	getBoundaryType() Returns the SimplePolygonSymbol's boundary type value.
long	getBoundaryWidth() Returns the SimplePolygonSymbol's boundary width value.
String	getFillColor() Returns the SimplePolygonSymbol's fillcolor value.
long	getFillInterval() Returns the SimplePolygonSymbol's fill interval value.
double	getFillTransparency() Returns the SimplePolygonSymbol's fill transparency value.
String	getFillType() Returns the SimplePolygonSymbol's fill type value.
double	getTransparency() Returns the SimplePolygonSymbol's transparency value.
String	getType() Abstract method returns the type of symbol that the Symbol object represents.
boolean	isAntialiasing() Returns True if the SimplePolygonSymbol's antialiasing value is set to True.
boolean	isBoundary() Returns True if the SimplePolygonSymbol's boundary value is set to True.
boolean	isOverlap() Returns True if the SimplePolygonSymbol's overlap value is set to True.
void	setAntialiasing(boolean value) Sets the SimplePolygonSymbol's antialiasing value.
void	setBoundary(boolean value) Sets the SimplePolygonSymbol's boundary value.
void	setBoundaryCapType(String value) Sets the SimplePolygonSymbol's boundary cap type value.
void	setBoundaryColor(String value) Sets the SimplePolygonSymbol's boundary color value.
void	setBoundaryJoinType(String value) Sets the SimplePolygonSymbol's boundary join type value.
void	setBoundaryTransparency(double value) Sets the SimplePolygonSymbols boundary transparency value.
void	setBoundaryType(String value) Sets the SimplePolygonSymbol's boundary type value.
void	setBoundaryWidth(long value) Sets the SimplePolygonSymbol's boundary width value.
void	setFillColor(String value) Sets the SimplePolygonSymbol's fill color value.
void	setFillInterval(long value) Sets the distance between lines for hatch fills.
void	setFillTransparency(double value) Sets the SimplePolygonSymbol's fill transparency value.
void	setFillType(String value) Sets the SimplePolygonSymbol's fill type value.
void	setOverlap(boolean value) Sets the SimplePolygonSymbol's overlap, which determines if labels can overlap this symbol.
void	setTransparency(double value) Sets the percentage of transparency for this SimplePolygonSymbol.

Methods inherited from class java.lang.Object

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

Field Detail

BUTT

public static final String BUTT

See Also:

Constant Field Values

ROUND

public static final String ROUND

See Also:

Constant Field Values

SQUARE

public static final String SQUARE

See Also:

Constant Field Values

MITER

public static final String MITER

See Also:

Constant Field Values

BEVEL

public static final String BEVEL

See Also:

Constant Field Values

SOLID

public static final String SOLID

See Also:

Constant Field Values

DASH

public static final String DASH

See Also:

Constant Field Values

DOT

public static final String DOT

See Also:

Constant Field Values

DASH_DOT

public static final String DASH_DOT

See Also:

Constant Field Values

DASH_DOT_DOT

public static final String DASH_DOT_DOT

See Also:

Constant Field Values

BDIAGONAL

public static final String BDIAGONAL

See Also:

Constant Field Values

FDIAGONAL

public static final String FDIAGONAL

See Also:

Constant Field Values

CROSS

public static final String CROSS

See Also:

Constant Field Values

DIAGCROSS

public static final String DIAGCROSS

See Also:

Constant Field Values

HORIZONTAL

public static final String HORIZONTAL

See Also:

Constant Field Values

VERTICAL

public static final String VERTICAL

See Also:

Constant Field Values

GRAY

public static final String GRAY

See Also:

Constant Field Values

LIGHTGRAY

public static final String LIGHTGRAY

See Also:

Constant Field Values

DARKGRAY

public static final String DARKGRAY

See Also:

Constant Field Values

Constructor Detail

SimplePolygonSymbol

public SimplePolygonSymbol()

Constructs an instance of a SimplePolygonSymbol Object.

SimplePolygonSymbol simplePolygon = new SimplePolygonSymbol();

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

simplePolygon.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 SimplePolygonSymbol's antialiasing value. Note that the time to generate a map may significantly increase when this property is set to True.

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

setFillColor

public void setFillColor(String value)

Sets the SimplePolygonSymbol's fill color value. Example:

simplePolygon.setFillColor("255,0,0");

Parameters:

value - the fill color value.

See Also:

getFillColor()

setFillInterval

public void setFillInterval(long value)

Sets the distance between lines for hatch fills. Example:

simplePolygon.setFillInterval(5);

Parameters:

value - the fill interval value.

See Also:

getFillInterval()

setFillType

public void setFillType(String value)

Sets the SimplePolygonSymbol's fill type value. Example:

simplePolygon.setFillType("solid");

Parameters:

value - the fill type value.

See Also:

getFillType()

setFillTransparency

public void setFillTransparency(double value)

Sets the SimplePolygonSymbol's fill transparency value.

simplePolygon.setFillTransparency(0.5);

Parameters:

value - the fill transparency value.

See Also:

getFillTransparency()

setBoundaryWidth

public void setBoundaryWidth(long value)

Sets the SimplePolygonSymbol's boundary width value.

simplePolygon.setBoundaryWidth(5);

Parameters:

value - the boundary width value.

See Also:

getBoundaryWidth()

setBoundaryColor

public void setBoundaryColor(String value)

Sets the SimplePolygonSymbol's boundary color value.

simplePolygon.setBoundaryColor("100,0,0");

Parameters:

value - the boundary color value.

See Also:

getBoundaryColor()

setBoundaryType

public void setBoundaryType(String value)

Sets the SimplePolygonSymbol's boundary type value.

simplePolygon.setBoundaryType("SOLID");

Parameters:

value - the boundary type value - SOLID, DASH, DOT, DASH_DOT, or DASH_DOT_DOT.

See Also:

getBoundaryType()

setBoundaryCapType

public void setBoundaryCapType(String value)

Sets the SimplePolygonSymbol's boundary cap type value.

simplePolygon.setBoundaryCapType("BUTT");

Parameters:

value - the boundary captype value - BUTT, ROUND, or SQUARE.

See Also:

getBoundaryCapType()

setBoundaryJoinType

public void setBoundaryJoinType(String value)

Sets the SimplePolygonSymbol's boundary join type value.

simplePolygon.setBoundaryJoinType("ROUND");

Parameters:

value - the boundary jointype value - ROUND, MITER, or BEVEL.

See Also:

getBoundaryJoinType()

setBoundaryTransparency

public void setBoundaryTransparency(double value)

Sets the SimplePolygonSymbols boundary transparency value.

simplePolygon.setBoundaryTransparency(0.5);

Parameters:

value - the boundary transparency value.

See Also:

getBoundaryTransparency()

setBoundary

public void setBoundary(boolean value)

Sets the SimplePolygonSymbol's boundary value.

simplePolygon.setBoundary(false);

Parameters:

value - the boundary value.

See Also:

isBoundary()

setOverlap

public void setOverlap(boolean value)

Sets the SimplePolygonSymbol's overlap, which determines if labels can overlap this symbol.

simplePolygon.setOverlap(false);

Parameters:

value - the overlap value - True or False.

See Also:

isOverlap()

isBoundary

public boolean isBoundary()

Returns True if the SimplePolygonSymbol's boundary value is set to True. Example:

 if(simplePolygon.isBoundary() == true){
  simplePolygon.setBoundary(false);
 }
 

Returns:

boolean

See Also:

setBoundary(boolean)

getTransparency

public double getTransparency()

Returns the SimplePolygonSymbol's transparency value. Example: >

 double transparency = simplePolygon.getTransparency();
 

Returns:

double

See Also:

setTransparency(double)

isAntialiasing

public boolean isAntialiasing()

Returns True if the SimplePolygonSymbol's antialiasing value is set to True.

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

Returns:

boolean

See Also:

setAntialiasing(boolean)

getFillColor

public String getFillColor()

Returns the SimplePolygonSymbol's fillcolor value.

String fillColor = simplePolygon.getFillColor();

Returns:

String

See Also:

setFillColor(java.lang.String)

getFillInterval

public long getFillInterval()

Returns the SimplePolygonSymbol's fill interval value.

long fillInterval = simplePolygon.getFillInterval();

Returns:

long

See Also:

setFillInterval(long)

getFillType

public String getFillType()

Returns the SimplePolygonSymbol's fill type value.

String fillType = simplePolygon.getFillType();

Returns:

String

See Also:

setFillType(java.lang.String)

getFillTransparency

public double getFillTransparency()

Returns the SimplePolygonSymbol's fill transparency value.

double fillTransparency = simplePolygon.getFillTransparency();

Returns:

double

See Also:

setFillTransparency(double)

getBoundaryWidth

public long getBoundaryWidth()

Returns the SimplePolygonSymbol's boundary width value.

long boundaryWidth = simplePolygon.getBoundaryWidth();

Returns:

long

See Also:

setBoundaryWidth(long)

getBoundaryColor

public String getBoundaryColor()

Returns the SimplePolygonSymbol's boundary color value.

String boundaryColor = simplePolygon.getBoundaryColor();

Returns:

String

See Also:

setBoundaryColor(java.lang.String)

getBoundaryType

public String getBoundaryType()

Returns the SimplePolygonSymbol's boundary type value.

String boundaryType = simplePolygon.getBoundaryType();

Returns:

String

See Also:

setBoundaryType(java.lang.String)

getBoundaryCapType

public String getBoundaryCapType()

Returns the SimplePolygonSymbol's boundary cap type value.

String boundaryCapType = simplePolygon.getBoundaryCapType();

Returns:

String

See Also:

setBoundaryCapType(java.lang.String)

getBoundaryJoinType

public String getBoundaryJoinType()

Returns the SimplePolygonSymbol's boundary join type value.

String boundaryJoinType = simplePolygon.getBoundaryJoinType();

Returns:

String

See Also:

setBoundaryJoinType(java.lang.String)

getBoundaryTransparency

public double getBoundaryTransparency()

Returns the SimplePolygonSymbol's transparency value.

double boundaryTransparency = simplePolygon.getBoundaryTransparency();

Returns:

double

See Also:

setBoundaryTransparency(double)

isOverlap

public boolean isOverlap()

Returns True if the SimplePolygonSymbol's overlap value is set to True.

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

Returns:

boolean

See Also:

setOverlap(boolean)