CHANGELOG entry + KDocs updates

Author: tomaszrybakiewicz

CHANGELOG.md

@@ -4,6 +4,8 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## Unreleased
 #### Features
+- Added `ViewBinderCustomization.actionCompassButtonBinder`, `ViewBinderCustomization.actionCameraModeButtonBinder`, `ViewBinderCustomization.actionToggleAudioButtonBinder` and `ViewBinderCustomization.actionRecenterButtonBinder` that allows injection of a custom Compass, Camera Mode, Toggle Voice Instructions and Camera Recenter Buttons in `NavigationView`. [#6490](https://github.com/mapbox/mapbox-navigation-android/pull/6490)
+- Introduced `ActionButtonsBinder` base `UIBinder` class, that allows use of a custom action buttons layout with default action buttons in `NavigationView`. [#6490](https://github.com/mapbox/mapbox-navigation-android/pull/6490)
 #### Bug fixes and improvements
 - Improved precision of congestion visualization and independent leg styling transitions, especially for long routes. [#6476](https://github.com/mapbox/mapbox-navigation-android/pull/6476)
 - Fixed an issue with congestion visualization on the route line that occurred during route refreshes. [#6476](https://github.com/mapbox/mapbox-navigation-android/pull/6476)

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/ViewBinderCustomization.kt

@@ -119,28 +119,28 @@ class ViewBinderCustomization {
 
     /**
      * Customize the Compass Action Button by providing your own [UIBinder]
-     * when using [actionButtonsBinder] with [ActionButtonsBinder] implementation.
+     * when using [actionButtonsBinder] with [ActionButtonsBinder.defaultBinder] implementation.
      * Use [UIBinder.USE_DEFAULT] to reset to default.
      */
     var actionCompassButtonBinder: UIBinder? = null
 
     /**
      * Customize the Camera Mode Action Button by providing your own [UIBinder]
-     * when using [actionButtonsBinder] with [ActionButtonsBinder] implementation.
+     * when using [actionButtonsBinder] with [ActionButtonsBinder.defaultBinder] implementation.
      * Use [UIBinder.USE_DEFAULT] to reset to default.
      */
     var actionCameraModeButtonBinder: UIBinder? = null
 
     /**
      * Customize the Toggle Audio Guidance Action Button by providing your own [UIBinder]
-     * when using [actionButtonsBinder] with [ActionButtonsBinder] implementation.
+     * when using [actionButtonsBinder] with [ActionButtonsBinder.defaultBinder] implementation.
      * Use [UIBinder.USE_DEFAULT] to reset to default.
      */
     var actionToggleAudioButtonBinder: UIBinder? = null
 
     /**
      * Customize the Recenter Camera Action Button by providing your own [UIBinder]
-     * when using [actionButtonsBinder] with [ActionButtonsBinder] implementation.
+     * when using [actionButtonsBinder] with [ActionButtonsBinder.defaultBinder] implementation.
      * Use [UIBinder.USE_DEFAULT] to reset to default.
      */
     var actionRecenterButtonBinder: UIBinder? = null

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/actionbutton/ActionButtonsBinder.kt

@@ -35,7 +35,7 @@ abstract class ActionButtonsBinder : UIBinder {
      * @param layoutInflater The LayoutInflater service.
      * @param root Parent view that provides a set of LayoutParams values for root of the returned hierarchy.
      *
-     * @return ViewGroup that can host both header and content layouts.
+     * @return ViewGroup that can host action button layout.
      *   Returned view must not be attached to the root view.
      */
     @UiThread
@@ -183,32 +183,3 @@ abstract class ActionButtonsBinder : UIBinder {
         fun defaultBinder(): ActionButtonsBinder = MapboxActionButtonsBinder()
     }
 }
-
-/**
- * Default Action Buttons Binder implementation.
- */
-@ExperimentalPreviewMapboxNavigationAPI
-internal class MapboxActionButtonsBinder : ActionButtonsBinder() {
-
-    override fun onCreateLayout(layoutInflater: LayoutInflater, root: ViewGroup): ViewGroup =
-        layoutInflater
-            .inflate(R.layout.mapbox_action_buttons_layout, root, false) as ViewGroup
-
-    override fun getCustomButtonsStartContainer(layout: ViewGroup): ViewGroup? =
-        layout.findViewById(R.id.buttonsContainerTop)
-
-    override fun getCompassButtonContainer(layout: ViewGroup): ViewGroup? =
-        layout.findViewById(R.id.buttonsContainerCompass)
-
-    override fun getCameraModeButtonContainer(layout: ViewGroup): ViewGroup? =
-        layout.findViewById(R.id.buttonsContainerCamera)
-
-    override fun getToggleAudioButtonContainer(layout: ViewGroup): ViewGroup? =
-        layout.findViewById(R.id.buttonsContainerAudio)
-
-    override fun getRecenterButtonContainer(layout: ViewGroup): ViewGroup? =
-        layout.findViewById(R.id.buttonsContainerRecenter)
-
-    override fun getCustomButtonsEndContainer(layout: ViewGroup): ViewGroup? =
-        layout.findViewById(R.id.buttonsContainerBottom)
-}

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/actionbutton/MapboxActionButtonsBinder.kt

@@ -0,0 +1,35 @@
+package com.mapbox.navigation.dropin.actionbutton
+
+import android.view.LayoutInflater
+import android.view.ViewGroup
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.dropin.R
+
+/**
+ * Default Action Buttons Binder implementation.
+ */
+@ExperimentalPreviewMapboxNavigationAPI
+internal class MapboxActionButtonsBinder : ActionButtonsBinder() {
+
+    override fun onCreateLayout(layoutInflater: LayoutInflater, root: ViewGroup): ViewGroup =
+        layoutInflater
+            .inflate(R.layout.mapbox_action_buttons_layout, root, false) as ViewGroup
+
+    override fun getCustomButtonsStartContainer(layout: ViewGroup): ViewGroup? =
+        layout.findViewById(R.id.buttonsContainerTop)
+
+    override fun getCompassButtonContainer(layout: ViewGroup): ViewGroup? =
+        layout.findViewById(R.id.buttonsContainerCompass)
+
+    override fun getCameraModeButtonContainer(layout: ViewGroup): ViewGroup? =
+        layout.findViewById(R.id.buttonsContainerCamera)
+
+    override fun getToggleAudioButtonContainer(layout: ViewGroup): ViewGroup? =
+        layout.findViewById(R.id.buttonsContainerAudio)
+
+    override fun getRecenterButtonContainer(layout: ViewGroup): ViewGroup? =
+        layout.findViewById(R.id.buttonsContainerRecenter)
+
+    override fun getCustomButtonsEndContainer(layout: ViewGroup): ViewGroup? =
+        layout.findViewById(R.id.buttonsContainerBottom)
+}