From 8a208133db3e8b6530373f1b5974548bbd0db46d Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Mon, 14 Dec 2015 18:57:03 -0500 Subject: [PATCH] [android] Add some JavaDocs, fix HTML formatting --- .../mapboxsdk/annotations/Annotation.java | 12 +- .../mapboxsdk/annotations/InfoWindow.java | 5 +- .../mapbox/mapboxsdk/annotations/Marker.java | 5 + .../mapboxsdk/annotations/MarkerOptions.java | 17 + .../mapbox/mapboxsdk/annotations/Polygon.java | 3 + .../mapboxsdk/annotations/Polyline.java | 3 + .../com/mapbox/mapboxsdk/constants/Style.java | 13 +- .../SpriteBitmapChangedException.java | 3 +- .../exceptions/TooManySpritesException.java | 3 +- .../com/mapbox/mapboxsdk/utils/ApiAccess.java | 3 +- .../com/mapbox/mapboxsdk/views/MapView.java | 290 +++++++++++------- 11 files changed, 240 insertions(+), 117 deletions(-) diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java index 4492f5cc6..bf8999878 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java @@ -4,11 +4,18 @@ import android.support.annotation.NonNull; import com.mapbox.mapboxsdk.views.MapView; +/** + * Annotation is the most general kind of overlay on top of a map, + * from which {@link InfoWindow} and {@link Marker} are derived: it manages + * attachment to a map and identification, but does not require + * content to be placed at a geographical point. + */ public abstract class Annotation implements Comparable { /** + *

* The annotation id - *

+ *

* Internal C++ id is stored as unsigned int. */ private long id = -1; // -1 unless added to a MapView @@ -18,8 +25,9 @@ public abstract class Annotation implements Comparable { } /** + *

* Gets the annotation's unique ID. - *

+ *

* This ID is unique for a MapView instance and is suitable for associating your own extra * data with. */ diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java index 5d4fa91e0..e0433f00d 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java @@ -16,7 +16,10 @@ import com.mapbox.mapboxsdk.views.MapView; import java.lang.ref.WeakReference; /** - * A tooltip view + *

+ * A tooltip view. This is a UI element placed over a map at a specific geographic + * location. + *

*/ public class InfoWindow { diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java index 6ebc8b225..0f626a261 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java @@ -7,6 +7,11 @@ import com.mapbox.mapboxsdk.R; import com.mapbox.mapboxsdk.geometry.LatLng; import com.mapbox.mapboxsdk.views.MapView; +/** + * A marker is a map overlay that shows an icon image at a specific + * geographical location and can be associated with a {@link InfoWindow} + * that is shown when the marker is tapped. + */ public final class Marker extends Annotation { private LatLng position; diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java index 921905d4f..b5bb24a49 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java @@ -7,6 +7,23 @@ import android.support.annotation.Nullable; import com.mapbox.mapboxsdk.geometry.LatLng; + +/** + *

+ * A builder object for the options configuration {@link com.mapbox.mapboxsdk.annotations.Marker} and + * {@link com.mapbox.mapboxsdk.annotations.InfoWindow} + * instances on maps. + *

+ * + *

Example

+ * + * 
+ * mMapView.addMarker(new MarkerOptions()
+ *   .title("Intersection")
+ *   .snippet("H St NW with 15th St NW")
+ *   .position(new LatLng(38.9002073, -77.03364419)));
+ *
+ */ public final class MarkerOptions implements Parcelable { public static final Parcelable.Creator CREATOR diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java index 32258943a..4a07b1682 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java @@ -7,6 +7,9 @@ import com.mapbox.mapboxsdk.geometry.LatLng; import java.util.ArrayList; import java.util.List; +/** + * Polygon is a geometry annotation that's a closed loop of coordinates. + */ public final class Polygon extends MultiPoint { private int fillColor = Color.BLACK; // default fillColor is black diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java index 331974c9c..cfaf0d21d 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java @@ -2,6 +2,9 @@ package com.mapbox.mapboxsdk.annotations; import android.graphics.Color; +/** + * Polyline is a geometry feature with an unclosed list of coordinates drawn as a line + */ public final class Polyline extends MultiPoint { private int color = Color.BLACK; // default color is black diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java index 04c7a3138..11ee9c315 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java @@ -7,12 +7,13 @@ import com.mapbox.mapboxsdk.views.MapView; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; /** -* Style provides URLs to several professional styles designed by Mapbox. -*

-* These styles are all ready to go in your app. To load one, pass it into {@link MapView#setStyleUrl(String)} -* -* @see MapView#setStyleUrl(String) -*/ + *

+ * Style provides URLs to several professional styles designed by Mapbox. + *

+ * These styles are all ready to go in your app. To load one, pass it into {@link MapView#setStyleUrl(String)} + * + * @see MapView#setStyleUrl(String) + */ public class Style { /** diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/SpriteBitmapChangedException.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/SpriteBitmapChangedException.java index 15c6d7eec..03c5f914b 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/SpriteBitmapChangedException.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/SpriteBitmapChangedException.java @@ -7,9 +7,10 @@ import com.mapbox.mapboxsdk.annotations.Sprite; import com.mapbox.mapboxsdk.views.MapView; /** + *

* A {@code SpriteBitmapChangedException} is thrown by {@link MapView} when a {@link Marker} is added * that has a {@link Sprite} with a {@link Bitmap} that has been modified. - *

+ *

* You cannot modify a {@code Sprite} after it has been added to the map in a {@code Marker} * * @see MapView diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/TooManySpritesException.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/TooManySpritesException.java index 02a57ba22..d36c99edd 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/TooManySpritesException.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/TooManySpritesException.java @@ -4,9 +4,10 @@ import com.mapbox.mapboxsdk.annotations.Sprite; import com.mapbox.mapboxsdk.annotations.SpriteFactory; /** + *

* A {@code TooManySpritesException} is thrown by {@link SpriteFactory} when it * cannot create a {@link Sprite} because there are already too many. - *

+ *

* You should try to reuse Sprite objects whenever possible. * * @see SpriteFactory diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ApiAccess.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ApiAccess.java index 180144a44..c92031c54 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ApiAccess.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ApiAccess.java @@ -14,8 +14,9 @@ import com.mapbox.mapboxsdk.constants.MapboxConstants; public final class ApiAccess { /** + *

* Returns the Mapbox access token set in the app resources. - *

+ *

* It will first search the application manifest for a {@link MapboxConstants#KEY_META_DATA_MANIFEST} * meta-data value. If not found it will then attempt to load the access token from the * {@code res/raw/token.txt} development file. diff --git a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java index b8a0f18b3..94cfe23f8 100644 --- a/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java +++ b/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java @@ -85,14 +85,16 @@ import java.util.Collections; import java.util.List; /** + *

* A {@code MapView} provides an embeddable map interface. * You use this class to display map information and to manipulate the map contents from your application. * You can center the map on a given coordinate, specify the size of the area you want to display, * and style the features of the map to fit your application's use case. - *

+ *

+ *

* Use of {@code MapView} requires a Mapbox API access token. * Obtain an access token on the Mapbox account page. - *

+ *

* Warning: Please note that you are responsible for getting permission to use the map data, * and for ensuring your use adheres to the relevant terms of use. * @@ -288,115 +290,133 @@ public final class MapView extends FrameLayout { } /** + *

* This {@link MapChange} is triggered whenever the currently displayed map region is about to changing * without an animation. - *

+ *

+ *

* This event is followed by a series of {@link MapView#REGION_IS_CHANGING} and ends * with {@link MapView#REGION_DID_CHANGE}. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int REGION_WILL_CHANGE = 0; /** + *

* This {@link MapChange} is triggered whenever the currently displayed map region is about to changing * with an animation. - *

+ *

+ *

* This event is followed by a series of {@link MapView#REGION_IS_CHANGING} and ends * with {@link MapView#REGION_DID_CHANGE_ANIMATED}. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int REGION_WILL_CHANGE_ANIMATED = 1; /** + *

* This {@link MapChange} is triggered whenever the currently displayed map region is changing. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int REGION_IS_CHANGING = 2; /** + *

* This {@link MapChange} is triggered whenever the currently displayed map region finished changing * without an animation. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int REGION_DID_CHANGE = 3; /** + *

* This {@link MapChange} is triggered whenever the currently displayed map region finished changing * with an animation. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int REGION_DID_CHANGE_ANIMATED = 4; /** + *

* This {@link MapChange} is triggered when the map is about to start loading a new map style. - *

+ *

+ *

* This event is followed by {@link MapView#DID_FINISH_LOADING_MAP} or * {@link MapView#DID_FAIL_LOADING_MAP}. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int WILL_START_LOADING_MAP = 5; /** + *

* This {@link MapChange} is triggered when the map has successfully loaded a new map style. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int DID_FINISH_LOADING_MAP = 6; /** + *

* This {@link MapChange} is currently not implemented. - *

+ *

+ *

* This event is triggered when the map has failed to load a new map style. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int DID_FAIL_LOADING_MAP = 7; /** + *

* This {@link MapChange} is currently not implemented. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int WILL_START_RENDERING_FRAME = 8; /** + *

* This {@link MapChange} is currently not implemented. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int DID_FINISH_RENDERING_FRAME = 9; /** + *

* This {@link MapChange} is currently not implemented. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int DID_FINISH_RENDERING_FRAME_FULLY_RENDERED = 10; /** + *

* This {@link MapChange} is currently not implemented. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int WILL_START_RENDERING_MAP = 11; /** + *

* This {@link MapChange} is currently not implemented. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int DID_FINISH_RENDERING_MAP = 12; /** + *

* This {@link MapChange} is currently not implemented. - *

- * More information in {@see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener} + *

+ * @see com.mapbox.mapboxsdk.views.MapView.OnMapChangedListener */ public static final int DID_FINISH_RENDERING_MAP_FULLY_RENDERED = 13; @@ -794,6 +814,7 @@ public final class MapView extends FrameLayout { // /** + *

* You must call this method from the parent's {@link android.app.Activity#onCreate(Bundle)} or * {@link android.app.Fragment#onCreate(Bundle)}. *

@@ -1013,10 +1034,12 @@ public final class MapView extends FrameLayout { } /** + *

* Centers the map on a new coordinate immediately without changing the zoom level. - *

+ *

+ *

* The initial coordinate is (0, 0). - *

+ *

* If you want to animate the change, use {@link MapView#setCenterCoordinate(LatLng, boolean)}. * * @param centerCoordinate The new coordinate. @@ -1028,8 +1051,9 @@ public final class MapView extends FrameLayout { } /** + *

* Centers the map on a new coordinate without changing the zoom level and optionally animates the change. - *

+ *

* The initial coordinate is (0, 0). * * @param centerCoordinate The new coordinate. @@ -1048,10 +1072,12 @@ public final class MapView extends FrameLayout { /** + *

* Centers the map on a new coordinate immediately while changing the current zoom level. - *

+ *

+ *

* The initial value is a center coordinate of (0, 0) and a zoom level of 0. - *

+ *

* If you want to animate the change, use {@link MapView#setCenterCoordinate(LatLngZoom, boolean)}. * * @param centerCoordinate The new coordinate and zoom level. @@ -1073,8 +1099,9 @@ public final class MapView extends FrameLayout { } /** + *

* Centers the map on a new coordinate while changing the zoom level and optionally animates the change. - *

+ *

* The initial value is a center coordinate of (0, 0) and a zoom level of 0. * * @param centerCoordinate The new coordinate and zoom level. @@ -1103,11 +1130,13 @@ public final class MapView extends FrameLayout { } /** + *

* Changes whether the user may scroll around the map. - *

+ *

+ *

* This setting controls only user interactions with the map. If you set the value to false, * you may still change the map location programmatically. - *

+ *

* The default value is true. * * @param scrollEnabled If true, scrolling is enabled. @@ -1168,15 +1197,18 @@ public final class MapView extends FrameLayout { } /** + *

* Rotates the map to a new heading relative to true north immediately. - *

- * The value 0 means that the top edge of the map view will correspond to true north.
- * The value 90 means the top of the map will point due east.
- * The value 180 means the top of the map will point due south.
- * The value 270 means the top of the map will point due west. - *

+ *

+ *
    + *
  • The value 0 means that the top edge of the map view will correspond to true north.
    • + *
  • The value 90 means the top of the map will point due east.
    • + *
  • The value 180 means the top of the map will point due south.
    • + *
  • The value 270 means the top of the map will point due west.
    • + *
+ *

* The initial heading is 0. - *

+ *

* If you want to animate the change, use {@link MapView#setDirection(double, boolean)}. * * @param direction The new heading measured in degrees. @@ -1188,13 +1220,15 @@ public final class MapView extends FrameLayout { } /** + *

* Rotates the map to a new heading relative to true north and optionally animates the change. - *

- * The value 0 means that the top edge of the map view will correspond to true north.
- * The value 90 means the top of the map will point due east.
- * The value 180 means the top of the map will point due south.
- * The value 270 means the top of the map will point due west - *

+ *

+ *
    + *
  • The value 0 means that the top edge of the map view will correspond to true north.
    • + *
  • The value 90 means the top of the map will point due east.
    • + *
  • The value 180 means the top of the map will point due south.
    • + *
  • The value 270 means the top of the map will point due west.
    • + *
* The initial heading is 0. * * @param direction The new heading measured in degrees from true north. @@ -1228,11 +1262,13 @@ public final class MapView extends FrameLayout { } /** + *

* Changes whether the user may rotate the map. - *

+ *

+ *

* This setting controls only user interactions with the map. If you set the value to false, * you may still change the map location programmatically. - *

+ *

* The default value is true. * * @param rotateEnabled If true, rotating is enabled. @@ -1258,14 +1294,17 @@ public final class MapView extends FrameLayout { } /** + *

* Zooms the map to a new zoom level immediately without changing the center coordinate. - *

+ *

+ *

* At zoom level 0, tiles cover the entire world map; - * at zoom level 1, tiles cover ¼ of the world; + * at zoom level 1, tiles cover 1/14 of the world; * at zoom level 2, tiles cover 1/16 of the world, and so on. - *

+ *

+ *

* The initial zoom level is 0. The maximum zoom level is {@link MapView#MAXIMUM_ZOOM_LEVEL}. - *

+ *

* If you want to animate the change, use {@link MapView#setZoomLevel(double, boolean)}. * * @param zoomLevel The new coordinate. @@ -1278,12 +1317,14 @@ public final class MapView extends FrameLayout { } /** + *

* Zooms the map to a new zoom level and optionally animates the change without changing the center coordinate. - *

+ *

+ *

* At zoom level 0, tiles cover the entire world map; - * at zoom level 1, tiles cover ¼ of the world; + * at zoom level 1, tiles cover 1/14 of the world; * at zoom level 2, tiles cover 1/16 of the world, and so on. - *

+ *

* The initial zoom level is 0. The maximum zoom level is {@link MapView#MAXIMUM_ZOOM_LEVEL}. * * @param zoomLevel The new coordinate. @@ -1311,11 +1352,13 @@ public final class MapView extends FrameLayout { } /** + *

* Changes whether the user may zoom the map. - *

+ *

+ *

* This setting controls only user interactions with the map. If you set the value to false, * you may still change the map location programmatically. - *

+ *

* The default value is true. * * @param zoomEnabled If true, zooming is enabled. @@ -1341,12 +1384,13 @@ public final class MapView extends FrameLayout { } /** + *

* 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. - *

+ *

* By default the zoom controls are enabled if the device is only single touch capable; * * @param enabled If true, the zoom controls are enabled. @@ -1392,11 +1436,13 @@ public final class MapView extends FrameLayout { } /** + *

* Changes whether the user may tilt the map. - *

+ *

+ *

* This setting controls only user interactions with the map. If you set the value to false, * you may still change the map location programmatically. - *

+ *

* The default value is true. * * @param tiltEnabled If true, tilting is enabled. @@ -1445,8 +1491,9 @@ public final class MapView extends FrameLayout { } /** + *

* Changes whether the map debug information is shown. - *

+ *

* The default value is false. * * @param debugActive If true, map debug information is shown. @@ -1457,8 +1504,9 @@ public final class MapView extends FrameLayout { } /** + *

* Cycles through the map debug options. - *

+ *

* The value of {@link MapView#isDebugActive()} reflects whether there are * any map debug options enabled or disabled. * @@ -1479,8 +1527,9 @@ public final class MapView extends FrameLayout { // /** + *

* Loads a new map style from the specified URL. - *

+ *

* {@code url} can take the following forms: *
    *
  • {@code Style.*}: load one of the bundled styles in {@link Style}.
    • @@ -1495,10 +1544,10 @@ public final class MapView extends FrameLayout { * This is used to load a style bundled with your app. *
  • {@code null}: loads the default {@link Style#MAPBOX_STREETS} style.
    • *
- *

+ *

* 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. - *

+ *

* 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. * @@ -1515,11 +1564,13 @@ public final class MapView extends FrameLayout { } /** + *

* Loads a new map style from the specified bundled style. - *

+ *

+ *

* 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. - *

+ *

* 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. * @@ -1532,8 +1583,9 @@ public final class MapView extends FrameLayout { } /** + *

* Returns the map style currently displayed in the map view. - *

+ *

* If the default style is currently displayed, a URL will be returned instead of null. * * @return The URL of the map style. @@ -1556,10 +1608,12 @@ public final class MapView extends FrameLayout { } /** + *

* Changes the set of currently active map style classes immediately. - *

+ *

+ *

* The list of valid class identifiers is defined by the currently loaded map style. - *

+ *

* If you want to animate the change, use {@link MapView#setStyleClasses(List, long)}. * * @param styleClasses A list of class identifiers. @@ -1572,8 +1626,9 @@ public final class MapView extends FrameLayout { } /** + *

* Changes the set of currently active map style classes with an animated transition. - *

+ *

* The list of valid class identifiers is defined by the currently loaded map style. * * @param styleClasses A list of class identifiers. @@ -1596,8 +1651,9 @@ public final class MapView extends FrameLayout { } /** + *

* Activates the specified map style class. - *

+ *

* If you want to animate the change, use {@link MapView#setStyleClasses(List, long)}. * * @param styleClass The class identifier. @@ -1613,8 +1669,9 @@ public final class MapView extends FrameLayout { } /** + *

* Deactivates the specified map style class. - *

+ *

* If you want to animate the change, use {@link MapView#setStyleClasses(List, long)}. * * @param styleClass The class identifier. @@ -1645,8 +1702,9 @@ public final class MapView extends FrameLayout { } /** + *

* Deactivates all the currently active map style classes immediately. - *

+ *

* If you want to animate the change, use {@link MapView#removeAllStyleClasses(long)}. * * @see MapView#removeAllStyleClasses(long) @@ -1683,11 +1741,13 @@ public final class MapView extends FrameLayout { } /** + *

* Sets the current Mapbox access token used to load map styles and tiles. - *

+ *

+ *

* You must set a valid access token before you call {@link MapView#onCreate(Bundle)} * or an exception will be thrown. - *

+ *

* You can use {@link ApiAccess#getToken(Context)} to load an access token from your * application's manifest. * @@ -1830,8 +1890,9 @@ public final class MapView extends FrameLayout { } /** + *

* Adds a marker to this map. - *

+ *

* The marker's icon is rendered on the map at the location {@code Marker.position}. * If {@code Marker.title} is defined, the map shows an info box with the marker's title and snippet. * @@ -1855,8 +1916,9 @@ public final class MapView extends FrameLayout { } /** + *

* Adds multiple markers to this map. - *

+ *

* The marker's icon is rendered on the map at the location {@code Marker.position}. * If {@code Marker.title} is defined, the map shows an info box with the marker's title and snippet. * @@ -2005,8 +2067,9 @@ public final class MapView extends FrameLayout { /** + *

* Convenience method for removing a Marker from the map. - *

+ *

* Calls removeAnnotation() internally * * @param marker Marker to remove @@ -2126,8 +2189,9 @@ public final class MapView extends FrameLayout { } /** + *

* Returns the distance spanned by one pixel at the specified latitude and current zoom level. - *

+ *

* The distance between pixels decreases as the latitude approaches the poles. * This relationship parallels the relationship between longitudinal coordinates at different latitudes. * @@ -2140,10 +2204,11 @@ public final class MapView extends FrameLayout { } /** + *

* Selects a marker. The selected marker will have it's info window opened. * Any other open info windows will be closed unless isAllowConcurrentMultipleOpenInfoWindows() * is true. - *

+ *

* Selecting an already selected marker will have no effect. * * @param marker The marker to select. @@ -2440,11 +2505,13 @@ public final class MapView extends FrameLayout { // /** + *

* Sets the preference for whether all gestures should be enabled or disabled. - *

+ *

+ *

* This setting controls only user interactions with the map. If you set the value to false, * you may still change the map location programmatically. - *

+ *

* The default value is true. * * @param enabled If true, all gestures are available; otherwise, all gestures are disabled. @@ -3259,8 +3326,9 @@ public final class MapView extends FrameLayout { // /** + *

* Add a callback that's invoked when the displayed map view changes. - *

+ *

* To remove the callback, use {@link MapView#removeOnMapChangedListener(OnMapChangedListener)}. * * @param listener The callback that's invoked on every frame rendered to the map view. @@ -3299,8 +3367,9 @@ public final class MapView extends FrameLayout { } /** + *

* Sets a custom renderer for the contents of info window. - *

+ *

* When set your callback is invoked when an info window is about to be shown. By returning * a custom {@link View}, the default info window will be replaced. * @@ -3441,10 +3510,11 @@ public final class MapView extends FrameLayout { } /** + *

* 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. - *

+ *

* 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. @@ -3480,9 +3550,10 @@ public final class MapView extends FrameLayout { } /** + *

* Set the current my location tracking mode. * Tracking my location disables gestures and pans the viewport - *

+ *

* See {@link MyLocationTracking} for different values. * * @param myLocationTrackingMode The location tracking mode to be used. @@ -3523,13 +3594,16 @@ public final class MapView extends FrameLayout { } /** + *

* Set the current my bearing tracking mode. - *

+ *

+ *

* Tracking the users bearing will disable gestures and shows the direction the user is heading. - *

+ *

+ *

* 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. - *

+ *

* See {@link MyBearingTracking} for different values. * * @param myBearingTrackingMode The bearing tracking mode to be used. @@ -3570,11 +3644,12 @@ public final class MapView extends FrameLayout { } /** + *

* 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. - *

+ *

* By default, the compass is enabled. * * @param compassEnabled True to enable the compass; false to disable the compass. @@ -3585,9 +3660,10 @@ public final class MapView extends FrameLayout { } /** + *

* Sets the gravity of the compass view. Use this to change the corner of the map view that the * compass is displayed in. - *

+ *

* By default, the compass is in the top right corner. * * @param gravity One of the values from {@link Gravity}. @@ -3617,9 +3693,10 @@ public final class MapView extends FrameLayout { // /** + *

* Sets the gravity of the logo view. Use this to change the corner of the map view that the * Mapbox logo is displayed in. - *

+ *

* By default, the logo is in the bottom left corner. * * @param gravity One of the values from {@link Gravity}. @@ -3645,8 +3722,9 @@ public final class MapView extends FrameLayout { } /** + *

* Enables or disables the Mapbox logo. - *

+ *

* By default, the compass is enabled. * * @param visibility True to enable the logo; false to disable the logo. @@ -3661,9 +3739,10 @@ public final class MapView extends FrameLayout { // /** + *

* 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. - *

+ *

* By default, the attribution button is in the bottom left corner. * * @param gravity One of the values from {@link Gravity}. @@ -3689,10 +3768,11 @@ public final class MapView extends FrameLayout { } /** + *

* 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. - *

+ *

* By default, the attribution button is enabled. * * @param visibility True to enable the attribution button; false to disable the attribution button.