MapScaleBar (vtm 0.6.0 API)

java.lang.Object
- org.oscim.scalebar.MapScaleBar

Direct Known Subclasses:

DefaultMapScaleBar
```
public abstract class MapScaleBar
extends java.lang.Object
```
A MapScaleBar displays the ratio of a distance on the map to the corresponding distance on the ground.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`MapScaleBar.ScaleBarLengthAndValue` Internal class used by calculateScaleBarLengthAndValue
`static class`	`MapScaleBar.ScaleBarPosition`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DistanceUnitAdapter`	`distanceUnitAdapter`
`protected Map`	`map`
`protected Bitmap`	`mapScaleBitmap`
`protected Canvas`	`mapScaleCanvas`
`protected boolean`	`redrawNeeded`
`protected MapScaleBar.ScaleBarPosition`	`scaleBarPosition`

Constructor Summary

Constructors
Constructor and Description

MapScaleBar(Map map, int width, int height)

Constructors
Constructor and Description
`MapScaleBar(Map map, int width, int height)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected MapScaleBar.ScaleBarLengthAndValue`	`calculateScaleBarLengthAndValue()` Calculates the required length and value of the scalebar using the current `DistanceUnitAdapter`
`protected MapScaleBar.ScaleBarLengthAndValue`	`calculateScaleBarLengthAndValue(DistanceUnitAdapter unitAdapter)` Calculates the required length and value of the scalebar
`void`	`destroy()` Free all resources
`void`	`draw(Canvas canvas)`
`void`	`drawScaleBar()` The scalebar is redrawn now.
`DistanceUnitAdapter`	`getDistanceUnitAdapter()`
`int`	`getMarginHorizontal()`
`int`	`getMarginVertical()`
`MapScaleBar.ScaleBarPosition`	`getScaleBarPosition()`
`protected boolean`	`isRedrawNecessary()` Determines if a redraw is necessary or not
`boolean`	`isVisible()`
`protected abstract void`	`redraw(Canvas canvas)` Redraw the map scale bar.
`void`	`redrawScaleBar()` The scalebar will be redrawn on the next draw()
`void`	`setDistanceUnitAdapter(DistanceUnitAdapter distanceUnitAdapter)` Set the `DistanceUnitAdapter` for the MapScaleBar
`void`	`setMarginHorizontal(int marginHorizontal)`
`void`	`setMarginVertical(int marginVertical)`
`void`	`setScaleBarPosition(MapScaleBar.ScaleBarPosition scaleBarPosition)`
`void`	`setVisible(boolean visible)` Set the visibility of this `MapScaleBar`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - distanceUnitAdapter
```
protected DistanceUnitAdapter distanceUnitAdapter
```
  - map
```
protected final Map map
```
  - mapScaleBitmap
```
protected Bitmap mapScaleBitmap
```
  - mapScaleCanvas
```
protected Canvas mapScaleCanvas
```
  - redrawNeeded
```
protected boolean redrawNeeded
```
  - scaleBarPosition
```
protected MapScaleBar.ScaleBarPosition scaleBarPosition
```
- Constructor Detail
  - MapScaleBar
```
public MapScaleBar(Map map,
                   int width,
                   int height)
```
- Method Detail
  - destroy
```
public void destroy()
```
    Free all resources
  - isVisible
```
public boolean isVisible()
```
    Returns:
    
    true if this MapScaleBar is visible
  - setVisible
```
public void setVisible(boolean visible)
```
    Set the visibility of this MapScaleBar
    
    Parameters:
    
    visible - true if the MapScaleBar should be visible, false otherwise
  - getDistanceUnitAdapter
```
public DistanceUnitAdapter getDistanceUnitAdapter()
```
    Returns:
    
    the DistanceUnitAdapter in use by this MapScaleBar
  - setDistanceUnitAdapter
```
public void setDistanceUnitAdapter(DistanceUnitAdapter distanceUnitAdapter)
```
    Set the DistanceUnitAdapter for the MapScaleBar
    
    Parameters:
    
    distanceUnitAdapter - The DistanceUnitAdapter to be used by this MapScaleBar
  - getMarginHorizontal
```
public int getMarginHorizontal()
```
  - setMarginHorizontal
```
public void setMarginHorizontal(int marginHorizontal)
```
  - getMarginVertical
```
public int getMarginVertical()
```
  - setMarginVertical
```
public void setMarginVertical(int marginVertical)
```
  - getScaleBarPosition
```
public MapScaleBar.ScaleBarPosition getScaleBarPosition()
```
  - setScaleBarPosition
```
public void setScaleBarPosition(MapScaleBar.ScaleBarPosition scaleBarPosition)
```
  - calculateScaleBarLengthAndValue
```
protected MapScaleBar.ScaleBarLengthAndValue calculateScaleBarLengthAndValue(DistanceUnitAdapter unitAdapter)
```
    Calculates the required length and value of the scalebar
    
    Parameters:
    
    unitAdapter - the DistanceUnitAdapter to calculate for
    
    Returns:
    
    a MapScaleBar.ScaleBarLengthAndValue object containing the required scaleBarLength and scaleBarValue
  - calculateScaleBarLengthAndValue
```
protected MapScaleBar.ScaleBarLengthAndValue calculateScaleBarLengthAndValue()
```
    Calculates the required length and value of the scalebar using the current DistanceUnitAdapter
    
    Returns:
    
    a MapScaleBar.ScaleBarLengthAndValue object containing the required scaleBarLength and scaleBarValue
  - draw
```
public void draw(Canvas canvas)
```
    Parameters:
    
    canvas - The canvas to use to draw the MapScaleBar
  - drawScaleBar
```
public void drawScaleBar()
```
    The scalebar is redrawn now.
  - redrawScaleBar
```
public void redrawScaleBar()
```
    The scalebar will be redrawn on the next draw()
  - isRedrawNecessary
```
protected boolean isRedrawNecessary()
```
    Determines if a redraw is necessary or not
    
    Returns:
    
    true if redraw is necessary, false otherwise
  - redraw
```
protected abstract void redraw(Canvas canvas)
```
    Redraw the map scale bar. Make sure you always apply scale factor to all coordinates and dimensions.
    
    Parameters:
    
    canvas - The canvas to draw on

Class MapScaleBar

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distanceUnitAdapter

map

mapScaleBitmap

mapScaleCanvas

redrawNeeded

scaleBarPosition

Constructor Detail

MapScaleBar

Method Detail

destroy

isVisible

setVisible

getDistanceUnitAdapter

setDistanceUnitAdapter

getMarginHorizontal

setMarginHorizontal

getMarginVertical

setMarginVertical

getScaleBarPosition

setScaleBarPosition

calculateScaleBarLengthAndValue

calculateScaleBarLengthAndValue

draw

drawScaleBar

redrawScaleBar

isRedrawNecessary

redraw