com.esri.arcgisws
Class ScaleBar

java.lang.Object
  com.esri.arcgisws.ScaleBar

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AlternatingScaleBar, SingleDivisionScaleBar

public abstract class ScaleBar
extends Object
implements Serializable

A map surround for displaying a scale bar.

Java class for ScaleBar complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ScaleBar">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="BarHeight" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="Division" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="Divisions" type="{http://www.w3.org/2001/XMLSchema}short" minOccurs="0"/>
         <element name="DivisionsBeforeZero" type="{http://www.w3.org/2001/XMLSchema}short" minOccurs="0"/>
         <element name="Subdivisions" type="{http://www.w3.org/2001/XMLSchema}short" minOccurs="0"/>
         <element name="Units" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriUnits" minOccurs="0"/>
         <element name="UnitLabel" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="UnitLabelPosition" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriScaleBarPos" minOccurs="0"/>
         <element name="UnitLabelGap" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="UnitLabelSymbol" type="{http://www.esri.com/schemas/ArcGIS/10.0}TextSymbol" minOccurs="0"/>
         <element name="LabelFrequency" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriScaleBarFrequency" minOccurs="0"/>
         <element name="LabelPosition" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriVertPosEnum" minOccurs="0"/>
         <element name="LabelGap" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="LabelSymbol" type="{http://www.esri.com/schemas/ArcGIS/10.0}TextSymbol" minOccurs="0"/>
         <element name="NumberFormat" type="{http://www.esri.com/schemas/ArcGIS/10.0}NumericFormat" minOccurs="0"/>
         <element name="ResizeHint" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriScaleBarResizeHint" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

A map surround for displaying a scale bar.

See Also:

Serialized Form

Constructor Summary

ScaleBar()
ScaleBar default constructor.

ScaleBar(Double barHeight, Double division, Short divisions, Short divisionsBeforeZero, Short subdivisions, EsriUnits units, String unitLabel, EsriScaleBarPos unitLabelPosition, Double unitLabelGap, TextSymbol unitLabelSymbol, EsriScaleBarFrequency labelFrequency, EsriVertPosEnum labelPosition, Double labelGap, TextSymbol labelSymbol, NumericFormat numberFormat, EsriScaleBarResizeHint resizeHint)
Deprecated.

Method Summary

Double	getBarHeight() Gets the value of the barHeight property.
Double	getDivision() Gets the value of the division property.
Short	getDivisions() Gets the value of the divisions property.
Short	getDivisionsBeforeZero() Gets the value of the divisionsBeforeZero property.
EsriScaleBarFrequency	getLabelFrequency() Gets the value of the labelFrequency property.
Double	getLabelGap() Gets the value of the labelGap property.
EsriVertPosEnum	getLabelPosition() Gets the value of the labelPosition property.
TextSymbol	getLabelSymbol() Gets the value of the labelSymbol property.
NumericFormat	getNumberFormat() Gets the value of the numberFormat property.
EsriScaleBarResizeHint	getResizeHint() Gets the value of the resizeHint property.
Short	getSubdivisions() Gets the value of the subdivisions property.
String	getUnitLabel() Gets the value of the unitLabel property.
Double	getUnitLabelGap() Gets the value of the unitLabelGap property.
EsriScaleBarPos	getUnitLabelPosition() Gets the value of the unitLabelPosition property.
TextSymbol	getUnitLabelSymbol() Gets the value of the unitLabelSymbol property.
EsriUnits	getUnits() Gets the value of the units property.
void	setBarHeight(Double value) Sets the value of the barHeight property.
void	setDivision(Double value) Sets the value of the division property.
void	setDivisions(Short value) Sets the value of the divisions property.
void	setDivisionsBeforeZero(Short value) Sets the value of the divisionsBeforeZero property.
void	setLabelFrequency(EsriScaleBarFrequency value) Sets the value of the labelFrequency property.
void	setLabelGap(Double value) Sets the value of the labelGap property.
void	setLabelPosition(EsriVertPosEnum value) Sets the value of the labelPosition property.
void	setLabelSymbol(TextSymbol value) Sets the value of the labelSymbol property.
void	setNumberFormat(NumericFormat value) Sets the value of the numberFormat property.
void	setResizeHint(EsriScaleBarResizeHint value) Sets the value of the resizeHint property.
void	setSubdivisions(Short value) Sets the value of the subdivisions property.
void	setUnitLabel(String value) Sets the value of the unitLabel property.
void	setUnitLabelGap(Double value) Sets the value of the unitLabelGap property.
void	setUnitLabelPosition(EsriScaleBarPos value) Sets the value of the unitLabelPosition property.
void	setUnitLabelSymbol(TextSymbol value) Sets the value of the unitLabelSymbol property.
void	setUnits(EsriUnits value) Sets the value of the units property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScaleBar

@Deprecated
public ScaleBar(Double barHeight,
                           Double division,
                           Short divisions,
                           Short divisionsBeforeZero,
                           Short subdivisions,
                           EsriUnits units,
                           String unitLabel,
                           EsriScaleBarPos unitLabelPosition,
                           Double unitLabelGap,
                           TextSymbol unitLabelSymbol,
                           EsriScaleBarFrequency labelFrequency,
                           EsriVertPosEnum labelPosition,
                           Double labelGap,
                           TextSymbol labelSymbol,
                           NumericFormat numberFormat,
                           EsriScaleBarResizeHint resizeHint)

Deprecated.

ScaleBar constructor.

ScaleBar

public ScaleBar()

ScaleBar default constructor.

Method Detail

getBarHeight

public Double getBarHeight()

Gets the value of the barHeight property.

Returns:

possible object is Double

setBarHeight

public void setBarHeight(Double value)

Sets the value of the barHeight property.

Parameters:

value - allowed object is Double

getDivision

public Double getDivision()

Gets the value of the division property.

Returns:

possible object is Double

setDivision

public void setDivision(Double value)

Sets the value of the division property.

Parameters:

value - allowed object is Double

getDivisions

public Short getDivisions()

Gets the value of the divisions property.

Returns:

possible object is Short

setDivisions

public void setDivisions(Short value)

Sets the value of the divisions property.

Parameters:

value - allowed object is Short

getDivisionsBeforeZero

public Short getDivisionsBeforeZero()

Gets the value of the divisionsBeforeZero property.

Returns:

possible object is Short

setDivisionsBeforeZero

public void setDivisionsBeforeZero(Short value)

Sets the value of the divisionsBeforeZero property.

Parameters:

value - allowed object is Short

getSubdivisions

public Short getSubdivisions()

Gets the value of the subdivisions property.

Returns:

possible object is Short

setSubdivisions

public void setSubdivisions(Short value)

Sets the value of the subdivisions property.

Parameters:

value - allowed object is Short

getUnits

public EsriUnits getUnits()

Gets the value of the units property.

Returns:

possible object is EsriUnits

setUnits

public void setUnits(EsriUnits value)

Sets the value of the units property.

Parameters:

value - allowed object is EsriUnits

getUnitLabel

public String getUnitLabel()

Gets the value of the unitLabel property.

Returns:

possible object is String

setUnitLabel

public void setUnitLabel(String value)

Sets the value of the unitLabel property.

Parameters:

value - allowed object is String

getUnitLabelPosition

public EsriScaleBarPos getUnitLabelPosition()

Gets the value of the unitLabelPosition property.

Returns:

possible object is EsriScaleBarPos

setUnitLabelPosition

public void setUnitLabelPosition(EsriScaleBarPos value)

Sets the value of the unitLabelPosition property.

Parameters:

value - allowed object is EsriScaleBarPos

getUnitLabelGap

public Double getUnitLabelGap()

Gets the value of the unitLabelGap property.

Returns:

possible object is Double

setUnitLabelGap

public void setUnitLabelGap(Double value)

Sets the value of the unitLabelGap property.

Parameters:

value - allowed object is Double

getUnitLabelSymbol

public TextSymbol getUnitLabelSymbol()

Gets the value of the unitLabelSymbol property.

Returns:

possible object is TextSymbol

setUnitLabelSymbol

public void setUnitLabelSymbol(TextSymbol value)

Sets the value of the unitLabelSymbol property.

Parameters:

value - allowed object is TextSymbol

getLabelFrequency

public EsriScaleBarFrequency getLabelFrequency()

Gets the value of the labelFrequency property.

Returns:

possible object is EsriScaleBarFrequency

setLabelFrequency

public void setLabelFrequency(EsriScaleBarFrequency value)

Sets the value of the labelFrequency property.

Parameters:

value - allowed object is EsriScaleBarFrequency

getLabelPosition

public EsriVertPosEnum getLabelPosition()

Gets the value of the labelPosition property.

Returns:

possible object is EsriVertPosEnum

setLabelPosition

public void setLabelPosition(EsriVertPosEnum value)

Sets the value of the labelPosition property.

Parameters:

value - allowed object is EsriVertPosEnum

getLabelGap

public Double getLabelGap()

Gets the value of the labelGap property.

Returns:

possible object is Double

setLabelGap

public void setLabelGap(Double value)

Sets the value of the labelGap property.

Parameters:

value - allowed object is Double

getLabelSymbol

public TextSymbol getLabelSymbol()

Gets the value of the labelSymbol property.

Returns:

possible object is TextSymbol

setLabelSymbol

public void setLabelSymbol(TextSymbol value)

Sets the value of the labelSymbol property.

Parameters:

value - allowed object is TextSymbol

getNumberFormat

public NumericFormat getNumberFormat()

Gets the value of the numberFormat property.

Returns:

possible object is NumericFormat

setNumberFormat

public void setNumberFormat(NumericFormat value)

Sets the value of the numberFormat property.

Parameters:

value - allowed object is NumericFormat

getResizeHint

public EsriScaleBarResizeHint getResizeHint()

Gets the value of the resizeHint property.

Returns:

possible object is EsriScaleBarResizeHint

setResizeHint

public void setResizeHint(EsriScaleBarResizeHint value)

Sets the value of the resizeHint property.

Parameters:

value - allowed object is EsriScaleBarResizeHint