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

java.lang.Object
  extended by com.esri.adf.web.data.symbol.WebSymbol
      extended by com.esri.adf.web.data.symbol.WebScalebarSymbol
All Implemented Interfaces:
Serializable

public class WebScalebarSymbol
extends WebSymbol

WebScalebarSymbol represents a scalebar symbol.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.adf.web.data.symbol.WebSymbol
transparency
 
Constructor Summary
WebScalebarSymbol()
          Creates an empty instance of WebScalebarSymbol
 
Method Summary
 boolean equals(Object obj)
           
 Font getFont()
          Returns the scalebar label font
 double getMapDistance()
          Returns the map distance
 String getType()
          Returns the scale bar type.
 int getUnit()
          Returns an constant integer for unit the constant is defined in MeasureUtil class.
 int getWidth()
          Returns the width of the scalebar.
 int hashCode()
           
 void setFont(Font scaleLabelFont)
          Sets the font used for drawing the label on the scalebar
 void setMapDistance(double mapDistance)
          Sets the map distance what the symbol's width represents.
 void setType(String type)
          Sets the scalebar type
 void setUnit(int mapUnit)
          Sets the unit label.
 void setWidth(int width)
          Sets the width of the scalebar.
 String toString()
           
 
Methods inherited from class com.esri.adf.web.data.symbol.WebSymbol
getAngle, getTransparency, isAntialiasing, setAngle, setAntialiasing, setTransparency
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WebScalebarSymbol

public WebScalebarSymbol()
Creates an empty instance of WebScalebarSymbol

Method Detail

setType

public void setType(String type)
Sets the scalebar type

Parameters:
type - - String
See Also:
WebScaleBar

getType

public String getType()
Returns the scale bar type.

Specified by:
getType in class WebSymbol
Returns:
the string representation of scale bar symbol type
See Also:
WebScaleBar

setWidth

public void setWidth(int width)
Sets the width of the scalebar. The width represents the screen distance.

Overrides:
setWidth in class WebSymbol
Parameters:
width - - the width of the scalebar

getWidth

public int getWidth()
Returns the width of the scalebar.

Overrides:
getWidth in class WebSymbol
Returns:
the scalebar width

setMapDistance

public void setMapDistance(double mapDistance)
Sets the map distance what the symbol's width represents.

Parameters:
mapDistance - - a double number

getMapDistance

public double getMapDistance()
Returns the map distance

Returns:
- double;

setUnit

public void setUnit(int mapUnit)
Sets the unit label. It is only for drawing

Parameters:
mapUnit - - int
See Also:
class

getUnit

public int getUnit()
Returns an constant integer for unit the constant is defined in MeasureUtil class.

Returns:
an integer

setFont

public void setFont(Font scaleLabelFont)
Sets the font used for drawing the label on the scalebar

Parameters:
scaleLabelFont - - a Font object

getFont

public Font getFont()
Returns the scalebar label font

Returns:
Font - font

toString

public String toString()
Overrides:
toString in class WebSymbol

hashCode

public int hashCode()
Overrides:
hashCode in class WebSymbol

equals

public boolean equals(Object obj)
Overrides:
equals in class WebSymbol