Legacy
Android Plugins
All docsAndroid PluginsExamplesChange map text to device language

Change map text to device language

Not compatible with the Maps SDK v10

This plugin is not compatible with the Maps SDK v10 or higher. The Maps SDK v10 and higher comes with localization functionality built in. See the Localization documentation.

This example uses the Localization plugin to automatically detect the language set on a user's Android device and change the map text to that language.

You must install the plugin before running the application.

Note

This example is a part of the Mapbox Android Demo app. You can find the values for all referenced resources in the res directory. For example, see res/values/activity_strings.xml for R.string.* references used in this example.

activity_localization_plugin
<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:mapbox="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent">
<com.mapbox.mapboxsdk.maps.MapView
android:id="@+id/mapView"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:mapbox_cameraTargetLat="35.830744"
app:mapbox_cameraTargetLng="136.711369"
app:mapbox_cameraZoom="4.5257" />
<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="8dp"
android:layout_marginLeft="8dp"
android:layout_marginTop="16dp"
android:orientation="horizontal">
<Button
android:id="@+id/language_one_button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:background="@color/mapboxOrangeDark"
android:text="@string/arabic"
android:textColor="@color/mapboxWhite" />
<Button
android:id="@+id/language_two_button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="32dp"
android:layout_marginLeft="32dp"
android:background="@color/mapboxPurpleDark"
android:text="@string/russian"
android:textColor="@color/mapboxWhite" />
<Button
android:id="@+id/language_three_button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="32dp"
android:layout_marginLeft="32dp"
android:background="@color/mapboxGreenDark"
android:text="@string/chinese"
android:textColor="@color/mapboxWhite" />
</LinearLayout>
<com.google.android.material.floatingactionbutton.FloatingActionButton
android:id="@+id/match_map_to_device_language"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="bottom|end"
android:layout_marginEnd="16dp"
android:layout_marginRight="16dp"
android:layout_marginBottom="16dp"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:srcCompat="@drawable/ic_swap_horiz_white_24dp"
mapbox:fabSize="small" />
</FrameLayout>
LocalizationPluginActivity.java
package com.mapbox.mapboxandroiddemo.examples.plugins;
import android.os.Bundle;
import androidx.annotation.NonNull;
import com.google.android.material.snackbar.Snackbar;
import androidx.appcompat.app.AppCompatActivity;
import android.view.View;
import android.widget.Toast;
import com.mapbox.mapboxandroiddemo.R;
import com.mapbox.mapboxsdk.Mapbox;
import com.mapbox.mapboxsdk.camera.CameraPosition;
import com.mapbox.mapboxsdk.camera.CameraUpdateFactory;
import com.mapbox.mapboxsdk.geometry.LatLng;
import com.mapbox.mapboxsdk.maps.MapView;
import com.mapbox.mapboxsdk.maps.MapboxMap;
import com.mapbox.mapboxsdk.maps.OnMapReadyCallback;
import com.mapbox.mapboxsdk.maps.Style;
import com.mapbox.mapboxsdk.plugins.localization.LocalizationPlugin;
import com.mapbox.mapboxsdk.plugins.localization.MapLocale;
/**
* Use the localization plugin to retrieve the device's language and set all map text labels to that language.
*/
public class LocalizationPluginActivity extends AppCompatActivity implements OnMapReadyCallback {
private MapView mapView;
private LocalizationPlugin localizationPlugin;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Mapbox access token is configured here. This needs to be called either in your application
// object or in the same activity which contains the mapview.
Mapbox.getInstance(this, getString(R.string.access_token));
// This contains the MapView in XML and needs to be called after the access token is configured.
setContentView(R.layout.activity_localization_plugin);
mapView = findViewById(R.id.mapView);
mapView.onCreate(savedInstanceState);
mapView.getMapAsync(this);
}
@Override
public void onMapReady(@NonNull final MapboxMap mapboxMap) {
mapboxMap.setStyle(Style.MAPBOX_STREETS, new Style.OnStyleLoaded() {
@Override
public void onStyleLoaded(@NonNull Style style) {
localizationPlugin = new LocalizationPlugin(mapView, mapboxMap, style);
findViewById(R.id.language_one_button).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
localizationPlugin.setMapLanguage(MapLocale.ARABIC);
}
});
findViewById(R.id.language_two_button).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
localizationPlugin.setMapLanguage(MapLocale.RUSSIAN);
}
});
findViewById(R.id.language_three_button).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
localizationPlugin.setMapLanguage(MapLocale.SIMPLIFIED_CHINESE);
}
});
findViewById(R.id.match_map_to_device_language).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
Snackbar.make(view, R.string.change_device_language_instruction, Snackbar.LENGTH_LONG).show();
try {
localizationPlugin.matchMapLanguageWithDeviceDefault();
mapboxMap.animateCamera(CameraUpdateFactory
.newCameraPosition(new CameraPosition.Builder()
.target(new LatLng(34.032666, -80.363160))
.zoom(2.038777)
.build()), 1000);
} catch (RuntimeException exception) {
Snackbar.make(view, exception.toString(), Snackbar.LENGTH_LONG).show();
}
}
});
Toast.makeText(LocalizationPluginActivity.this, R.string.instruction_description,
Toast.LENGTH_LONG).show();
}
});
}
// Add the mapView lifecycle to the activity's lifecycle methods
@Override
public void onResume() {
super.onResume();
mapView.onResume();
}
@Override
protected void onStart() {
super.onStart();
mapView.onStart();
}
@Override
protected void onStop() {
super.onStop();
mapView.onStop();
}
@Override
public void onPause() {
super.onPause();
mapView.onPause();
}
@Override
public void onLowMemory() {
super.onLowMemory();
mapView.onLowMemory();
}
@Override
protected void onDestroy() {
super.onDestroy();
mapView.onDestroy();
}
@Override
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
mapView.onSaveInstanceState(outState);
}
}