Package mil.nga.mgrs.grid

Class Labeler

java.lang.Object

mil.nga.mgrs.grid.Labeler

Direct Known Subclasses:

GridLabeler, GZDLabeler

public abstract class Labeler
extends Object

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
Labeler()	Default Constructor
Labeler(boolean enabled, int minZoom, Integer maxZoom, Color color)	Constructor
Labeler(boolean enabled, int minZoom, Integer maxZoom, Color color, double textSize)	Constructor
Labeler(boolean enabled, int minZoom, Integer maxZoom, Color color, double textSize, double buffer)	Constructor
Labeler(int minZoom, Integer maxZoom, Color color)	Constructor
Labeler(int minZoom, Integer maxZoom, Color color, double textSize)	Constructor
Labeler(int minZoom, Integer maxZoom, Color color, double textSize, double buffer)	Constructor
Labeler(int minZoom, Color color)	Constructor
Labeler(int minZoom, Color color, double textSize)	Constructor
Labeler(int minZoom, Color color, double textSize, double buffer)	Constructor

Method Summary

Modifier and Type	Method	Description
double	getBuffer()	Get the grid zone edge buffer
Color	getColor()	Get the label color
abstract List<Label>	getLabels(Bounds tileBounds, GridType gridType, GridZone zone)	Get labels for the bounds
Integer	getMaxZoom()	Get the maximum zoom level
int	getMinZoom()	Get the minimum zoom level
double	getTextSize()	Get the label text size
boolean	hasMaxZoom()	Has a maximum zoom level
boolean	isEnabled()	Is the grid enabled
boolean	isWithin(int zoom)	Is the zoom level within the grid zoom range
void	setBuffer(double buffer)	Set the grid zone edge buffer
void	setColor(Color color)	Set the label color
void	setEnabled(boolean enabled)	Set the enabled flag
void	setMaxZoom(Integer maxZoom)	Set the maximum zoom level
void	setMinZoom(int minZoom)	Set the minimum zoom level
void	setTextSize(double textSize)	Set the label text size

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

Labeler

public Labeler()

Default Constructor

Labeler

public Labeler(int minZoom,
               Color color)

Constructor

Parameters:

minZoom - minimum zoom

color - label color

Labeler

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

Constructor

Parameters:

minZoom - minimum zoom

color - label color

textSize - label text size

Labeler

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

Labeler

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

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

Labeler

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

Constructor

Parameters:

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

textSize - label text size

Labeler

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

Labeler

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

Constructor

Parameters:

enabled - enabled labeler

minZoom - minimum zoom

maxZoom - maximum zoom

color - label color

Labeler

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

Labeler

public Labeler(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<Label> getLabels(Bounds tileBounds,
                                      GridType gridType,
                                      GridZone zone)

Get labels for the bounds

Parameters:

tileBounds - tile bounds

gridType - grid type

zone - grid zone

Returns:

labels

isEnabled

public boolean isEnabled()

Is the grid enabled

Returns:

enabled flag

setEnabled

public void setEnabled(boolean enabled)

Set the enabled flag

Parameters:

enabled - enabled flag

getMinZoom

public int getMinZoom()

Get the minimum zoom level

Returns:

minimum zoom level

setMinZoom

public void setMinZoom(int minZoom)

Set the minimum zoom level

Parameters:

minZoom - minimum zoom level

getMaxZoom

public Integer getMaxZoom()

Get the maximum zoom level

Returns:

maximum zoom level

hasMaxZoom

public boolean hasMaxZoom()

Has a maximum zoom level

Returns:

true if has a maximum, false if unbounded

setMaxZoom

public void setMaxZoom(Integer maxZoom)

Set the maximum zoom level

Parameters:

maxZoom - maximum zoom level

isWithin

public boolean isWithin(int zoom)

Is the zoom level within the grid zoom range

Parameters:

zoom - zoom level

Returns:

true if within range

getColor

public Color getColor()

Get the label color

Returns:

label color

setColor

public void setColor(Color color)

Set the label color

Parameters:

color - label color

getTextSize

public double getTextSize()

Get the label text size

Returns:

label text size

setTextSize

public void setTextSize(double textSize)

Set the label text size

Parameters:

textSize - label text size

getBuffer

public double getBuffer()

Get the grid zone edge buffer

Returns:

buffer (greater than or equal to 0.0 and less than 0.5)

setBuffer

public void setBuffer(double buffer)

Set the grid zone edge buffer

Parameters:

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