com.atakmap.android.routes

Class RouteGenerationHandler

java.lang.Object

com.atakmap.android.routes.RouteGenerationHandler

All Implemented Interfaces:

RouteGenerationTask.RouteGenerationEventListener

public class RouteGenerationHandler
extends java.lang.Object
implements RouteGenerationTask.RouteGenerationEventListener

Handler for Route Generation events emitted by implementations of RouteGenerationTask. This handler expects to be run on a UI thread.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROUTE_GENERATED

Constructor Summary

Constructors

Constructor and Description
RouteGenerationHandler(MapView mapView, PointMapItem origin, PointMapItem dest, Route route)

Method Summary

Modifier and Type	Method and Description
android.app.ProgressDialog	getDialog()
void	onAfterRouteGenerated(RoutePointPackage routePointPackage) Fires after the route has been returned (after onRouteGenerated) and has not been cancelled.
void	onBeforeRouteGenerated(RouteGenerationTask task, boolean displayDialog) Fires before the task is executed (NOTE: Will run on the UI thread)
void	onCancelled() Fires after the task has been cancelled.
void	onException(java.lang.Exception ex) Fires when an exception has been thrown.
void	onProgressUpdated(double progress) Fires when there is progress to report (NOTE: Will run on the UI thread).
void	onRouteGenerated(RoutePointPackage routePointPackage) Fires immediately after the route is generated (NOTE: Will run on the BACKGROUND thread).

Methods inherited from class java.lang.Object

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

Field Detail

ROUTE_GENERATED

public static final java.lang.String ROUTE_GENERATED

See Also:

Constant Field Values

Constructor Detail

RouteGenerationHandler

public RouteGenerationHandler(MapView mapView,
                              PointMapItem origin,
                              PointMapItem dest,
                              Route route)

Method Detail

onBeforeRouteGenerated

public void onBeforeRouteGenerated(RouteGenerationTask task,
                                   boolean displayDialog)

Description copied from interface: RouteGenerationTask.RouteGenerationEventListener

Fires before the task is executed (NOTE: Will run on the UI thread)

Specified by:

onBeforeRouteGenerated in interface RouteGenerationTask.RouteGenerationEventListener

Parameters:

task - The associated task.

displayDialog - Specify whether or not to alert the user that a new route is being generated.

onProgressUpdated

public void onProgressUpdated(double progress)

Description copied from interface: RouteGenerationTask.RouteGenerationEventListener

Fires when there is progress to report (NOTE: Will run on the UI thread).

Specified by:

onProgressUpdated in interface RouteGenerationTask.RouteGenerationEventListener

Parameters:

progress - A value from 0 to 1 representing the progress.

getDialog

public android.app.ProgressDialog getDialog()

onException

public void onException(java.lang.Exception ex)

Description copied from interface: RouteGenerationTask.RouteGenerationEventListener

Fires when an exception has been thrown. (NOTE: Will run on the UI thread).

Specified by:

onException in interface RouteGenerationTask.RouteGenerationEventListener

Parameters:

ex - The exception that was thrown.

onRouteGenerated

public void onRouteGenerated(RoutePointPackage routePointPackage)

Description copied from interface: RouteGenerationTask.RouteGenerationEventListener

Fires immediately after the route is generated (NOTE: Will run on the BACKGROUND thread).

Specified by:

onRouteGenerated in interface RouteGenerationTask.RouteGenerationEventListener

Parameters:

routePointPackage - The routePointPackage that was generated.

onAfterRouteGenerated

public void onAfterRouteGenerated(RoutePointPackage routePointPackage)

Description copied from interface: RouteGenerationTask.RouteGenerationEventListener

Fires after the route has been returned (after onRouteGenerated) and has not been cancelled. (NOTE: Will run on the UI thread)

Specified by:

onAfterRouteGenerated in interface RouteGenerationTask.RouteGenerationEventListener

onCancelled

public void onCancelled()

Description copied from interface: RouteGenerationTask.RouteGenerationEventListener

Fires after the task has been cancelled. Note: in most cases, the onRouteGenerated event will still fire. (NOTE: Will run on the UI thread)

Specified by:

onCancelled in interface RouteGenerationTask.RouteGenerationEventListener