fix(android): Always display HTML banner when suggestions aren't available

android/KMAPro/kMAPro/src/main/assets/banner.html

@@ -0,0 +1,11 @@
+<!-- Custom banner theme -->
+<div style="background: white; width: 100%; height: 100%; position: absolute; left: 0; top: 0; display: flex">
+
+  <!-- svg path is relative to assets/ folder -->
+  <img src="banner/keyman_banner.svg" style="height:60%; background: white; display: block; margin: auto 2%;">
+
+  <!-- Tri-color line -->
+  <div style='height: 7%; left: 0; position: absolute; bottom: 0; width: 56%; background: #F68924'></div>
+  <div style='height: 7%; left: 56%; position: absolute; bottom: 0; width: 23%; background: #CC3846'></div>
+  <div style='height: 7%; left: 79%; position: absolute; bottom: 0; width: 21%; background: #79C3DA'></div>
+</div>

android/KMAPro/kMAPro/src/main/java/com/keyman/android/BannerController.java

@@ -0,0 +1,29 @@
+package com.keyman.android;
+
+import android.content.Context;
+
+import com.keyman.engine.KMManager;
+import com.keyman.engine.util.FileUtils;
+
+import java.io.File;
+
+public class BannerController {
+
+  // Paths relative to assets folder for banner themes
+  public static final String KM_BANNER_DIR = "banner";
+  public static final String KM_BANNER_THEME_KEYMAN = "banner.html";
+
+  public static void setHTMLBanner(Context context, KMManager.KeyboardType keyboardType) {
+    if (keyboardType == KMManager.KeyboardType.KEYBOARD_TYPE_UNDEFINED) {
+      return;
+    }
+
+    KMManager.copyHTMLBannerAssets(context, KM_BANNER_DIR);
+
+    // Always use Keyman banner theme
+    String contents = FileUtils.readContents(context, KM_BANNER_THEME_KEYMAN);
+    KMManager.setHTMLBanner(keyboardType, contents);
+    KMManager.setBanner(keyboardType, KMManager.BannerType.HTML);
+    KMManager.showBanner(true);
+  }
+}

android/KMAPro/kMAPro/src/main/java/com/keyman/android/SystemKeyboard.java

@@ -6,6 +6,7 @@
 
 import com.tavultesoft.kmapro.BuildConfig;
 import com.tavultesoft.kmapro.KeymanSettingsActivity;
+import com.keyman.android.BannerController;
 import com.keyman.engine.KMManager;
 import com.keyman.engine.KMManager.KeyboardType;
 import com.keyman.engine.KMHardwareKeyboardInterpreter;
@@ -71,6 +72,9 @@ public void onCreate() {
     KMManager.SpacebarText spacebarText = KMManager.SpacebarText.fromString(prefs.getString(KeymanSettingsActivity.spacebarTextKey, KMManager.SpacebarText.LANGUAGE_KEYBOARD.toString()));
     KMManager.setSpacebarText(spacebarText);
 
+    // Set the system keyboard HTML banner
+    BannerController.setHTMLBanner(this, KeyboardType.KEYBOARD_TYPE_SYSTEM);
+
     boolean mayHaveHapticFeedback = prefs.getBoolean(KeymanSettingsActivity.hapticFeedbackKey, false);
     KMManager.setHapticFeedback(mayHaveHapticFeedback);
 
@@ -93,6 +97,9 @@ public void onDestroy() {
   @Override
   public void onInitializeInterface() {
     super.onInitializeInterface();
+
+    // KeymanWeb reloaded, so we have to pass the banner again
+    BannerController.setHTMLBanner(this, KeyboardType.KEYBOARD_TYPE_SYSTEM);
   }
 
   /**

android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/MainActivity.java

@@ -18,6 +18,7 @@
 import java.util.Map;
 
 import com.keyman.android.CheckInstallReferrer;
+import com.keyman.android.BannerController;
 import com.keyman.engine.BaseActivity;
 import com.keyman.engine.KMHelpFileActivity;
 import com.keyman.engine.KMKeyboardDownloaderActivity;
@@ -499,6 +500,8 @@ public void onKeyboardChanged(String newKeyboard) {
 
   @Override
   public void onKeyboardShown() {
+    // Refresh banner theme
+    BannerController.setHTMLBanner(this, KeyboardType.KEYBOARD_TYPE_INAPP);
     resizeTextView(true);
   }
 

android/KMEA/app/src/main/assets/android-host.js

@@ -8,6 +8,9 @@ if(window.parent && window.parent.jsInterface && !window.jsInterface) {
 var device = window.jsInterface.getDeviceType();
 var oskHeight = Math.ceil(window.jsInterface.getKeyboardHeight() / window.devicePixelRatio);
 var oskWidth = 0;
+var bannerHeight = 0;
+var bannerImagePath = '';
+var bannerHTMLContents = '';
 var fragmentToggle = 0;
 
 var sentryManager = new KeymanSentryManager({
@@ -37,11 +40,13 @@ function init() {
     oninserttext: insertText,
     root:'./'
   }).then(function () {  // Note:  For non-upgraded API 21, arrow functions will break the keyboard!
-    const bannerHeight = Math.ceil(window.jsInterface.getDefaultBannerHeight() / window.devicePixelRatio);
+    bannerHeight = Math.ceil(window.jsInterface.getDefaultBannerHeight() / window.devicePixelRatio);
+    if (bannerHeight > 0) {
 
-    // The OSK is not available until initialization is complete.
-    keyman.osk.bannerView.activeBannerHeight = bannerHeight;
-    keyman.refreshOskLayout();
+      // The OSK is not available until initialization is complete.
+      keyman.osk.bannerView.activeBannerHeight = bannerHeight;
+      keyman.refreshOskLayout();
+    }
   });
 
   keyman.addEventListener('keyboardloaded', setIsChiral);
@@ -53,6 +58,29 @@ function init() {
   notifyHost('pageLoaded');
 }
 
+function showBanner(flag) {
+  console_debug("Setting banner display for dictionaryless keyboards to " + flag);
+  console_debug("bannerHTMLContents: " + bannerHTMLContents);
+  var bc = keyman.osk.bannerController;
+  if (bc) {
+    if (bannerHTMLContents != '') {
+      bc.inactiveBanner = flag ? new bc.HTMLBanner(bannerHTMLContents) : null;
+    } else {
+      bc.inactiveBanner = flag ? new bc.ImageBanner(bannerImagePath) : null;
+    }
+  }
+}
+
+function setBannerImage(path) {
+  bannerImagePath = path;
+}
+
+// Set the HTML banner to use when predictive-text is not available
+// contents - HTML content to use for the banner
+function setBannerHTML(contents) {
+  bannerHTMLContents = contents;
+}
+
 function notifyHost(event, params) {
   console_debug('notifyHost(event='+event+',params='+params+')');
   // TODO: Update all other host notifications to use notifyHost instead of directly setting window.location.hash
@@ -65,12 +93,19 @@ function notifyHost(event, params) {
 }
 
 // Update the KMW banner height
+// h is in dpi (different from iOS)
 function setBannerHeight(h) {
   if (h > 0) {
-    var osk = keyman.osk;
-    osk.banner.height = Math.ceil(h / window.devicePixelRatio);
+    // The banner itself may not be loaded yet.  This will preemptively help set
+    // its eventual display height.
+    bannerHeight = Math.ceil(h / window.devicePixelRatio);
+
+    if (keyman.osk) {
+      keyman.osk.bannerView.activeBannerHeight = bannerHeight;
+    }  
   }
-  // Refresh KMW OSK
+
+  // Refresh KMW's OSK
   keyman.refreshOskLayout();
 }
 

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboard.java

@@ -7,13 +7,11 @@
 import java.io.File;
 import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.List;
 
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
 
-import com.keyman.engine.BaseActivity;
 import com.keyman.engine.data.Keyboard;
 import com.keyman.engine.data.KeyboardController;
 import com.keyman.engine.KMManager.KeyboardType;
@@ -25,19 +23,11 @@
 import com.keyman.engine.util.KMLog;
 import com.keyman.engine.util.KMString;
 
-import android.Manifest;
 import android.annotation.SuppressLint;
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.content.pm.ApplicationInfo;
-import android.content.pm.PackageManager;
 import android.content.res.Configuration;
-import android.graphics.Color;
-import android.graphics.Rect;
-import android.graphics.RectF;
-import android.graphics.Typeface;
-import android.os.Build;
-import android.os.Bundle;
 import android.os.Handler;
 import android.util.DisplayMetrics;
 import android.util.Log;
@@ -46,7 +36,6 @@
 import android.view.LayoutInflater;
 import android.view.MotionEvent;
 import android.view.View;
-import android.view.ViewGroup;
 import android.view.WindowManager;
 import android.view.inputmethod.ExtractedText;
 import android.view.inputmethod.ExtractedTextRequest;
@@ -56,12 +45,9 @@
 import android.webkit.WebSettings;
 import android.webkit.WebView;
 import android.widget.Button;
-import android.widget.FrameLayout;
-import android.widget.GridLayout;
 import android.widget.PopupWindow;
 import android.widget.PopupWindow.OnDismissListener;
 import android.widget.RelativeLayout;
-import android.widget.TextView;
 import android.widget.Toast;
 
 import io.sentry.Breadcrumb;
@@ -84,19 +70,10 @@ final class KMKeyboard extends WebView {
 
   private static String currentKeyboard = null;
 
-  /**
-   * Banner state value: "blank" - no banner available.
-   */
-  protected static final String KM_BANNER_STATE_BLANK = "blank";
-  /**
-   * Banner state value: "suggestion" - dictionary suggestions are shown.
-   */
-  protected static final String KM_BANNER_STATE_SUGGESTION = "suggestion";
-
   /**
    * Current banner state.
    */
-  protected static String currentBanner = KM_BANNER_STATE_BLANK;
+  protected static KMManager.BannerType currentBanner = KMManager.BannerType.HTML;
 
   private static String txtFont = "";
   private static String oskFont = null;
@@ -105,6 +82,10 @@ final class KMKeyboard extends WebView {
   private GestureDetector gestureDetector;
   private static ArrayList<OnKeyboardEventListener> kbEventListeners = null;
 
+  // Stores the current html string for use by the Banner
+  // when predictive text is not active
+  protected String htmlBannerString = "";
+
   // Facilitates a 'lazy init' - we'll only check the preference when it matters,
   // rather than at construction time.
   private Boolean _shouldShowHelpBubble = null;
@@ -400,6 +381,9 @@ public void onConfigurationChanged(Configuration newConfig) {
 
     int bannerHeight = KMManager.getBannerHeight(context);
     int oskHeight = KMManager.getKeyboardHeight(context);
+    if (this.htmlBannerString != null && !this.htmlBannerString.isEmpty()) {
+      setHTMLBanner(this.htmlBannerString);
+    }
     loadJavascript(KMString.format("setBannerHeight(%d)", bannerHeight));
     loadJavascript(KMString.format("setOskWidth(%d)", newConfig.screenWidthDp));
     loadJavascript(KMString.format("setOskHeight(%d)", oskHeight));
@@ -425,22 +409,15 @@ public static String currentKeyboard() {
     return currentKeyboard;
   }
 
-  public static void setCurrentBanner(String banner) {
-    currentBanner = banner;
-  }
-
-  public static String currentBanner() { return currentBanner; }
-
   protected void toggleSuggestionBanner(HashMap<String, String> associatedLexicalModel, boolean keyboardChanged) {
     //reset banner state if new language has no lexical model
-    if (currentBanner != null && currentBanner.equals(KM_BANNER_STATE_SUGGESTION)
+    if (currentBanner == KMManager.BannerType.SUGGESTION
         && associatedLexicalModel == null) {
-      setCurrentBanner(KMKeyboard.KM_BANNER_STATE_BLANK);
+      currentBanner = KMManager.BannerType.HTML;
     }
 
-    if(keyboardChanged) {
-      setLayoutParams(KMManager.getKeyboardLayoutParams());
-    }
+    showBanner(true);
+    // Since there's always a banner, no need to update setLayoutParams()
   }
 
   /**
@@ -653,6 +630,30 @@ public boolean setKeyboard(String packageID, String keyboardID, String languageI
     return retVal;
   }
 
+  public void showBanner(boolean flag) {
+    String jsString = KMString.format("showBanner(%b)", flag);
+    loadJavascript(jsString);
+  }
+
+  public KMManager.BannerType getBanner() {
+    return currentBanner;
+  }
+
+  public void setBanner(KMManager.BannerType bannerType) {
+    currentBanner = bannerType;
+  }
+
+  public String getHTMLBanner() {
+    return this.htmlBannerString;
+  }
+
+  public void setHTMLBanner(String contents) {
+    this.htmlBannerString = contents;
+    String jsString = KMString.format("setBannerHTML(%s)",
+      JSONObject.quote(this.htmlBannerString));
+    loadJavascript(jsString);
+  }
+
   public void setChirality(boolean flag) {
     this.isChiral = flag;
   }

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboardWebViewClient.java

@@ -173,8 +173,7 @@ public boolean shouldOverrideUrlLoading(WebView view, String url) {
       if (KMManager.currentLexicalModel != null) {
         modelPredictionPref = prefs.getBoolean(KMManager.getLanguagePredictionPreferenceKey(KMManager.currentLexicalModel.get(KMManager.KMKey_LanguageID)), true);
       }
-      kmKeyboard.setCurrentBanner((isModelActive && modelPredictionPref) ?
-        KMKeyboard.KM_BANNER_STATE_SUGGESTION : KMKeyboard.KM_BANNER_STATE_BLANK);
+      KMManager.setBannerOptions(isModelActive && modelPredictionPref);
       RelativeLayout.LayoutParams params = KMManager.getKeyboardLayoutParams();
       kmKeyboard.setLayoutParams(params);
     } else if (url.indexOf("suggestPopup") >= 0) {