org.deegree.graphics
Interface ScaleBar

All Known Implementing Classes:

ScaleBar_Impl

public interface ScaleBar

Version:

$Revision: 1.3 $

Author:

Andreas Poth

Field Summary

static int	L_NONE
static int	L_SCALE
static int	L_SCALEDENOMINATOR

Method Summary

void	paint(java.awt.Graphics g) will paint the scale bar to the passed graphic context
void	setBackgroundColor(java.awt.Color color) sets the background color of the scale bar
void	setBarColor(java.awt.Color color) sets the front color of the scale bar
void	setBottomLabel(int labelType) sets the type of the label below the scale bar
void	setFont(java.awt.Font font) sets the font for label rendering
void	setLabelColor(java.awt.Color color) sets the label color of the scale bar
void	setScale(double scale) sets the scale as defined in the OGC WMS 1.1.1 specification.
void	setScaleDenominator(int scaleDen) sets the scale denominator for the scale bar.
void	setStyle(java.lang.String style) sets the style of the scale bar. default style is |--------| the list of known styles depends on the implementation
void	setTopLabel(int labelType) sets the type of the label above the scale bar
void	setUnits(java.lang.String units) sets the units the scale and the scale denominater will be expressed at.

Field Detail

L_NONE

public static final int L_NONE

See Also:

Constant Field Values

L_SCALE

public static final int L_SCALE

See Also:

Constant Field Values

L_SCALEDENOMINATOR

public static final int L_SCALEDENOMINATOR

See Also:

Constant Field Values

Method Detail

paint

public void paint(java.awt.Graphics g)

will paint the scale bar to the passed graphic context

Parameters:

g - graphic context

setTopLabel

public void setTopLabel(int labelType)

sets the type of the label above the scale bar

Parameters:

labelType - lable type

setBottomLabel

public void setBottomLabel(int labelType)

sets the type of the label below the scale bar

Parameters:

labelType - lable type

setScale

public void setScale(double scale)

sets the scale as defined in the OGC WMS 1.1.1 specification. Scale is defined as the diagonal size of a pixel in the center of a map measured in meter. The setting of the scale will affect the value of the scale denominator

setScaleDenominator

public void setScaleDenominator(int scaleDen)

sets the scale denominator for the scale bar. The scale denominator is the scale expression as we know it for printed maps (e.g. 1:10000 1:5000). The passed value is expressed in meters. The setting of the scale denominator will affect the value of the scale

Parameters:

scaleDen - scale denominator value

setUnits

public void setUnits(java.lang.String units)

sets the units the scale and the scale denominater will be expressed at. Settings other than meter will cause that the passed values for scale and scale denominater will be recalculated for painting. it depends on the implementation what units are supported.

Parameters:

units - name units (meter, miles, feet etc.)

setBarColor

public void setBarColor(java.awt.Color color)

sets the front color of the scale bar

setLabelColor

public void setLabelColor(java.awt.Color color)

sets the label color of the scale bar

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

sets the background color of the scale bar

setStyle

public void setStyle(java.lang.String style)

sets the style of the scale bar. default style is |--------| the list of known styles depends on the implementation

Parameters:

style - style name

setFont

public void setFont(java.awt.Font font)

sets the font for label rendering

Parameters:

font - awt font object