Package mil.nga.mgrs.grid

Class MGRSLabeler

java.lang.Object

mil.nga.grid.Labeler

mil.nga.mgrs.grid.GridLabeler

mil.nga.mgrs.grid.MGRSLabeler

public class MGRSLabeler
extends GridLabeler

MGRS grid labeler

Author:

osbornb

Field Summary

Fields inherited from class mil.nga.mgrs.grid.GridLabeler

DEFAULT_BUFFER, DEFAULT_TEXT_SIZE

Constructor Summary

Constructors

Constructor	Description
MGRSLabeler()	Default Constructor
MGRSLabeler(boolean enabled, int minZoom, Integer maxZoom, Color color)	Constructor
MGRSLabeler(boolean enabled, int minZoom, Integer maxZoom, Color color, double textSize)	Constructor
MGRSLabeler(boolean enabled, int minZoom, Integer maxZoom, Color color, double textSize, double buffer)	Constructor
MGRSLabeler(int minZoom, Integer maxZoom, Color color)	Constructor
MGRSLabeler(int minZoom, Integer maxZoom, Color color, double textSize)	Constructor
MGRSLabeler(int minZoom, Integer maxZoom, Color color, double textSize, double buffer)	Constructor
MGRSLabeler(int minZoom, Color color)	Constructor
MGRSLabeler(int minZoom, Color color, double textSize)	Constructor
MGRSLabeler(int minZoom, Color color, double textSize, double buffer)	Constructor

Method Summary

Modifier and Type	Method	Description
List<GridLabel>	getLabels(Bounds tileBounds, GridType gridType, GridZone zone)	Get labels for the bounds

Methods inherited from class mil.nga.grid.Labeler

getBuffer, getColor, getMaxZoom, getMinZoom, getTextSize, hasMaxZoom, isEnabled, isWithin, setBuffer, setColor, setEnabled, setMaxZoom, setMinZoom, setTextSize

Methods inherited from class java.lang.Object

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

Constructor Detail

MGRSLabeler

public MGRSLabeler()

Default Constructor

MGRSLabeler

public MGRSLabeler(int minZoom,
                   Color color)

Constructor

Parameters:

minZoom - minimum zoom

color - label color

MGRSLabeler

public MGRSLabeler(int minZoom,
                   Color color,
                   double textSize)

Constructor

Parameters:

minZoom - minimum zoom

color - label color

textSize - label text size

MGRSLabeler

public MGRSLabeler(int minZoom,
                   Color color,
                   double textSize,
                   double buffer)

Constructor

Parameters:

minZoom - minimum zoom

color - label color

textSize - label text size

buffer - grid zone edge buffer (greater than or equal to 0.0 and less than 0.5)

MGRSLabeler

public MGRSLabeler(int minZoom,
                   Integer maxZoom,
                   Color color)

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

MGRSLabeler

public MGRSLabeler(int minZoom,
                   Integer maxZoom,
                   Color color,
                   double textSize)

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

textSize - label text size

MGRSLabeler

public MGRSLabeler(int minZoom,
                   Integer maxZoom,
                   Color color,
                   double textSize,
                   double buffer)

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

textSize - label text size

buffer - grid zone edge buffer (greater than or equal to 0.0 and less than 0.5)

MGRSLabeler

public MGRSLabeler(boolean enabled,
                   int minZoom,
                   Integer maxZoom,
                   Color color)

Constructor

Parameters:

enabled - enabled labeler

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

MGRSLabeler

public MGRSLabeler(boolean enabled,
                   int minZoom,
                   Integer maxZoom,
                   Color color,
                   double textSize)

Constructor

Parameters:

enabled - enabled labeler

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

textSize - label text size

MGRSLabeler

public MGRSLabeler(boolean enabled,
                   int minZoom,
                   Integer maxZoom,
                   Color color,
                   double textSize,
                   double buffer)

Constructor

Parameters:

enabled - enabled labeler

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

textSize - label text size

buffer - grid zone edge buffer (greater than or equal to 0.0 and less than 0.5)

Method Detail

getLabels

public List<GridLabel> getLabels(Bounds tileBounds,
                                 GridType gridType,
                                 GridZone zone)

Get labels for the bounds

Specified by:

getLabels in class GridLabeler

Parameters:

tileBounds - tile bounds

gridType - grid type

zone - grid zone

Returns:

labels