com.atakmap.android.routes.routearound

Class RouteAroundRegionEventRelay

java.lang.Object

com.atakmap.android.routes.routearound.RouteAroundRegionEventRelay

public class RouteAroundRegionEventRelay
extends java.lang.Object

A singleton event relay for the route around region manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteAroundRegionEventRelay.Event Underlying datatype representing the different event variants for the route around region manager
static interface	RouteAroundRegionEventRelay.RouteAroundRegionEventSubscriber A subscriber that can be registered with the RouteAroundEventRelay to react to events relevant to the route-around region manager

Constructor Summary

Constructors

Constructor and Description
RouteAroundRegionEventRelay()

Method Summary

Modifier and Type	Method and Description
void	addRouteAroundRegionEventListener(RouteAroundRegionEventRelay.RouteAroundRegionEventSubscriber subscriber) Register an event listener with the relay.
static RouteAroundRegionEventRelay	getInstance()
void	onRegionAdded(Shape region) Broadcast an event that a region was added to the manager.
void	onRegionRemoved(Shape region) Broadcast an event that a region was removed from the manager.
void	onRouteAroundGeoFencesSet(boolean value) Broadcast an event that the "route around geofences" option was set or unset.
boolean	removeRouteAroundRegionEventListener(RouteAroundRegionEventRelay.RouteAroundRegionEventSubscriber subscriber) Unregister an event listener with the relay.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteAroundRegionEventRelay

public RouteAroundRegionEventRelay()

Method Detail

getInstance

public static RouteAroundRegionEventRelay getInstance()

addRouteAroundRegionEventListener

public void addRouteAroundRegionEventListener(RouteAroundRegionEventRelay.RouteAroundRegionEventSubscriber subscriber)

Register an event listener with the relay.

Parameters:

subscriber - The event listener to subscribe.

removeRouteAroundRegionEventListener

public boolean removeRouteAroundRegionEventListener(RouteAroundRegionEventRelay.RouteAroundRegionEventSubscriber subscriber)

Unregister an event listener with the relay.

Parameters:

subscriber - The event listener to unsubscribe

Returns:

Whether or not the event listener was successfully unsubscribed.

onRegionAdded

public void onRegionAdded(Shape region)

Broadcast an event that a region was added to the manager.

Parameters:

region - the shape to add.

onRegionRemoved

public void onRegionRemoved(Shape region)

Broadcast an event that a region was removed from the manager.

Parameters:

region - the shape to remove.

onRouteAroundGeoFencesSet

public void onRouteAroundGeoFencesSet(boolean value)

Broadcast an event that the "route around geofences" option was set or unset.