ch.so.agi.oereb.pdf4oereb.saxon.ext

Class ScalebarGenerator

java.lang.Object

ch.so.agi.oereb.pdf4oereb.saxon.ext.ScalebarGenerator

public class ScalebarGenerator
extends java.lang.Object

This utility generates an image presenting a scalebar of the map based in the give scale.
It can be customized to apply different colors for segments (even, uneven) height, margins, text colors.
The scalebar switches as needed to measure from mm up to km depending in the scale and required width.

Constructor Summary

Constructors

Constructor and Description
ScalebarGenerator() Constructor

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getImage(java.lang.Double scale, double width, double dpi) Generate the image of the scalebar.
byte[]	getImageAsByte(java.lang.Double scale, double width, double dpi)
java.lang.String	getImageAsFileLocation(java.lang.Double scale, double width, double dpi) Generate the image of the scalebar, stores it in a temporary location and returns the file location.
java.lang.String	getImageAsFileLocation(java.lang.Double scale, double width, double dpi, java.lang.String fileNameWithoutExtension)
void	setColorBorderSegment(java.awt.Color colorBorderSegment) A color for the border of the segment.
void	setColorSegmentEven(java.awt.Color colorSegmentEven) Set color for the even segments.
void	setColorSegmentUneven(java.awt.Color colorSegmentUneven) Set color for the uneven segments.
void	setColorText(java.awt.Color colorText) Sets color for the texts used.
void	setDrawScaleText(boolean drawScaleText) Controls whether the scale is displayed on top of the scale bar or not
void	setHeight(int height) Sets the height of the entire image.
void	setLrbMargin(int lrbMargin) Sets the margin for the left, right and bottom of the control.
void	setNumberOfSegments(int numberOfSegments) Sets the number of segments to be displayed in the scalebar.
void	setTextFont(java.awt.Font textFont) Sets the font of the texts used.
void	setTopMargin(int topMargin) Sets the size of the margin above the scale bar.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalebarGenerator

public ScalebarGenerator()

Constructor

Method Detail

setColorBorderSegment

public void setColorBorderSegment(java.awt.Color colorBorderSegment)

A color for the border of the segment.

Parameters:

colorBorderSegment -

setColorSegmentEven

public void setColorSegmentEven(java.awt.Color colorSegmentEven)

Set color for the even segments.

Parameters:

colorSegmentEven -

setColorSegmentUneven

public void setColorSegmentUneven(java.awt.Color colorSegmentUneven)

Set color for the uneven segments.

Parameters:

colorSegmentUneven -

setColorText

public void setColorText(java.awt.Color colorText)

Sets color for the texts used.

Parameters:

colorText -

setDrawScaleText

public void setDrawScaleText(boolean drawScaleText)

Controls whether the scale is displayed on top of the scale bar or not

Parameters:

drawScaleText - If false, the scale text will not be displayed.

setHeight

public void setHeight(int height)

Sets the height of the entire image. The height of the scale bar is calculated from height - (lrbMargin + topMargin). The default image height is 40. The default scale bar height is 10.

Parameters:

height -

setLrbMargin

public void setLrbMargin(int lrbMargin)

Sets the margin for the left, right and bottom of the control. The margin is the distance from the edge of the image to the scale bar. This margin must be big enough to allow display of the distance text. The default value is 15.

Parameters:

margin - The size of the margin to set around the left, right and bottom of the scalebar image.

setTopMargin

public void setTopMargin(int topMargin)

Sets the size of the margin above the scale bar. Default value is 15. This value can be reset to 2 if the scale text is not displayed.

Parameters:

topMargin - The size of the margin above the scale bar.

setNumberOfSegments

public void setNumberOfSegments(int numberOfSegments)

Sets the number of segments to be displayed in the scalebar.

Parameters:

numberOfSegments -

setTextFont

public void setTextFont(java.awt.Font textFont)

Sets the font of the texts used.

Parameters:

textFont -

getImage

public java.awt.image.BufferedImage getImage(java.lang.Double scale,
                                             double width,
                                             double dpi)

Generate the image of the scalebar. If the scale is small (e.g. < 0.01), the scale bar will not be generated. Note that due to different screen resolutions, generating a 100% accurate scale bar for on screen display is next to impossible. The scale should be used as indicative only.

Parameters:

scale - The scale for which to generate the image

width - The initial width of the scalebar in points. There are approx 2.83 points per mm. The real width will change to round the measurement of the segments.

dpi - DPI used on the display device. e.g. for a standard printout, 72 is suitable. For screen display, 96 is better.

Returns:

getImageAsFileLocation

public java.lang.String getImageAsFileLocation(java.lang.Double scale,
                                               double width,
                                               double dpi)
                                        throws java.io.IOException

Generate the image of the scalebar, stores it in a temporary location and returns the file location.

Parameters:

scale - The scale for which to generate the image

width - The width of the scalebar. The real width will change to round the measurement of the segments.

dpi - DPI used

Returns:

The absolute path of the image

Throws:

java.io.IOException

getImageAsFileLocation

public java.lang.String getImageAsFileLocation(java.lang.Double scale,
                                               double width,
                                               double dpi,
                                               java.lang.String fileNameWithoutExtension)
                                        throws java.io.IOException

Throws:

java.io.IOException

getImageAsByte

public byte[] getImageAsByte(java.lang.Double scale,
                             double width,
                             double dpi)
                      throws java.io.IOException

Throws:

java.io.IOException