Add dialog customizer to allow window flags (#440)

Author: hborisoff

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/DialogCustomizer.java

@@ -0,0 +1,59 @@
+package com.leanplum.messagetemplates;
+
+import android.app.Dialog;
+import android.view.View;
+
+/**
+ * Interface that provides access to the view and dialog objects of the main templates before
+ * drawing them. Called just before
+ * {@link Dialog#setContentView(android.view.View, android.view.ViewGroup.LayoutParams)}.
+ *
+ * You can use it to change window flags.
+ */
+public interface DialogCustomizer {
+
+  /**
+   * Customize "Center Popup" template.
+   *
+   * @param messageDialog Dialog container of this message
+   * @param messageContent Content view of the Dialog object
+   */
+  default void customizeCenterPopup(Dialog messageDialog, View messageContent) {
+  }
+
+  /**
+   * Customize "Interstitial" template.
+   *
+   * @param messageDialog Dialog container of this message
+   * @param messageContent Content view of the Dialog object
+   */
+  default void customizeInterstitial(Dialog messageDialog, View messageContent) {
+  }
+
+  /**
+   * Customize "Web Interstitial" template.
+   *
+   * @param messageDialog Dialog container of this message
+   * @param messageContent Content view of the Dialog object
+   */
+  default void customizeWebInterstitial(Dialog messageDialog, View messageContent) {
+  }
+
+  /**
+   * Customize "Rich Interstitial" template.
+   *
+   * @param messageDialog Dialog container of this message
+   * @param messageContent Content view of the Dialog object
+   */
+  default void customizeRichInterstitial(Dialog messageDialog, View messageContent) {
+  }
+
+  /**
+   * Customize "Banner" template.
+   *
+   * @param messageDialog Dialog container of this message
+   * @param messageContent Content view of the Dialog object
+   */
+  default void customizeBanner(Dialog messageDialog, View messageContent) {
+  }
+}

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/MessageTemplates.java

@@ -23,6 +23,7 @@
 
 import android.content.Context;
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import com.leanplum.ActionArgs;
 import com.leanplum.ActionContext;
 import com.leanplum.Leanplum;
@@ -46,6 +47,7 @@
 public class MessageTemplates {
 
   private static boolean registered = false;
+  private static DialogCustomizer customizer;
 
   private static ActionCallback createCallback(@NonNull MessageTemplate template) {
     return new ActionCallback() {
@@ -85,6 +87,26 @@ public void run() {
     };
   }
 
+  /**
+   * Registers customizer to use when creating the message templates.
+   * Call this method before Leanplum.start.
+   *
+   * @param customizer Dialog customizer
+   */
+  public static void setCustomizer(DialogCustomizer customizer) {
+    MessageTemplates.customizer = customizer;
+  }
+
+  /**
+   * Returns the registered customizer.
+   *
+   * @return Dialog customizer
+   */
+  @Nullable
+  public static DialogCustomizer getCustomizer() {
+    return customizer;
+  }
+
   /**
    * Registers a message template to respond to a given action.
    * Will be shown in the templates group in Dashboard.

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/BaseController.java

@@ -24,13 +24,17 @@
 import android.app.Activity;
 import android.app.Dialog;
 import android.graphics.Color;
+import android.os.Build;
 import android.view.View;
 import android.view.ViewGroup.LayoutParams;
+import android.view.WindowManager;
 import android.view.animation.Animation;
 import android.widget.RelativeLayout;
 
 import androidx.annotation.VisibleForTesting;
 import com.leanplum.core.R;
+import com.leanplum.messagetemplates.DialogCustomizer;
+import com.leanplum.messagetemplates.MessageTemplates;
 import com.leanplum.utils.SizeUtil;
 import com.leanplum.views.CloseButton;
 import com.leanplum.views.ViewUtils;
@@ -62,11 +66,12 @@ protected void init() {
       CloseButton closeButton = createCloseButton(messageView);
       contentView.addView(closeButton);
     }
+
+    applyWindowDecoration();
+
     setContentView(contentView, contentView.getLayoutParams());
 
     contentView.setAnimation(ViewUtils.createFadeInAnimation(350));
-
-    applyWindowDecoration();
   }
 
   private RelativeLayout createContentView() {

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/CenterPopupController.java

@@ -27,6 +27,8 @@
 import android.view.Window;
 import android.view.WindowManager;
 import android.widget.RelativeLayout;
+import com.leanplum.messagetemplates.DialogCustomizer;
+import com.leanplum.messagetemplates.MessageTemplates;
 import com.leanplum.messagetemplates.options.CenterPopupOptions;
 import com.leanplum.utils.SizeUtil;
 
@@ -56,6 +58,10 @@ protected void applyWindowDecoration() {
     if (Build.VERSION.SDK_INT >= 14) {
       window.setDimAmount(0.7f);
     }
+    DialogCustomizer customizer = MessageTemplates.getCustomizer();
+    if (customizer != null) {
+      customizer.customizeCenterPopup(this, contentView);
+    }
   }
 
   @Override

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/InterstitialController.java

@@ -24,6 +24,8 @@
 import android.app.Activity;
 import android.view.ViewGroup.LayoutParams;
 import android.widget.RelativeLayout;
+import com.leanplum.messagetemplates.DialogCustomizer;
+import com.leanplum.messagetemplates.MessageTemplates;
 import com.leanplum.messagetemplates.options.InterstitialOptions;
 
 /**
@@ -44,7 +46,10 @@ boolean isFullscreen() {
 
   @Override
   void applyWindowDecoration() {
-    // no implementation
+    DialogCustomizer customizer = MessageTemplates.getCustomizer();
+    if (customizer != null) {
+      customizer.customizeInterstitial(this, contentView);
+    }
   }
 
   @Override

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/RichHtmlController.java

@@ -43,6 +43,8 @@
 import androidx.annotation.NonNull;
 import com.leanplum.ActionContext;
 import com.leanplum.Leanplum;
+import com.leanplum.messagetemplates.DialogCustomizer;
+import com.leanplum.messagetemplates.MessageTemplates;
 import com.leanplum.messagetemplates.options.RichHtmlOptions;
 import com.leanplum.utils.SizeUtil;
 import java.io.UnsupportedEncodingException;
@@ -116,6 +118,16 @@ protected void applyWindowDecoration() {
         contentView.setGravity(Gravity.BOTTOM);
       }
     }
+
+    DialogCustomizer customizer = MessageTemplates.getCustomizer();
+    if (customizer != null) {
+      if (richOptions.isBanner()) {
+        customizer.customizeBanner(this, contentView);
+      } else {
+        customizer.customizeRichInterstitial(this, contentView);
+      }
+    }
+
   }
 
   @Override

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/WebInterstitialController.java

@@ -32,6 +32,8 @@
 import android.widget.RelativeLayout;
 import androidx.annotation.NonNull;
 import com.leanplum.Leanplum;
+import com.leanplum.messagetemplates.DialogCustomizer;
+import com.leanplum.messagetemplates.MessageTemplates;
 import com.leanplum.messagetemplates.options.WebInterstitialOptions;
 
 /**
@@ -61,7 +63,10 @@ boolean isFullscreen() {
 
   @Override
   void applyWindowDecoration() {
-    // no implementation
+    DialogCustomizer customizer = MessageTemplates.getCustomizer();
+    if (customizer != null) {
+      customizer.customizeWebInterstitial(this, contentView);
+    }
   }
 
   @Override

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/options/RichHtmlOptions.java

@@ -356,6 +356,11 @@ public static class Size {
     public String type;
   }
 
+  public boolean isBanner() {
+    String templateName = getActionContext().getArgs().get(Values.HTML_TEMPLATE_PREFIX).toString();
+    return templateName.toLowerCase().contains("banner");
+  }
+
   /**
    * Banners with property TabOutsideToClose = false need to be treated differently
    * so they do not block interaction with other dialogs and the keyboard.