com.atakmap.android.maps

Class AbstractMapComponent

java.lang.Object

com.atakmap.android.maps.AbstractMapComponent

All Implemented Interfaces:

MapComponent

Direct Known Subclasses:

AbstractWidgetMapComponent, AdditionalCFFMapComponent, ApkUpdateComponent, BloodHoundMapComponent, BrightnessComponent, ChannelsMapComponent, ChatManagerMapComponent, CommsMapComponent, CompassArrowMapComponent, CompassRingMapComponent, CotMapComponent, DangerCloseMapComponent, DataMgmtMapComponent, DropDownMapComponent, ElevationMapComponent, ElevationOverlaysMapComponent, EmergencyAlertComponent, FiresMapComponent, FirstPersonMapComponent, FreeLookMapComponent, GeoFenceComponent, GeopackageMapComponent, GLMapComponent, GLWidgetsMapComponent, GRGMapComponent, GridLinesMapComponent, IconsMapComponent, ImportExportMapComponent, LayersMapComponent, LoadoutToolsMapComponent, LocationMapComponent, LRFMapComponent, MapCoreIntentsComponent, MapItemListComponent, MenuMapComponent, MetricReportMapComponent, ModelMapComponent, NativeRenderingMapComponent, NavWidgetsMapComponent, OffScreenIndicatorsMapComponent, PluginMapComponent, QuickPicMapComponent, RangeAndBearingMapComponent, StateSaver, TargetBubbleMapComponent, TilesetMapComponent, TrackHistoryComponent, UserMapComponent, VehicleMapComponent, VisibilityMapComponent, WarningMapComponent, WFSMapComponent, WktMapComponent

public abstract class AbstractMapComponent
extends java.lang.Object
implements MapComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMapComponent.OnAllComponentsCreatedCallback

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMapComponent()
protected	AbstractMapComponent(boolean removeReceiversOnDestroy)

Method Summary

Modifier and Type	Method and Description
protected void	addOverlay(MapView view, MapOverlay o)
void	onConfigurationChanged(android.content.res.Configuration newConfiguration) Implementation of onConfigurationChanged used to handle configuration changes for each mapComponent.
boolean	onCreateOptionsMenu(android.content.Context context, android.view.Menu menu) Is called on all Map Components when the onCreateOptionsMenu is called on the Map Activity.
void	onDestroy(android.content.Context context, MapView view) This method is called during MapComponent destruction and additionally calls the subclass implementation of onDestroyImpl
protected abstract void	onDestroyImpl(android.content.Context context, MapView view) This method is invoked as a subset of the onDestroy call as part of the MapComponent lifecycle.
boolean	onOptionsItemSelected(android.content.Context context, android.view.MenuItem item) Called on a onOptionsItemSelected is called and not found in regular activity.
void	onOptionsMenuClosed(android.content.Context context, android.view.Menu menu) Option menu has been closed in MapActivity.
void	onPause(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onPause state transition.
boolean	onPrepareOptionsMenu(android.content.Context context, android.view.Menu menu) Called to Update the Options Menu on all MapComponents in the MapActivity.
void	onResume(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onResume state transition.
void	onStart(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onStart state transition.
void	onStop(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onStop state transition.
protected void	registerReceiver(android.content.Context ignored, android.content.BroadcastReceiver receiver, AtakBroadcast.DocumentedIntentFilter filter)
protected void	removeOverlay(MapView view, MapOverlay o)
protected void	setOnAllComponentsCreatedCallback(android.content.Context context, AbstractMapComponent.OnAllComponentsCreatedCallback callback)
protected void	unregisterReceiver(android.content.Context ignored, android.content.BroadcastReceiver receiver)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atakmap.android.maps.MapComponent

onCreate

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

AbstractMapComponent

protected AbstractMapComponent()

AbstractMapComponent

protected AbstractMapComponent(boolean removeReceiversOnDestroy)

Method Detail

setOnAllComponentsCreatedCallback

protected final void setOnAllComponentsCreatedCallback(android.content.Context context,
                                                       AbstractMapComponent.OnAllComponentsCreatedCallback callback)

registerReceiver

protected final void registerReceiver(android.content.Context ignored,
                                      android.content.BroadcastReceiver receiver,
                                      AtakBroadcast.DocumentedIntentFilter filter)

unregisterReceiver

protected final void unregisterReceiver(android.content.Context ignored,
                                        android.content.BroadcastReceiver receiver)

addOverlay

protected final void addOverlay(MapView view,
                                MapOverlay o)

removeOverlay

protected final void removeOverlay(MapView view,
                                   MapOverlay o)

onDestroyImpl

protected abstract void onDestroyImpl(android.content.Context context,
                                      MapView view)

This method is invoked as a subset of the onDestroy call as part of the MapComponent lifecycle.

onDestroy

public final void onDestroy(android.content.Context context,
                            MapView view)

This method is called during MapComponent destruction and additionally calls the subclass implementation of onDestroyImpl

Specified by:

onDestroy in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView

onCreateOptionsMenu

public boolean onCreateOptionsMenu(android.content.Context context,
                                   android.view.Menu menu)

Description copied from interface: MapComponent

Is called on all Map Components when the onCreateOptionsMenu is called on the Map Activity.

Specified by:

onCreateOptionsMenu in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

menu - The options menu in which you place your items.

Returns:

true if there is something to show

See Also:

Activity.onCreateOptionsMenu(Menu)

onPrepareOptionsMenu

public boolean onPrepareOptionsMenu(android.content.Context context,
                                    android.view.Menu menu)

Description copied from interface: MapComponent

Called to Update the Options Menu on all MapComponents in the MapActivity.

Specified by:

onPrepareOptionsMenu in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

menu - The options menu in which you place your items.

Returns:

true if there is something to show

onOptionsItemSelected

public boolean onOptionsItemSelected(android.content.Context context,
                                     android.view.MenuItem item)

Description copied from interface: MapComponent

Called on a onOptionsItemSelected is called and not found in regular activity.

Specified by:

onOptionsItemSelected in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

item - The menu item that was selected.

Returns:

true if mapcomponent consumes/uses the activity

See Also:

Activity.onOptionsItemSelected(MenuItem)

onOptionsMenuClosed

public void onOptionsMenuClosed(android.content.Context context,
                                android.view.Menu menu)

Description copied from interface: MapComponent

Option menu has been closed in MapActivity.

Specified by:

onOptionsMenuClosed in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

menu - The options menu in which you place your items.

See Also:

Activity.onOptionsMenuClosed(Menu)

onConfigurationChanged

public void onConfigurationChanged(android.content.res.Configuration newConfiguration)

Description copied from interface: MapComponent

Implementation of onConfigurationChanged used to handle configuration changes for each mapComponent.

Specified by:

onConfigurationChanged in interface MapComponent

Parameters:

newConfiguration - called when the configuration changed

See Also:

Activity.onConfigurationChanged(Configuration)

onStart

public void onStart(android.content.Context context,
                    MapView view)

Default implementation for an abstract map component which does not respond to the onStart state transition.

Specified by:

onStart in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView

onStop

public void onStop(android.content.Context context,
                   MapView view)

Default implementation for an abstract map component which does not respond to the onStop state transition.

Specified by:

onStop in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView

onPause

public void onPause(android.content.Context context,
                    MapView view)

Default implementation for an abstract map component which does not respond to the onPause state transition.

Specified by:

onPause in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView

onResume

public void onResume(android.content.Context context,
                     MapView view)

Default implementation for an abstract map component which does not respond to the onResume state transition.

Specified by:

onResume in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView