summaryrefslogtreecommitdiff
path: root/platform/android
diff options
context:
space:
mode:
authorTobrun <tobrun@mapbox.com>2016-02-24 15:10:41 +0100
committerTobrun <tobrun@mapbox.com>2016-02-25 10:26:47 +0100
commit467d103b9aa57506ce06624bde803f03f200f4f3 (patch)
tree40f4fe8b45e16045a0753a42248a40ba04b3e0db /platform/android
parent5cdd30b159f34708721412358127c46c652139cb (diff)
downloadqtlocation-mapboxgl-467d103b9aa57506ce06624bde803f03f200f4f3.tar.gz
[android] #4097 - update javadoc maps package
[android] #4097 - update visibility compassclickclistener fix
Diffstat (limited to 'platform/android')
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java3
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/layers/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapFragment.java3
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java571
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java33
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/OnMapReadyCallback.java7
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/SupportMapFragment.java3
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java3
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java5
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/ViewSettings.java5
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/CompassView.java9
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/UserLocationView.java4
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/package-info.java2
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java3
-rw-r--r--platform/android/MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/testapp/MainActivityTest.java4
21 files changed, 100 insertions, 569 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java
index 575d10c564..64ab895079 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains classes to add and manage annotations and markers in your map.
+ * This package contains classes to add and manage annotations on your map.
*/
package com.mapbox.mapboxsdk.annotations;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/package-info.java
index 0c6b5bebe5..c480bdacf5 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains the Camera API which is used to control the user's viewpoint of the map.
+ * This package contains the Camera API classes which are used to control the user's viewpoint of the map.
*/
package com.mapbox.mapboxsdk.camera;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java
index b99119db0a..75c712074f 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package provides access to several map related constants and bundled styles.
+ * This package contains multiple map related constants classes.
*/
package com.mapbox.mapboxsdk.constants;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java
index d593884ee3..3b4c3394c9 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains exceptions thrown in this SDK.
+ * This package contains map specific exception classes.
*/
package com.mapbox.mapboxsdk.exceptions;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java
index bf7dae12a8..51d4330735 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java
@@ -1,5 +1,4 @@
/**
- * This package contains classes that deal with geometry and map coordinates. Many SDK functions
- * accept or return these classes.
+ * This package contains classes related to geometry and map coordinates.
*/
package com.mapbox.mapboxsdk.geometry;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/layers/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/layers/package-info.java
index fda1a493e2..b444050cb6 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/layers/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/layers/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains classes to add and manage layers in your map.
+ * This package contains classes to add and manage layers of the map.
*/
package com.mapbox.mapboxsdk.layers;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/package-info.java
index f9e64ca973..543cb68324 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains the Location Services API for accessing the location of the device.
+ * This package contains classes that manages the map Location services.
*/
package com.mapbox.mapboxsdk.location;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapFragment.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapFragment.java
index 4b5aa0cbaf..3d103f6f8c 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapFragment.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapFragment.java
@@ -9,11 +9,10 @@ import android.view.View;
import android.view.ViewGroup;
import com.mapbox.mapboxsdk.R;
-import com.mapbox.mapboxsdk.constants.MapboxConstants;
import com.mapbox.mapboxsdk.utils.ApiAccess;
/**
- * Fragment wrapper around a {@link MapView}.
+ * Fragment wrapper around a map view.
* <p>
* A Map component in an app. This fragment is the simplest way to place a map in an application.
* It's a wrapper around a view of a map to automatically handle the necessary life cycle needs.
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java
index 4130c678da..af8cfed032 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java
@@ -55,6 +55,7 @@ import android.widget.FrameLayout;
import android.widget.ImageView;
import android.widget.ListView;
import android.widget.ZoomButtonsController;
+
import com.almeros.android.multitouch.gesturedetectors.RotateGestureDetector;
import com.almeros.android.multitouch.gesturedetectors.ShoveGestureDetector;
import com.almeros.android.multitouch.gesturedetectors.TwoFingerGestureDetector;
@@ -64,7 +65,6 @@ import com.mapbox.mapboxsdk.annotations.Icon;
import com.mapbox.mapboxsdk.annotations.IconFactory;
import com.mapbox.mapboxsdk.annotations.InfoWindow;
import com.mapbox.mapboxsdk.annotations.Marker;
-import com.mapbox.mapboxsdk.annotations.MarkerOptions;
import com.mapbox.mapboxsdk.annotations.Polygon;
import com.mapbox.mapboxsdk.annotations.Polyline;
import com.mapbox.mapboxsdk.camera.CameraPosition;
@@ -72,7 +72,6 @@ import com.mapbox.mapboxsdk.camera.CameraUpdateFactory;
import com.mapbox.mapboxsdk.constants.MapboxConstants;
import com.mapbox.mapboxsdk.constants.MyBearingTracking;
import com.mapbox.mapboxsdk.constants.MyLocationTracking;
-import com.mapbox.mapboxsdk.constants.Style;
import com.mapbox.mapboxsdk.exceptions.IconBitmapChangedException;
import com.mapbox.mapboxsdk.exceptions.InvalidAccessTokenException;
import com.mapbox.mapboxsdk.exceptions.TelemetryServiceNotConfiguredException;
@@ -84,6 +83,7 @@ import com.mapbox.mapboxsdk.maps.widgets.UserLocationView;
import com.mapbox.mapboxsdk.telemetry.MapboxEvent;
import com.mapbox.mapboxsdk.telemetry.MapboxEventManager;
import com.mapbox.mapboxsdk.utils.ApiAccess;
+
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.nio.ByteBuffer;
@@ -116,7 +116,7 @@ public class MapView extends FrameLayout {
private static final float DIMENSION_SEVEN_DP = 7f;
private static final float DIMENSION_TEN_DP = 10f;
private static final float DIMENSION_SIXTEEN_DP = 16f;
- private static final float DIMENSION_SEVENTYSIX_DP = 76f;
+ private static final float DIMENSION_SEVENTY_SIX_DP = 76f;
private MapboxMap mMapboxMap;
private List<Icon> mIcons;
@@ -215,8 +215,10 @@ public class MapView extends FrameLayout {
mUserLocationView = (UserLocationView) view.findViewById(R.id.userLocationView);
mUserLocationView.setMapboxMap(mMapboxMap);
+
mCompassView = (CompassView) view.findViewById(R.id.compassView);
- mCompassView.setOnClickListener(new CompassView.CompassClickListener(mMapboxMap));
+ mCompassView.setMapboxMap(mMapboxMap);
+
mLogoView = (ImageView) view.findViewById(R.id.logoView);
// Setup Attributions control
@@ -278,7 +280,7 @@ public class MapView extends FrameLayout {
// Attribution
uiSettings.setAttributionEnabled(typedArray.getBoolean(R.styleable.MapView_attribution_visibility, true));
uiSettings.setAttributionGravity(typedArray.getInt(R.styleable.MapView_attribution_gravity, Gravity.BOTTOM));
- uiSettings.setAttributionMargins((int) (typedArray.getDimension(R.styleable.MapView_attribution_margin_left, DIMENSION_SEVENTYSIX_DP) * mScreenDensity)
+ uiSettings.setAttributionMargins((int) (typedArray.getDimension(R.styleable.MapView_attribution_margin_left, DIMENSION_SEVENTY_SIX_DP) * mScreenDensity)
, (int) (typedArray.getDimension(R.styleable.MapView_attribution_margin_top, DIMENSION_SEVEN_DP) * mScreenDensity)
, (int) (typedArray.getDimension(R.styleable.MapView_attribution_margin_right, DIMENSION_SEVEN_DP) * mScreenDensity)
, (int) (typedArray.getDimension(R.styleable.MapView_attribution_margin_bottom, DIMENSION_SEVEN_DP) * mScreenDensity));
@@ -540,11 +542,6 @@ public class MapView extends FrameLayout {
// LatLng / CenterCoordinate
//
- /**
- * Gets the current LatLng in the center of the MapView
- *
- * @return The center in LatLng
- */
LatLng getLatLng() {
return mNativeMapView.getLatLng();
}
@@ -553,22 +550,10 @@ public class MapView extends FrameLayout {
// Pitch / Tilt
//
- /**
- * Gets the current Tilt in degrees of the MapView
- *
- * @return tilt in degrees
- */
double getTilt() {
return mNativeMapView.getPitch();
}
- /**
- * Sets the Tilt in degrees of the MapView.
- *
- * @param pitch New tilt in degrees
- * @param duration Animation time in milliseconds. If null then 0 is used, making the animation immediate.
- */
- @FloatRange(from = MapboxConstants.MINIMUM_TILT, to = MapboxConstants.MAXIMUM_TILT)
void setTilt(Double pitch, @Nullable Long duration) {
long actualDuration = 0;
if (duration != null) {
@@ -581,13 +566,6 @@ public class MapView extends FrameLayout {
// Direction
//
- /**
- * Returns the current direction of the map relative to true north.
- *
- * @return The current direction measured in degrees.
- */
- @UiThread
- @FloatRange(from = MapboxConstants.MINIMUM_DIRECTION, to = MapboxConstants.MAXIMUM_DIRECTION)
double getDirection() {
double direction = -mNativeMapView.getBearing();
@@ -601,45 +579,10 @@ public class MapView extends FrameLayout {
return direction;
}
- /**
- * <p>
- * Rotates the map to a new heading relative to true north immediately.
- * </p>
- * <ul>
- * <li>The value 0 means that the top edge of the map view will correspond to true north.</li>
- * <li>The value 90 means the top of the map will point due east.</li>
- * <li>The value 180 means the top of the map will point due south.</li>
- * <li>The value 270 means the top of the map will point due west.</li>
- * </ul>
- * <p>
- * The initial heading is 0.
- * </p>
- * If you want to animate the change, use {@link MapView#setDirection(double, boolean)}.
- *
- * @param direction The new heading measured in degrees.
- * @see MapView#setDirection(double, boolean)
- */
- @UiThread
void setDirection(@FloatRange(from = MapboxConstants.MINIMUM_DIRECTION, to = MapboxConstants.MAXIMUM_DIRECTION) double direction) {
setDirection(direction, false);
}
- /**
- * <p>
- * Rotates the map to a new heading relative to true north and optionally animates the change.
- * </p>
- * <ul>
- * <li>The value 0 means that the top edge of the map view will correspond to true north.</li>
- * <li>The value 90 means the top of the map will point due east.</li>
- * <li>The value 180 means the top of the map will point due south.</li>
- * <li>The value 270 means the top of the map will point due west.</li>
- * </ul>
- * The initial heading is 0.
- *
- * @param direction The new heading measured in degrees from true north.
- * @param animated If true, animates the change. If false, immediately changes the map.
- */
- @UiThread
void setDirection(@FloatRange(from = MapboxConstants.MINIMUM_DIRECTION, to = MapboxConstants.MAXIMUM_DIRECTION) double direction, boolean animated) {
long duration = animated ? MapboxConstants.ANIMATION_DURATION : 0;
mNativeMapView.cancelTransitions();
@@ -647,10 +590,6 @@ public class MapView extends FrameLayout {
mNativeMapView.setBearing(-direction, duration);
}
- /**
- * Resets the map heading to true north and animates the change.
- */
- @UiThread
void resetNorth() {
mNativeMapView.cancelTransitions();
mNativeMapView.resetNorth();
@@ -660,38 +599,18 @@ public class MapView extends FrameLayout {
// Content padding
//
- /**
- * Return The current content padding left of the map view viewport.
- *
- * @return The current content padding left
- */
int getContentPaddingLeft() {
return mContentPaddingLeft;
}
- /**
- * Return The current content padding left of the map view viewport.
- *
- * @return The current content padding left
- */
int getContentPaddingTop() {
return mContentPaddingTop;
}
- /**
- * Return The current content padding left of the map view viewport.
- *
- * @return The current content padding right
- */
int getContentPaddingRight() {
return mContentPaddingRight;
}
- /**
- * Return The current content padding left of the map view viewport.
- *
- * @return The current content padding bottom
- */
int getContentPaddingBottom() {
return mContentPaddingBottom;
}
@@ -700,77 +619,26 @@ public class MapView extends FrameLayout {
// Zoom
//
- /**
- * Returns the current zoom level of the map view.
- *
- * @return The current zoom.
- */
- @UiThread
- @FloatRange(from = MapboxConstants.MINIMUM_ZOOM, to = MapboxConstants.MAXIMUM_ZOOM)
double getZoom() {
return mNativeMapView.getZoom();
}
- /**
- * <p>
- * Sets the minimum zoom level the map can be displayed at.
- * </p>
- *
- * @param minZoom The new minimum zoom level.
- */
- @UiThread
void setMinZoom(@FloatRange(from = MapboxConstants.MINIMUM_ZOOM, to = MapboxConstants.MAXIMUM_ZOOM) double minZoom) {
mNativeMapView.setMinZoom(minZoom);
}
- /**
- * <p>
- * Gets the maximum zoom level the map can be displayed at.
- * </p>
- *
- * @return The minimum zoom level.
- */
- @UiThread
double getMinZoom() {
return mNativeMapView.getMinZoom();
}
- /**
- * <p>
- * Sets the maximum zoom level the map can be displayed at.
- * </p>
- *
- * @param maxZoom The new maximum zoom level.
- */
- @UiThread
void setMaxZoom(@FloatRange(from = MapboxConstants.MINIMUM_ZOOM, to = MapboxConstants.MAXIMUM_ZOOM) double maxZoom) {
mNativeMapView.setMaxZoom(maxZoom);
}
- /**
- * <p>
- * Gets the maximum zoom level the map can be displayed at.
- * </p>
- *
- * @return The maximum zoom level.
- */
- @UiThread
double getMaxZoom() {
return mNativeMapView.getMaxZoom();
}
- /**
- * <p>
- * Sets whether the zoom controls are enabled.
- * If enabled, the zoom controls are a pair of buttons
- * (one for zooming in, one for zooming out) that appear on the screen.
- * When pressed, they cause the camera to zoom in (or out) by one zoom level.
- * If disabled, the zoom controls are not shown.
- * </p>
- * By default the zoom controls are enabled if the device is only single touch capable;
- *
- * @param enabled If true, the zoom controls are enabled.
- */
void setZoomControlsEnabled(boolean enabled) {
mZoomButtonsController.setVisible(enabled);
}
@@ -795,81 +663,22 @@ public class MapView extends FrameLayout {
// Debug
//
- /**
- * Returns whether the map debug information is currently shown.
- *
- * @return If true, map debug information is currently shown.
- */
- @UiThread
boolean isDebugActive() {
return mNativeMapView.getDebug();
}
- /**
- * <p>
- * Changes whether the map debug information is shown.
- * </p>
- * The default value is false.
- *
- * @param debugActive If true, map debug information is shown.
- */
- @UiThread
void setDebugActive(boolean debugActive) {
mNativeMapView.setDebug(debugActive);
}
- /**
- * <p>
- * Cycles through the map debug options.
- * </p>
- * The value of {@link MapView#isDebugActive()} reflects whether there are
- * any map debug options enabled or disabled.
- *
- * @see MapView#isDebugActive()
- */
- @UiThread
void cycleDebugOptions() {
mNativeMapView.cycleDebugOptions();
}
- // True if map has finished loading the view
- private boolean isFullyLoaded() {
- return mNativeMapView.isFullyLoaded();
- }
-
//
// Styling
//
- /**
- * <p>
- * Loads a new map style from the specified URL.
- * </p>
- * {@code url} can take the following forms:
- * <ul>
- * <li>{@code Style.*}: load one of the bundled styles in {@link Style}.</li>
- * <li>{@code mapbox://styles/<user>/<style>}:
- * retrieves the style from a <a href="https://www.mapbox.com/account/">Mapbox account.</a>
- * {@code user} is your username. {@code style} is the ID of your custom
- * style created in <a href="https://www.mapbox.com/studio">Mapbox Studio</a>.</li>
- * <li>{@code http://...} or {@code https://...}:
- * retrieves the style over the Internet from any web server.</li>
- * <li>{@code asset://...}:
- * reads the style from the APK {@code assets/} directory.
- * This is used to load a style bundled with your app.</li>
- * <li>{@code null}: loads the default {@link Style#MAPBOX_STREETS} style.</li>
- * </ul>
- * <p>
- * This method is asynchronous and will return immediately before the style finishes loading.
- * If you wish to wait for the map to finish loading listen for the {@link MapView#DID_FINISH_LOADING_MAP} event.
- * </p>
- * If the style fails to load or an invalid style URL is set, the map view will become blank.
- * An error message will be logged in the Android logcat and {@link MapView#DID_FAIL_LOADING_MAP} event will be sent.
- *
- * @param url The URL of the map style
- * @see Style
- */
- @UiThread
void setStyleUrl(@NonNull String url) {
mNativeMapView.setStyleUrl(url);
}
@@ -878,35 +687,6 @@ public class MapView extends FrameLayout {
// Access token
//
- // Checks if the given token is valid
- private void validateAccessToken(String accessToken) {
- if (TextUtils.isEmpty(accessToken) || (!accessToken.startsWith("pk.") && !accessToken.startsWith("sk."))) {
- throw new InvalidAccessTokenException();
- }
- }
-
- // Checks that TelemetryService has been configured by developer
- private void validateTelemetryServiceConfigured() {
-
- try {
- // Check Implementing app's AndroidManifest.xml
- PackageInfo packageInfo = getContext().getPackageManager().getPackageInfo(getContext().getPackageName(), PackageManager.GET_SERVICES);
-
- if (packageInfo.services != null) {
-
- for (ServiceInfo service : packageInfo.services) {
- if (TextUtils.equals("com.mapbox.mapboxsdk.telemetry.TelemetryService", service.name)) {
- return;
- }
- }
- }
-
- } catch (Exception e) {
- Log.w(TAG, "Error checking for Telemetry Service Config: " + e);
- }
- throw new TelemetryServiceNotConfiguredException();
- }
-
/**
* <p>
* Sets the current Mapbox access token used to load map styles and tiles.
@@ -943,18 +723,35 @@ public class MapView extends FrameLayout {
return mNativeMapView.getAccessToken();
}
+ // Checks if the given token is valid
+ private void validateAccessToken(String accessToken) {
+ if (TextUtils.isEmpty(accessToken) || (!accessToken.startsWith("pk.") && !accessToken.startsWith("sk."))) {
+ throw new InvalidAccessTokenException();
+ }
+ }
+
+ // Checks that TelemetryService has been configured by developer
+ private void validateTelemetryServiceConfigured() {
+ try {
+ // Check Implementing app's AndroidManifest.xml
+ PackageInfo packageInfo = getContext().getPackageManager().getPackageInfo(getContext().getPackageName(), PackageManager.GET_SERVICES);
+ if (packageInfo.services != null) {
+ for (ServiceInfo service : packageInfo.services) {
+ if (TextUtils.equals("com.mapbox.mapboxsdk.telemetry.TelemetryService", service.name)) {
+ return;
+ }
+ }
+ }
+ } catch (Exception e) {
+ Log.w(TAG, "Error checking for Telemetry Service Config: " + e);
+ }
+ throw new TelemetryServiceNotConfiguredException();
+ }
+
//
// Projection
//
- /**
- * Converts a point in this view's coordinate system to a map coordinate.
- *
- * @param point A point in this view's coordinate system.
- * @return The converted map coordinate.
- */
- @UiThread
- @NonNull
LatLng fromScreenLocation(@NonNull PointF point) {
float x = point.x;
float y = point.y;
@@ -962,14 +759,6 @@ public class MapView extends FrameLayout {
return mNativeMapView.latLngForPixel(new PointF(x / mScreenDensity, y / mScreenDensity));
}
- /**
- * Converts a map coordinate to a point in this view's coordinate system.
- *
- * @param location A map coordinate.
- * @return The converted point in this view's coordinate system.
- */
- @UiThread
- @NonNull
PointF toScreenLocation(@NonNull LatLng location) {
PointF point = mNativeMapView.pixelForLatLng(location);
@@ -1031,14 +820,6 @@ public class MapView extends FrameLayout {
}
}
- /**
- * <p>
- * Updates a marker on this map. Does nothing if the marker is already added.
- * </p>
- *
- * @param updatedMarker An updated marker object.
- */
- @UiThread
void updateMarker(@NonNull Marker updatedMarker) {
if (updatedMarker == null) {
Log.w(TAG, "marker was null, doing nothing");
@@ -1053,12 +834,6 @@ public class MapView extends FrameLayout {
mNativeMapView.updateMarker(updatedMarker);
}
- private Marker prepareMarker(MarkerOptions markerOptions) {
- Marker marker = markerOptions.getMarker();
- ensureIconLoaded(marker);
- return marker;
- }
-
private void ensureIconLoaded(Marker marker) {
Icon icon = marker.getIcon();
if (icon == null) {
@@ -1082,7 +857,6 @@ public class MapView extends FrameLayout {
}
}
-
long addMarker(@NonNull Marker marker) {
if (mNativeMapView == null) {
return 0l;
@@ -1156,22 +930,6 @@ public class MapView extends FrameLayout {
* mScreenDensity);
}
- /**
- * Sets the distance from the edges of the map view’s frame to the edges of the map
- * view’s logical viewport.
- * <p/>
- * When the value of this property is equal to {0,0,0,0}, viewport
- * properties such as `centerCoordinate` assume a viewport that matches the map
- * view’s frame. Otherwise, those properties are inset, excluding part of the
- * frame from the viewport. For instance, if the only the top edge is inset, the
- * map center is effectively shifted downward.
- *
- * @param left The left margin in pixels.
- * @param top The top margin in pixels.
- * @param right The right margin in pixels.
- * @param bottom The bottom margin in pixels.
- */
- @UiThread
void setContentPadding(int left, int top, int right, int bottom) {
if (left == mContentPaddingLeft && top == mContentPaddingTop && right == mContentPaddingRight && bottom == mContentPaddingBottom) {
return;
@@ -1185,17 +943,6 @@ public class MapView extends FrameLayout {
mNativeMapView.setContentPadding(top / mScreenDensity, left / mScreenDensity, bottom / mScreenDensity, right / mScreenDensity);
}
- /**
- * <p>
- * Returns the distance spanned by one pixel at the specified latitude and current zoom level.
- * </p>
- * The distance between pixels decreases as the latitude approaches the poles.
- * This relationship parallels the relationship between longitudinal coordinates at different latitudes.
- *
- * @param latitude The latitude for which to return the value.
- * @return The distance measured in meters.
- */
- @UiThread
double getMetersPerPixelAtLatitude(@FloatRange(from = -180, to = 180) double latitude) {
return mNativeMapView.getMetersPerPixelAtLatitude(latitude, getZoom()) / mScreenDensity;
}
@@ -1204,17 +951,6 @@ public class MapView extends FrameLayout {
// Mapbox Core GL Camera
//
- /**
- * Change any combination of center, zoom, bearing, and pitch, without
- * a transition. The map will retain the current values for any options
- * not included in `options`.
- *
- * @param bearing Bearing in Radians
- * @param center Center LatLng
- * @param pitch Pitch in Radians
- * @param zoom Zoom Level
- */
- @UiThread
void jumpTo(double bearing, LatLng center, double pitch, double zoom) {
if (mNativeMapView == null) {
return;
@@ -1223,18 +959,6 @@ public class MapView extends FrameLayout {
mNativeMapView.jumpTo(bearing, center, pitch, zoom);
}
- /**
- * Change any combination of center, zoom, bearing, and pitch, with a smooth animation
- * between old and new values. The map will retain the current values for any options
- * not included in `options`.
- *
- * @param bearing Bearing in Radians
- * @param center Center LatLng
- * @param duration Animation time in Nanoseconds
- * @param pitch Pitch in Radians
- * @param zoom Zoom Level
- */
- @UiThread
void easeTo(double bearing, LatLng center, long duration, double pitch, double zoom, @Nullable final MapboxMap.CancelableCallback cancelableCallback) {
if (mNativeMapView == null) {
return;
@@ -1259,16 +983,6 @@ public class MapView extends FrameLayout {
mNativeMapView.easeTo(bearing, center, duration, pitch, zoom);
}
- /**
- * Flying animation to a specified location/zoom/bearing with automatic curve.
- *
- * @param bearing Bearing in Radians
- * @param center Center LatLng
- * @param duration Animation time in Nanoseconds
- * @param pitch Pitch in Radians
- * @param zoom Zoom Level
- */
- @UiThread
void flyTo(double bearing, LatLng center, long duration, double pitch, double zoom, @Nullable final MapboxMap.CancelableCallback cancelableCallback) {
if (mNativeMapView == null) {
return;
@@ -1470,7 +1184,8 @@ public class MapView extends FrameLayout {
/**
* Helper method for tracking gesture events
- * @param gestureId Type of Gesture See {@see MapboxEvent#GESTURE_SINGLETAP MapboxEvent#GESTURE_DOUBLETAP MapboxEvent#GESTURE_TWO_FINGER_SINGLETAP MapboxEvent#GESTURE_QUICK_ZOOM MapboxEvent#GESTURE_PAN_START MapboxEvent#GESTURE_PINCH_START MapboxEvent#GESTURE_ROTATION_START MapboxEvent#GESTURE_PITCH_START}
+ *
+ * @param gestureId Type of Gesture See {@see MapboxEvent#GESTURE_SINGLETAP MapboxEvent#GESTURE_DOUBLETAP MapboxEvent#GESTURE_TWO_FINGER_SINGLETAP MapboxEvent#GESTURE_QUICK_ZOOM MapboxEvent#GESTURE_PAN_START MapboxEvent#GESTURE_PINCH_START MapboxEvent#GESTURE_ROTATION_START MapboxEvent#GESTURE_PITCH_START}
* @param xCoordinate Original x screen coordinate at start of gesture
* @param yCoordinate Original y screen cooridnate at start of gesture
*/
@@ -1851,10 +1566,10 @@ public class MapView extends FrameLayout {
// around gesture
mNativeMapView.scaleBy(detector.getScaleFactor(), detector.getFocusX() / mScreenDensity, detector.getFocusY() / mScreenDensity);
} else {
- if(trackingSettings.isLocationTrackingDisabled()) {
+ if (trackingSettings.isLocationTrackingDisabled()) {
// around center map
mNativeMapView.scaleBy(detector.getScaleFactor(), (getWidth() / 2) / mScreenDensity, (getHeight() / 2) / mScreenDensity);
- }else {
+ } else {
// around user location view
PointF centerPoint = mUserLocationView.getMarkerScreenPoint();
mNativeMapView.scaleBy(detector.getScaleFactor(), centerPoint.x / mScreenDensity, centerPoint.y / mScreenDensity);
@@ -2395,65 +2110,18 @@ public class MapView extends FrameLayout {
// User location
//
- boolean isPermissionsAccepted() {
- return (ContextCompat.checkSelfPermission(getContext(), Manifest.permission.ACCESS_COARSE_LOCATION) == PackageManager.PERMISSION_GRANTED) ||
- ContextCompat.checkSelfPermission(getContext(), Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED;
- }
-
- /**
- * <p>
- * Enables or disables the my-location layer.
- * While enabled, the my-location layer continuously draws an indication of a user's current
- * location and bearing.
- * </p>
- * In order to use the my-location layer feature you need to request permission for either
- * {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}
- * or @link android.Manifest.permission#ACCESS_FINE_LOCATION.
- *
- * @param enabled True to enable; false to disable.
- * @throws SecurityException if no suitable permission is present
- */
- @UiThread
void setMyLocationEnabled(boolean enabled) {
mUserLocationView.setEnabled(enabled);
}
- /**
- * Returns the currently displayed user location, or null if there is no location data available.
- *
- * @return The currently displayed user location.
- */
- @UiThread
- @Nullable
Location getMyLocation() {
return mUserLocationView.getLocation();
}
- /**
- * Sets a callback that's invoked when the the My Location dot
- * (which signifies the user's location) changes location.
- *
- * @param listener The callback that's invoked when the user clicks on a marker.
- * To unset the callback, use null.
- */
- @UiThread
void setOnMyLocationChangeListener(@Nullable MapboxMap.OnMyLocationChangeListener listener) {
mUserLocationView.setOnMyLocationChangeListener(listener);
}
- /**
- * <p>
- * Set the current my location tracking mode.
- * </p>
- * <p>
- * Will enable my location if not active.
- * </p>
- * See {@link MyLocationTracking} for different values.
- *
- * @param myLocationTrackingMode The location tracking mode to be used.
- * @see MyLocationTracking
- */
- @UiThread
void setMyLocationTrackingMode(@MyLocationTracking.Mode int myLocationTrackingMode) {
if (myLocationTrackingMode != MyLocationTracking.TRACKING_NONE && !mMapboxMap.isMyLocationEnabled()) {
mMapboxMap.setMyLocationEnabled(true);
@@ -2465,21 +2133,6 @@ public class MapView extends FrameLayout {
}
}
- /**
- * <p>
- * Set the current my bearing tracking mode.
- * </p>
- * Shows the direction the user is heading.
- * <p>
- * When location tracking is disabled the direction of {@link UserLocationView} is rotated
- * When location tracking is enabled the {@link MapView} is rotated based on bearing value.
- * </p>
- * See {@link MyBearingTracking} for different values.
- *
- * @param myBearingTrackingMode The bearing tracking mode to be used.
- * @see MyBearingTracking
- */
- @UiThread
void setMyBearingTrackingMode(@MyBearingTracking.Mode int myBearingTrackingMode) {
if (myBearingTrackingMode != MyBearingTracking.NONE && !mMapboxMap.isMyLocationEnabled()) {
mMapboxMap.setMyLocationEnabled(true);
@@ -2491,6 +2144,11 @@ public class MapView extends FrameLayout {
}
}
+ boolean isPermissionsAccepted() {
+ return (ContextCompat.checkSelfPermission(getContext(), Manifest.permission.ACCESS_COARSE_LOCATION) == PackageManager.PERMISSION_GRANTED) ||
+ ContextCompat.checkSelfPermission(getContext(), Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED;
+ }
+
private void resetTrackingModes() {
try {
TrackingSettings trackingSettings = mMapboxMap.getTrackingSettings();
@@ -2505,57 +2163,14 @@ public class MapView extends FrameLayout {
// Compass
//
- /**
- * Returns whether the compass is enabled.
- *
- * @return True if the compass is enabled; false if the compass is disabled.
- */
- @UiThread
- boolean isCompassEnabled() {
- return mCompassView.isEnabled();
- }
-
- /**
- * <p>
- * Enables or disables the compass. The compass is an icon on the map that indicates the
- * direction of north on the map. When a user clicks
- * the compass, the camera orients itself to its default orientation and fades away shortly
- * after. If disabled, the compass will never be displayed.
- * </p>
- * By default, the compass is enabled.
- *
- * @param compassEnabled True to enable the compass; false to disable the compass.
- */
- @UiThread
void setCompassEnabled(boolean compassEnabled) {
mCompassView.setEnabled(compassEnabled);
}
- /**
- * <p>
- * Sets the gravity of the compass view. Use this to change the corner of the map view that the
- * compass is displayed in.
- * </p>
- * By default, the compass is in the top right corner.
- *
- * @param gravity One of the values from {@link Gravity}.
- * @see Gravity
- */
- @UiThread
void setCompassGravity(int gravity) {
setWidgetGravity(mCompassView, gravity);
}
- /**
- * Sets the margins of the compass view. Use this to change the distance of the compass from the
- * map view edge.
- *
- * @param left The left margin in pixels.
- * @param top The top margin in pixels.
- * @param right The right margin in pixels.
- * @param bottom The bottom margin in pixels.
- */
- @UiThread
void setCompassMargins(int left, int top, int right, int bottom) {
setWidgetMargins(mCompassView, left, top, right, bottom);
}
@@ -2564,45 +2179,15 @@ public class MapView extends FrameLayout {
// Logo
//
- /**
- * <p>
- * Sets the gravity of the logo view. Use this to change the corner of the map view that the
- * Mapbox logo is displayed in.
- * </p>
- * By default, the logo is in the bottom left corner.
- *
- * @param gravity One of the values from {@link Gravity}.
- * @see Gravity
- */
- @UiThread
void setLogoGravity(int gravity) {
setWidgetGravity(mLogoView, gravity);
}
- /**
- * Sets the margins of the logo view. Use this to change the distance of the Mapbox logo from the
- * map view edge.
- *
- * @param left The left margin in pixels.
- * @param top The top margin in pixels.
- * @param right The right margin in pixels.
- * @param bottom The bottom margin in pixels.
- */
- @UiThread
void setLogoMargins(int left, int top, int right, int bottom) {
setWidgetMargins(mLogoView, left, top, right, bottom);
}
- /**
- * <p>
- * Enables or disables the Mapbox logo.
- * </p>
- * By default, the compass is enabled.
- *
- * @param visible True to enable the logo; false to disable the logo.
- */
- @UiThread
- void setLogoVisibility(boolean visible) {
+ void setLogoEnabled(boolean visible) {
mLogoView.setVisibility(visible ? View.VISIBLE : View.GONE);
}
@@ -2610,85 +2195,19 @@ public class MapView extends FrameLayout {
// Attribution
//
- /**
- * <p>
- * Sets the gravity of the attribution button view. Use this to change the corner of the map
- * view that the attribution button is displayed in.
- * </p>
- * By default, the attribution button is in the bottom left corner.
- *
- * @param gravity One of the values from {@link Gravity}.
- * @see Gravity
- */
- @UiThread
void setAttributionGravity(int gravity) {
setWidgetGravity(mAttributionsView, gravity);
}
- /**
- * Sets the margins of the attribution button view. Use this to change the distance of the
- * attribution button from the map view edge.
- *
- * @param left The left margin in pixels.
- * @param top The top margin in pixels.
- * @param right The right margin in pixels.
- * @param bottom The bottom margin in pixels.
- */
- @UiThread
void setAttributionMargins(int left, int top, int right, int bottom) {
setWidgetMargins(mAttributionsView, left, top, right, bottom);
}
- //
- // Content padding
- //
-
-// /**
-// * Sets the distance from the edges of the map view’s frame to the edges of the map
-// * view’s logical viewport.
-// * <p/>
-// * When the value of this property is equal to {0,0,0,0}, viewport
-// * properties such as `getLatLng` assume a viewport that matches the map
-// * view’s frame. Otherwise, those properties are inset, excluding part of the
-// * frame from the viewport. For instance, if the only the top edge is inset, the
-// * map center is effectively shifted downward.
-// *
-// * @param left The left margin in pixels.
-// * @param top The top margin in pixels.
-// * @param right The right margin in pixels.
-// * @param bottom The bottom margin in pixels.
-// */
-//
-// @UiThread
-// void setContentPadding(int left, int top, int right, int bottom) {
-//
-// if (left == mContentPaddingLeft && top == mContentPaddingTop && right == mContentPaddingRight && bottom == mContentPaddingBottom) {
-// return;
-// }
-//
-// mContentPaddingLeft = left;
-// mContentPaddingTop = top;
-// mContentPaddingRight = right;
-// mContentPaddingBottom = bottom;
-//
-// mNativeMapView.setContentPadding(top / mScreenDensity, left / mScreenDensity, bottom / mScreenDensity, right / mScreenDensity);
-// }
-
- /**
- * <p>
- * Enables or disables the attribution button. The attribution is a button with an "i" than when
- * clicked shows a menu with copyright and legal notices. The menu also inlcudes the "Improve
- * this map" link which user can report map errors with.
- * </p>
- * By default, the attribution button is enabled.
- *
- * @param visibility True to enable the attribution button; false to disable the attribution button.
- */
- @UiThread
- void setAttributionVisibility(int visibility) {
+ void setAttributionEnabled(int visibility) {
mAttributionsView.setVisibility(visibility);
}
+
//
// Custom layer
//
@@ -2834,7 +2353,7 @@ public class MapView extends FrameLayout {
/**
- * Map change event types.
+ * Definition of a map change event.
*
* @see MapView.OnMapChangedListener#onMapChanged(int)
*/
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
index 40b75d3ce1..0438f55ca7 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
@@ -38,6 +38,15 @@ import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;
+/**
+ * The general class to interact with in the Android Mapbox SDK. It exposes the entry point for all
+ * methods related to the MapView. You cannot instantiate {@link MapboxMap} object directly, rather,
+ * you must obtain one from the getMapAsync() method on a MapFragment or MapView that you have
+ * added to your application.
+ * <p>
+ * Note: Similar to a View object, a GoogleMap should only be read and modified from the main thread.
+ * </p>
+ */
public class MapboxMap {
private MapView mMapView;
@@ -300,11 +309,19 @@ public class MapboxMap {
});
}
- // internal time layer conversion
+ /**
+ * Converts milliseconds to nanoseconds
+ *
+ * @param durationMs The time in milliseconds
+ * @return time in nanoseconds
+ */
private long getDurationNano(long durationMs) {
return durationMs > 0 ? TimeUnit.NANOSECONDS.convert(durationMs, TimeUnit.MILLISECONDS) : 0;
}
+ /**
+ * Invalidates the current camera position by reconstructing it from mbgl
+ */
private void invalidateCameraPosition() {
mInvalidCameraPosition = false;
mCameraPosition = new CameraPosition.Builder(true)
@@ -330,10 +347,6 @@ public class MapboxMap {
}
//
- // Manual zoom controls
- //
-
- //
// Debug
//
@@ -1373,7 +1386,7 @@ public class MapboxMap {
}
/**
- * Interface definition for a callback to be invoked for when the camera changes position.
+ * Interface definition for a callback to be invoked when the camera changes position.
*/
public interface OnCameraChangeListener {
/**
@@ -1387,7 +1400,7 @@ public class MapboxMap {
}
/**
- * Interface definition for a callback to be invoked on every frame rendered to the map view.
+ * Interface definition for a callback to be invoked when a frame is rendered to the map view.
*
* @see MapboxMap#setOnFpsChangedListener(OnFpsChangedListener)
*/
@@ -1459,7 +1472,7 @@ public class MapboxMap {
}
/**
- * Callback interface for when the user long presses on a marker's info window.
+ * Interface definition for a callback to be invoked when the user long presses on a marker's info window.
*
* @see MapboxMap#setOnInfoWindowClickListener(OnInfoWindowClickListener)
*/
@@ -1474,7 +1487,7 @@ public class MapboxMap {
}
/**
- * Callback interface for close events on a marker's info window.
+ * Interface definition for a callback to be invoked when a marker's info window is closed.
*
* @see MapboxMap#setOnInfoWindowCloseListener(OnInfoWindowCloseListener)
*/
@@ -1552,7 +1565,7 @@ public class MapboxMap {
}
/**
- * A callback interface for reporting when a task is complete or cancelled.
+ * Interface definition for a callback to be invoked when a task is complete or cancelled.
*/
public interface CancelableCallback {
/**
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/OnMapReadyCallback.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/OnMapReadyCallback.java
index 09c7ccacf7..255ca1e5f9 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/OnMapReadyCallback.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/OnMapReadyCallback.java
@@ -2,12 +2,8 @@ package com.mapbox.mapboxsdk.maps;
import android.support.annotation.NonNull;
-import com.mapbox.mapboxsdk.maps.MapFragment;
-import com.mapbox.mapboxsdk.maps.MapView;
-import com.mapbox.mapboxsdk.maps.MapboxMap;
-
/**
- * Callback interface for when the map is ready to be used.
+ * Interface definition for a callback to be invoked when the map is ready to be used.
* <p>
* Once an instance of this interface is set on a {@link MapFragment} or {@link MapView} object,
* the onMapReady(MapboxMap) method is triggered when the map is ready to be used and provides a non-null instance of {@link MapboxMap}.
@@ -22,5 +18,4 @@ public interface OnMapReadyCallback {
* or {@link MapView} that defines the callback.
*/
void onMapReady(@NonNull MapboxMap mapboxMap);
-
}
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/SupportMapFragment.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/SupportMapFragment.java
index 8783712e10..60d9320ee6 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/SupportMapFragment.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/SupportMapFragment.java
@@ -9,11 +9,10 @@ import android.view.View;
import android.view.ViewGroup;
import com.mapbox.mapboxsdk.R;
-import com.mapbox.mapboxsdk.constants.MapboxConstants;
import com.mapbox.mapboxsdk.utils.ApiAccess;
/**
- * Fragment wrapper around a {@link MapView}.
+ * Support Fragment wrapper around a map view.
* <p>
* A Map component in an app. This fragment is the simplest way to place a map in an application.
* It's a wrapper around a view of a map to automatically handle the necessary life cycle needs.
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
index 543ff19e56..1a1c2407ce 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
@@ -6,6 +6,9 @@ import android.support.annotation.UiThread;
import com.mapbox.mapboxsdk.constants.MyBearingTracking;
import com.mapbox.mapboxsdk.constants.MyLocationTracking;
+/**
+ * Settings for the user location and bearing tracking of a MapboxMap.
+ */
public class TrackingSettings {
private MapView mapView;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java
index 1538f49d60..4c2502cdb8 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java
@@ -6,7 +6,6 @@ import android.support.annotation.UiThread;
import android.util.Log;
import android.view.Gravity;
import android.view.View;
-import android.widget.VideoView;
import com.mapbox.mapboxsdk.constants.MapboxConstants;
@@ -212,7 +211,7 @@ public class UiSettings {
*/
public void setLogoEnabled(boolean enabled) {
logoSettings.setEnabled(enabled);
- mapView.setLogoVisibility(enabled);
+ mapView.setLogoEnabled(enabled);
}
/**
@@ -308,7 +307,7 @@ public class UiSettings {
*/
public void setAttributionEnabled(boolean enabled) {
attributionSettings.setEnabled(enabled);
- mapView.setAttributionVisibility(enabled ? View.VISIBLE : View.GONE);
+ mapView.setAttributionEnabled(enabled ? View.VISIBLE : View.GONE);
}
/**
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/ViewSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/ViewSettings.java
index a192a1b576..0726b7bbbf 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/ViewSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/ViewSettings.java
@@ -1,6 +1,9 @@
package com.mapbox.mapboxsdk.maps;
-public class ViewSettings {
+/**
+ * Settings for the overlain views of a MapboxMap. Used by UiSettings.
+ */
+class ViewSettings {
private boolean enabled;
private int gravity;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/package-info.java
index 9112361d83..3451e0aece 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains the {@link com.mapbox.mapboxsdk.maps.MapboxMap}, {@link com.mapbox.mapboxsdk.maps.MapView}, {@link com.mapbox.mapboxsdk.maps.NativeMapView} and {@link com.mapbox.mapboxsdk.maps.MapFragment} classes
+ * This package contains the Mapbox Maps Android API classes.
*/
package com.mapbox.mapboxsdk.maps;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/CompassView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/CompassView.java
index 28afb70de3..4d247b442b 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/CompassView.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/CompassView.java
@@ -1,6 +1,7 @@
package com.mapbox.mapboxsdk.maps.widgets;
import android.content.Context;
+import android.support.annotation.NonNull;
import android.support.v4.content.ContextCompat;
import android.support.v4.view.ViewCompat;
import android.support.v4.view.ViewPropertyAnimatorCompat;
@@ -19,7 +20,7 @@ import java.util.Timer;
import java.util.TimerTask;
/**
- * CompassView is a UI element overlaid on a map that shows the map's bearing
+ * UI element overlaid on a map to show the map's bearing
* when it isn't true north (0.0). Tapping the compass resets the bearing to true
* north and hides the compass.
*/
@@ -57,6 +58,10 @@ public final class CompassView extends ImageView {
setLayoutParams(lp);
}
+ public void setMapboxMap(@NonNull MapboxMap mapboxMap){
+ setOnClickListener(new CompassClickListener(mapboxMap));
+ }
+
@Override
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
@@ -139,7 +144,7 @@ public final class CompassView extends ImageView {
}
}
- public static class CompassClickListener implements View.OnClickListener {
+ static class CompassClickListener implements View.OnClickListener {
private WeakReference<MapboxMap> mMapboxMap;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/UserLocationView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/UserLocationView.java
index 216340ff1f..b2364dc042 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/UserLocationView.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/UserLocationView.java
@@ -39,10 +39,8 @@ import com.mapbox.mapboxsdk.maps.Projection;
import java.lang.ref.WeakReference;
/**
- * This view shows the user's location, as determined from GPS, on the map
- * as a dot annotation.
+ * UI element overlaid on a map to show the user's location.
*/
-
public final class UserLocationView extends View {
private MapboxMap mMapboxMap;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/package-info.java
index d6cb1ca852..e10f190678 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/package-info.java
@@ -1,4 +1,4 @@
/**
- * This package contains the classes that manage the SDK's Telemetry services.
+ * This package contains classes that manages the map Telemetry services.
*/
package com.mapbox.mapboxsdk.telemetry;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java
index 9d9c0bf4bb..f81f9bad6b 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java
@@ -1,5 +1,4 @@
/**
- * This package contains the {@link com.mapbox.mapboxsdk.utils.ApiAccess} class. {@code ApiAccess}
- * provides a methods to load a Mapbox access token.
+ * This package contains utility classes used by the map.
*/
package com.mapbox.mapboxsdk.utils;
diff --git a/platform/android/MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/testapp/MainActivityTest.java b/platform/android/MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/testapp/MainActivityTest.java
index a5f3a2e791..bae1738421 100644
--- a/platform/android/MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/testapp/MainActivityTest.java
+++ b/platform/android/MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/testapp/MainActivityTest.java
@@ -237,7 +237,7 @@ public class MainActivityTest extends BaseTest {
public void testMapIconContentDescription() {
// Mapbox logo
onView(withContentDescription(mActivity.getResources()
- .getString(R.string.mapboxIconContentDescription)))
+ .getString(R.string.mapbox_mapboxIconContentDescription)))
.check(matches(isDisplayed()));
}
@@ -254,7 +254,7 @@ public class MainActivityTest extends BaseTest {
public void testMapAttributionsIconContentDescription() {
// Attribution icon
onView(withContentDescription(mActivity.getResources()
- .getString(R.string.attributionsIconContentDescription)))
+ .getString(R.string.mapbox_attributionsIconContentDescription)))
.check(matches(isDisplayed()));
}