Package mil.nga.mgrs.grid

Class GridLabeler

java.lang.Object

mil.nga.grid.Labeler

mil.nga.mgrs.grid.GridLabeler

Direct Known Subclasses:

GZDLabeler, MGRSLabeler

public abstract class GridLabeler
extends Labeler

Grid Labeler

Author:

osbornb

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_BUFFER	Default buffer size
static double	DEFAULT_TEXT_SIZE	Default text size

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract 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

Field Detail

DEFAULT_TEXT_SIZE

public static final double DEFAULT_TEXT_SIZE

Default text size

DEFAULT_BUFFER

public static final double DEFAULT_BUFFER

Default buffer size

Constructor Detail

GridLabeler

public GridLabeler()

Default Constructor

GridLabeler

public GridLabeler(int minZoom,
                   Color color)

Constructor

Parameters:

minZoom - minimum zoom

color - label color

GridLabeler

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

Constructor

Parameters:

minZoom - minimum zoom

color - label color

textSize - label text size

GridLabeler

public GridLabeler(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)

GridLabeler

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

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

GridLabeler

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

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

textSize - label text size

GridLabeler

public GridLabeler(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)

GridLabeler

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

Constructor

Parameters:

enabled - enabled labeler

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

GridLabeler

public GridLabeler(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

GridLabeler

public GridLabeler(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 abstract List<GridLabel> getLabels(Bounds tileBounds,
                                          GridType gridType,
                                          GridZone zone)

Get labels for the bounds

Parameters:

tileBounds - tile bounds

gridType - grid type

zone - grid zone

Returns:

labels