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

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

All Implemented Interfaces:

Serializable

public class GradientFillSymbol
extends Symbol

This object assigns color gradients as symbols to FeatureLayers. It fills the polygon with a gradual variation of colors ranging from startcolor to finishcolor. The GradientFillSymbol object extends the Symbol object.

See Also:

Serialized Form

Field Summary

static String	BDIAGONAL
static String	FDIAGONAL
static String	HORIZONTAL
static String	VERTICAL

Constructor Summary

GradientFillSymbol()
Constructs an instance of the GradientFillSymbol object.

Method Summary

String	getFillType() Returns the GradientFillSymbol's fill type as string.
String	getFinishColor() Returns the GradientFillSymbol's finish color value.
String	getStartColor() Returns the GradientFillSymbol's start color value.
double	getTransparency() Returns the GradientFillSymbol's transparency value.
String	getType() Returns name string defining the type of symbol.
boolean	isAntialiasing() Determines if the GradientFillSymbol's antialiasing method is set.
boolean	isOverlap() Determines if this GradientFillSymbol's overlap method is set.
void	setAntialiasing(boolean value) Sets the antialiasing value for the GradientFillSymbol.
void	setFillType(String value) Sets the fill type for this GradientFillSymbol object.
void	setFinishColor(String value) Sets the GradientFillSymbol's end color as a RGB value.
void	setOverlap(boolean value) Sets the overlap value, which determines if labels can overlap this symbol.
void	setStartColor(String value) Sets the GradientFillSymbol's start color as a RGB value.
void	setTransparency(double value) Sets the percentage of transparency for this GradientFillSymbol.

Methods inherited from class java.lang.Object

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

Field Detail

BDIAGONAL

public static final String BDIAGONAL

See Also:

Constant Field Values

FDIAGONAL

public static final String FDIAGONAL

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

Constructor Detail

GradientFillSymbol

public GradientFillSymbol()

Constructs an instance of the GradientFillSymbol object. Example:

GradientFillSymbol gradientFill = new GradientFillSymbol();

Method Detail

getType

public String getType()

Returns name string defining the type of symbol.

Specified by:

getType in class Symbol

Returns:

String

setTransparency

public void setTransparency(double value)

Sets the percentage of transparency for this GradientFillSymbol.

gradientFill.setTransparency(100.0);

Parameters:

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

See Also:

getTransparency()

getTransparency

public double getTransparency()

Returns the GradientFillSymbol's transparency value. Example:

double transparency = gradientFill.getTransparency();

Returns:

double

See Also:

setTransparency(double)

setAntialiasing

public void setAntialiasing(boolean value)

Sets the antialiasing value for the GradientFillSymbol. Note that the time to generate a map may significantly increase when this property is set to True. Example:

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

isAntialiasing

public boolean isAntialiasing()

Determines if the GradientFillSymbol's antialiasing method is set. Example:

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

Returns:

a boolean value.

See Also:

setAntialiasing(boolean)

setFillType

public void setFillType(String value)

Sets the fill type for this GradientFillSymbol object. Example:

 gradientFill.setFillType(gradientFill.BDIAGONAL);
 

Parameters:

value - the type value.

See Also:

getFillType()

getFillType

public String getFillType()

Returns the GradientFillSymbol's fill type as string. Example:

 String type = gradientFill.getFillType();
 

Returns:

String

See Also:

setFillType(java.lang.String)

setStartColor

public void setStartColor(String value)

Sets the GradientFillSymbol's start color as a RGB value. Example:

 gradientFill.setStartColor("100,100,100");
 

Parameters:

value - the start color value.

See Also:

getStartColor()

getStartColor

public String getStartColor()

Returns the GradientFillSymbol's start color value. Example:

 String startColor = gradientFill.getStartColor();
 

Returns:

String

See Also:

setStartColor(java.lang.String)

setFinishColor

public void setFinishColor(String value)

Sets the GradientFillSymbol's end color as a RGB value. Example:

 gradientFill.setFinishColor("100,100,100");
 

Parameters:

value - the end color value.

See Also:

getFinishColor()

getFinishColor

public String getFinishColor()

Returns the GradientFillSymbol's finish color value. Example:

 String finishColor = gradientFill.getFinishColor();
 

Returns:

String

See Also:

setFinishColor(java.lang.String)

setOverlap

public void setOverlap(boolean value)

Sets the overlap value, which determines if labels can overlap this symbol. When True, labels can overlap. If labels are not drawing as expected, check if overlap is set to False for this symbol or for any other symbol in this service. Example:

 gradientFill.setOverlap(true);
 

Parameters:

value - the overlap value.

See Also:

isOverlap()

isOverlap

public boolean isOverlap()

Determines if this GradientFillSymbol's overlap method is set. Example:

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

Returns:

boolean

See Also:

setOverlap(boolean)