feat(controls): add skip button area and position fields #388

prebid · Apr 7, 2022 · 19cb1af · 19cb1af
1 parent 9c72950
commit 19cb1af
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 28 deletions.
diff --git a/...re/src/main/java/org/prebid/mobile/rendering/bidding/parallel/BaseInterstitialAdUnit.java b/...re/src/main/java/org/prebid/mobile/rendering/bidding/parallel/BaseInterstitialAdUnit.java
@@ -179,6 +179,22 @@ public void setSkipDelay(int secondsDelay) {
         adUnitConfig.setSkipDelay(secondsDelay);
     }
 
+    /**
+     * Sets skip button percentage size in range from 0.05 to 1.
+     * If value less than 0.05, size will be default.
+     */
+    public void setSkipButtonArea(@FloatRange(from = 0, to = 1.0) double buttonArea) {
+        adUnitConfig.setSkipButtonArea(buttonArea);
+    }
+
+    /**
+     * Sets skip button position on the screen. Suitable values TOP_LEFT and TOP_RIGHT.
+     * Default value TOP_RIGHT.
+     */
+    public void setSkipButtonPosition(Position skipButtonPosition) {
+        adUnitConfig.setSkipButtonPosition(skipButtonPosition);
+    }
+
     public void setIsMuted(boolean isMuted) {
         adUnitConfig.setIsMuted(isMuted);
     }

diff --git a/...rebidMobile-core/src/main/java/org/prebid/mobile/rendering/interstitial/AdBaseDialog.java b/...rebidMobile-core/src/main/java/org/prebid/mobile/rendering/interstitial/AdBaseDialog.java
@@ -358,7 +358,8 @@ protected void addSkipView() {
             return;
         }
 
-        mSkipView = Utils.createSkipView(mContextReference.get());
+        InterstitialDisplayPropertiesInternal properties = mInterstitialManager.getInterstitialDisplayProperties();
+        mSkipView = Utils.createSkipView(mContextReference.get(), properties);
 
         if (mSkipView == null) {
             LogUtil.error(TAG, "Unable to add skip button. Skip view is null");

diff --git a/...rc/main/java/org/prebid/mobile/rendering/interstitial/InterstitialLayoutConfigurator.java b/...rc/main/java/org/prebid/mobile/rendering/interstitial/InterstitialLayoutConfigurator.java
@@ -43,5 +43,7 @@ public static void configureDisplayProperties(AdUnitConfiguration adConfiguratio
         displayProperties.closeButtonArea = adConfiguration.getCloseButtonArea();
         displayProperties.closeButtonPosition = adConfiguration.getCloseButtonPosition();
         displayProperties.skipDelay = adConfiguration.getSkipDelay();
+        displayProperties.skipButtonArea = adConfiguration.getSkipButtonArea();
+        displayProperties.skipButtonPosition = adConfiguration.getSkipButtonPosition();
     }
 }
diff --git a/...c/main/java/org/prebid/mobile/rendering/models/InterstitialDisplayPropertiesInternal.java b/...c/main/java/org/prebid/mobile/rendering/models/InterstitialDisplayPropertiesInternal.java
@@ -23,15 +23,17 @@ public class InterstitialDisplayPropertiesInternal extends InterstitialDisplayPr
 
     public int expandWidth;
     public int expandHeight;
-    public double closeButtonArea = 0;
     public int orientation = ActivityInfo.SCREEN_ORIENTATION_PORTRAIT;
     public int skipDelay = 0;
+    public double closeButtonArea = 0;
+    public double skipButtonArea = 0;
 
     public boolean isSoundButtonVisible = false;
     public boolean isMuted = false;
     public boolean isRotationEnabled = false;
 
     public Position closeButtonPosition = Position.TOP_RIGHT;
+    public Position skipButtonPosition = Position.TOP_RIGHT;
 
     public void resetExpandValues() {
         expandHeight = 0;

diff --git a/...bile/PrebidMobile-core/src/main/java/org/prebid/mobile/rendering/utils/helpers/Utils.java b/...bile/PrebidMobile-core/src/main/java/org/prebid/mobile/rendering/utils/helpers/Utils.java
@@ -29,7 +29,9 @@
 import android.view.*;
 import android.webkit.MimeTypeMap;
 import android.widget.FrameLayout;
+import androidx.annotation.LayoutRes;
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import androidx.core.content.ContextCompat;
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -431,61 +433,71 @@ public static Map<String, String> getQueryMap(String query) {
         return map;
     }
 
-    public static View createSkipView(Context context) {
-        if (context == null) {
-            LogUtil.error(TAG, "Unable to create view. Context is null");
-            return null;
-        }
-
-        View view = LayoutInflater.from(context).inflate(R.layout.lyt_skip, null);
-        FrameLayout.LayoutParams params = new FrameLayout.LayoutParams(FrameLayout.LayoutParams.WRAP_CONTENT,
-                FrameLayout.LayoutParams.WRAP_CONTENT
+    public static View createSkipView(
+            Context context,
+            @Nullable InterstitialDisplayPropertiesInternal properties
+    ) {
+        return createButtonToNextPage(context,
+                R.layout.lyt_skip,
+                properties != null ? properties.skipButtonArea : 0,
+                properties != null ? properties.skipButtonPosition : Position.TOP_RIGHT
         );
-        params.gravity = Gravity.END | Gravity.TOP;
-        view.setLayoutParams(params);
-        return view;
     }
 
-    private static final int MIN_BUTTON_SIZE_DP = 30;
-
     public static View createCloseView(Context context) {
         return createCloseView(context, null);
     }
 
     public static View createCloseView(
             Context context,
-            InterstitialDisplayPropertiesInternal properties
+            @Nullable InterstitialDisplayPropertiesInternal properties
+    ) {
+        return createButtonToNextPage(context,
+                R.layout.lyt_close,
+                properties != null ? properties.closeButtonArea : 0,
+                properties != null ? properties.closeButtonPosition : Position.TOP_RIGHT
+        );
+    }
+
+    private static View createButtonToNextPage(
+            @Nullable Context context,
+            @LayoutRes int layoutResId,
+            double buttonArea,
+            @NonNull Position buttonPosition
     ) {
         if (context == null) {
             LogUtil.error(TAG, "Unable to create close view. Context is null");
             return null;
         }
 
-        View closeView = LayoutInflater.from(context).inflate(R.layout.lyt_close, null);
-        FrameLayout.LayoutParams params = calculateButtonSize(closeView, properties);
+        View view = LayoutInflater.from(context).inflate(layoutResId, null);
 
+        FrameLayout.LayoutParams params;
+        params = calculateButtonSize(view, buttonArea);
         params.gravity = Gravity.END | Gravity.TOP;
-        if (properties != null && properties.closeButtonPosition == Position.TOP_LEFT) {
+        if (buttonPosition == Position.TOP_LEFT) {
             params.gravity = Gravity.START | Gravity.TOP;
         }
 
-        closeView.setLayoutParams(params);
-        return closeView;
+        view.setLayoutParams(params);
+        return view;
     }
 
+    private static final int MIN_BUTTON_SIZE_DP = 30;
+
     private static FrameLayout.LayoutParams calculateButtonSize(
             View view,
-            InterstitialDisplayPropertiesInternal properties
+            double closeButtonArea
     ) {
         Context context = view.getContext();
-        if (properties == null || properties.closeButtonArea < 0.05 || properties.closeButtonArea > 1) {
+        if (closeButtonArea < 0.05 || closeButtonArea > 1) {
             return new FrameLayout.LayoutParams(FrameLayout.LayoutParams.WRAP_CONTENT,
                     FrameLayout.LayoutParams.WRAP_CONTENT
             );
         }
 
         int screenSize = getSmallestScreenSideSize(context);
-        int buttonSize = (int) (screenSize * properties.closeButtonArea);
+        int buttonSize = (int) (screenSize * closeButtonArea);
         if (convertPxToDp(buttonSize, context) < MIN_BUTTON_SIZE_DP) {
             buttonSize = convertDpToPx(MIN_BUTTON_SIZE_DP, context);
         }

diff --git a/...dMobile-core/src/main/java/org/prebid/mobile/units/configuration/AdUnitConfiguration.java b/...dMobile-core/src/main/java/org/prebid/mobile/units/configuration/AdUnitConfiguration.java
@@ -30,6 +30,7 @@ public class AdUnitConfiguration {
     private final int broadcastId = Utils.generateRandomInt();
     private float videoInitialVolume = ExoPlayerView.DEFAULT_INITIAL_VIDEO_VOLUME;
     private double closeButtonArea = 0;
+    private double skipButtonArea = 0;
 
     private int maxVideoDuration = 3600;
 
@@ -38,6 +39,7 @@ public class AdUnitConfiguration {
     private String interstitialSize;
 
     private Position closeButtonPosition = Position.TOP_RIGHT;
+    private Position skipButtonPosition = Position.TOP_RIGHT;
     private AdSize minSizePercentage;
     private PlacementType placementType;
     private AdPosition adPosition;
@@ -290,6 +292,25 @@ public int getSkipDelay() {
         return skipDelay;
     }
 
+    public double getSkipButtonArea() {
+        return skipButtonArea;
+    }
+
+    public void setSkipButtonArea(double skipButtonArea) {
+        this.skipButtonArea = skipButtonArea;
+    }
+
+    @NonNull
+    public Position getSkipButtonPosition() {
+        return skipButtonPosition;
+    }
+
+    public void setSkipButtonPosition(@Nullable Position skipButtonPosition) {
+        if (skipButtonPosition != null) {
+            this.skipButtonPosition = skipButtonPosition;
+        }
+    }
+
     @NonNull
     public EnumSet<AdFormat> getAdFormats() {
         return adFormats;
@@ -339,9 +360,7 @@ public String getInterstitialSize() {
 
     public void setCloseButtonPosition(@Nullable Position closeButtonPosition) {
         if (closeButtonPosition != null) {
-            if (closeButtonPosition == Position.TOP_LEFT || closeButtonPosition == Position.TOP_RIGHT) {
-                this.closeButtonPosition = closeButtonPosition;
-            }
+            this.closeButtonPosition = closeButtonPosition;
         }
     }