gistoolkit.display
Interface ScaleBar

All Known Implementing Classes:
SimpleScaleBar

public interface ScaleBar

Class to display a scale bar on the map.


Method Summary
 void drawScale(java.awt.Graphics inGraphics, Converter inConverter, int inWidth, int inHeight)
          Method to draw a scale bar on the graphics context.
 java.lang.String getDescription()
          A description to be displayed to the user that indicates what this scale bar does.
 Node getNode()
          Get the configuration information for this ScaleBar
 void setNode(Node inNode)
          Set the configuration information for this ScaleBar
 

Method Detail

getDescription

public java.lang.String getDescription()
A description to be displayed to the user that indicates what this scale bar does. A good thing to indicates is that it takes a projection in meters and displays a scale in metric. Or that it takes a projection in feed and displays a scale in in,ft,yd,and miles.


drawScale

public void drawScale(java.awt.Graphics inGraphics,
                      Converter inConverter,
                      int inWidth,
                      int inHeight)
Method to draw a scale bar on the graphics context.


getNode

public Node getNode()
Get the configuration information for this ScaleBar


setNode

public void setNode(Node inNode)
             throws java.lang.Exception
Set the configuration information for this ScaleBar

Throws:
java.lang.Exception