com.esri.adf.web.data.symbol
Class WebSymbol

java.lang.Object
  com.esri.adf.web.data.symbol.WebSymbol

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

WebPictureMarkerSymbol, WebScalebarSymbol, WebSimpleLineSymbol, WebSimpleMarkerSymbol, WebTrueTypeMarkerSymbol

public abstract class WebSymbol
extends java.lang.Object
implements java.io.Serializable

WebSymbol is an abstract super class for all symbol classes. Developers are expected to instantiate WebSymbol's subclasses.

See Also:

Serialized Form

Field Summary

protected double

transparency

Constructor Summary

WebSymbol()

Method Summary

boolean	equals(java.lang.Object obj)
double	getAngle() Returns the symbol angle, default value is 0.
double	getTransparency() Returns the symbol transparency value.
abstract java.lang.String	getType() Returns the type of symbol that the Symbol object represents.
int	getWidth() Returns width of the symbol.
int	hashCode()
boolean	isAntialiasing() Returns true if the symbol antialiasing value is set to true.
void	setAngle(double angle) Sets the symbol angle value, default value is 0.
void	setAntialiasing(boolean antialiasing) Sets the antialiasing value for this symbol.
void	setTransparency(double transparency) Sets the percentage of transparency for this symbol, default value is 1.0
void	setWidth(int width) Sets the width of the symbol, default value is 0.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

transparency

protected double transparency

Constructor Detail

WebSymbol

public WebSymbol()

Method Detail

getType

public abstract java.lang.String getType()

Returns the type of symbol that the Symbol object represents.

Returns:

the string representation of symbol type

setAngle

public void setAngle(double angle)

Sets the symbol angle value, default value is 0.

Parameters:

angle - the symbol angle value in degrees. The angle of the symbol is calculated in a clockwise direction

getAngle

public double getAngle()

Returns the symbol angle, default value is 0.

Returns:

the symbol angle

setAntialiasing

public void setAntialiasing(boolean antialiasing)

Sets the antialiasing value for this symbol. By default the value is false to reduce the drawing time.

Parameters:

antialiasing - the antialiasing value, default value is false

See Also:

isAntialiasing()

isAntialiasing

public boolean isAntialiasing()

Returns true if the symbol antialiasing value is set to true.

Returns:

the antialiasing for this symbol

See Also:

setAntialiasing(boolean)

setTransparency

public void setTransparency(double transparency)

Sets the percentage of transparency for this symbol, default value is 1.0

 For Example,
   symbol.setTransparency(1.0);
 

Parameters:

transparency - 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 symbol transparency value.

 For Example,
   double transparency = symbol.getTransparency();
 

Returns:

the transparency value for the symbol

See Also:

setTransparency(double)

setWidth

public void setWidth(int width)

Sets the width of the symbol, default value is 0.

Parameters:

width - the symbol width in pixels

getWidth

public int getWidth()

Returns width of the symbol.

Returns:

width of the symbol

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object