Package com.luciad.layers.grids.mgrs

Class MgrsGridTextProvider

java.lang.Object

com.luciad.layers.grids.mgrs.MgrsGridTextProvider

All Implemented Interfaces:

AutoCloseable

public final class MgrsGridTextProvider
extends Object
implements AutoCloseable

An MGRS text provider that notifies callbacks whenever the currently visible zone/square of a given Map changes.

Typically used to update a UI element in combination with an MGRS grid on the map, although this is not mandatory.

The text is formatted with a maximum precision of 100km squares.

MgrsGridTextProvider must be instantiated on the UI thread, and its registered ICallbacks are only called on the UI thread.

See the Working with MGRS article for more information.

Since:

2023.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MgrsGridTextProvider.ICallback	This callback can be used to be notified whenever the currently visible zone/square changes, by giving you its formatted location text.

Constructor Summary

Constructors

Constructor	Description
MgrsGridTextProvider(Map map)	Constructs a new MgrsGridTextProvider for the given Map.

Method Summary

Modifier and Type	Method	Description
void	addCallback(MgrsGridTextProvider.ICallback callback)	Adds the given callback to the MgrsGridTextProvider.
void	close()
protected void	finalize()
void	removeCallback(MgrsGridTextProvider.ICallback callback)	Removes the given callback from the MgrsGridTextProvider.

Methods inherited from class java.lang.Object

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

Constructor Details

MgrsGridTextProvider

public MgrsGridTextProvider(@NotNull
 Map map)
                     throws NullPointerException

Constructs a new MgrsGridTextProvider for the given Map.

MgrsGridTextProvider must be instantiated on the UI thread.

Parameters:

map - the Map. Cannot be null.

Throws:

NullPointerException - when the Map is null.

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

addCallback

public void addCallback(@NotNull
 MgrsGridTextProvider.ICallback callback)
                 throws NullPointerException

Adds the given callback to the MgrsGridTextProvider.

After calling this method, the MgrsGridTextProvider starts calling the given callback instance.

Parameters:

callback - a callback instance. Cannot be null.

Throws:

NullPointerException - when the callback is null.

removeCallback

public void removeCallback(@NotNull
 MgrsGridTextProvider.ICallback callback)
                    throws NullPointerException

Removes the given callback from the MgrsGridTextProvider.

After calling this method, the MgrsGridTextProvider stops calling the given callback instance.

Parameters:

callback - a callback instance. Cannot be null.

Throws:

NullPointerException - when the callback is null.