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

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

All Implemented Interfaces:

Serializable

public class SimpleLineSymbol
extends Symbol

Respresents a symbol for a line feature.

See Also:

Serialized Form

Field Summary

static String	DASH
static String	DASH_DOT
static String	DASH_DOT_DOT
static String	DOT
static String	SOLID

Constructor Summary

SimpleLineSymbol()
Constructs an instance of a SimpleLineSymbol object.

Method Summary

String	getCapType() Returns the SimpleLineSymbol's line end style.
String	getColor() Returns the SimpleLineSymbol's color value.
String	getJoinType() Returns the SimpleLineSymbol's joint type value.
String	getLineType() Returns the SimpleLineSymbol's line type value.
double	getTransparency() Returns the SimpleLineSymbol's transparency value.
String	getType() Abstract method returns the type of symbol that the Symbol object represents.
long	getWidth() Returns the SimpleLineSymbol's width value.
boolean	isAntialiasing() Returns True if the SimpleLineSymbol's antialiasing value is set to True.
boolean	isOverlap() Returns True if SimpleLineSymbol's overlap method is set to True.
void	setAntialiasing(boolean value) Sets the antialiasing value for this SimpleLineSymbol.
void	setCapType(String value) Sets the line end style for this SimpleLineSymbol.
void	setColor(String value) Sets the SimpleLineSymbol's color value.
void	setJoinType(String value) Sets the line join type for this SimpleLineSymbol.
void	setLineType(String value) Sets the SimpleLineSymbol's line type value.
void	setOverlap(boolean value) Sets the SimpleLineSymbol's overlap value.
void	setTransparency(double value) Sets the percentage of transparency for this SimpleLineSymbol.
void	setWidth(long value) Sets the SimpleLineSymbol's width value.

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

SimpleLineSymbol

public SimpleLineSymbol()

Constructs an instance of a SimpleLineSymbol object.

SimpleLineSymbol simpleLine = new SimpleLineSymbol();

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

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

simpleLine.setAntialiasing(false);

Parameters:

value - the antialiasing value.

See Also:

isAntialiasing()

setColor

public void setColor(String value)

Sets the SimpleLineSymbol's color value.

simpleLine.setColor("255,0,0");

Parameters:

value - the color value.

See Also:

getColor()

setLineType

public void setLineType(String value)

Sets the SimpleLineSymbol's line type value.

simpleLine.setLineType("solid");

Parameters:

value - the line type value.

See Also:

getLineType()

setWidth

public void setWidth(long value)

Sets the SimpleLineSymbol's width value.

simpleLine.setWidth(10);

Parameters:

value - the width value.

setCapType

public void setCapType(String value)

Sets the line end style for this SimpleLineSymbol.

simpleLine.setCapType("BUTT");

Parameters:

value - the line end style - BUTT, ROUND, or SQUARE.

See Also:

getCapType()

setJoinType

public void setJoinType(String value)

Sets the line join type for this SimpleLineSymbol. Example:

simpleLine.setJoinType("ROUND");

Parameters:

value - the line join type - ROUND (Default), MITER, or BEVEL

See Also:

getJoinType()

getJoinType

public String getJoinType()

Returns the SimpleLineSymbol's joint type value. Example:

String joinType = simpleLine.getJoinType();

Returns:

the SimpleLineSymbol's jointype value.

See Also:

setJoinType(java.lang.String)

getTransparency

public double getTransparency()

Returns the SimpleLineSymbol's transparency value. Example:

double transparency = simpleLine.getTransparency();

Returns:

String

See Also:

setTransparency(double)

getCapType

public String getCapType()

Returns the SimpleLineSymbol's line end style. Example:

String capType = simpleLine.getCapType();

Returns:

String

See Also:

setCapType(java.lang.String)

getWidth

public long getWidth()

Returns the SimpleLineSymbol's width value. Example:

long width = simpleLine.getWidth();

Returns:

long

See Also:

setWidth(long)

getLineType

public String getLineType()

Returns the SimpleLineSymbol's line type value. Example:

String lineType = simpleLine.getLineType();

Returns:

String

See Also:

setLineType(java.lang.String)

getColor

public String getColor()

Returns the SimpleLineSymbol's color value. Example:

String color = simpleLine.getColor();

Returns:

String

See Also:

setColor(java.lang.String)

isAntialiasing

public boolean isAntialiasing()

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

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

Returns:

boolean

See Also:

setAntialiasing(boolean)

setOverlap

public void setOverlap(boolean value)

Sets the SimpleLineSymbol's overlap value. Example:

simpleLine.setOverlap(false);

Parameters:

value - the overlap value.

See Also:

isOverlap()

isOverlap

public boolean isOverlap()

Returns True if SimpleLineSymbol's overlap method is set to True. Example:

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

Returns:

boolean

See Also:

setOverlap(boolean)