WIP: (android) Remember statusbar color during overlay state changes #172

breautek · 2019-11-15T04:49:57Z

Platforms affected

Android

Motivation and Context

Statusbar would override background color to set transparent on overlaysWebView(true) and therefore overlaysWebView(false) will make the statusbar turn black.

This PR keeps track of the background color, in both states so that
Fixes #159

Description

Two variables were added to keep the background color in memory, one for the solid statusbar and another for overlayed statusbar.

Calling on backgroundColorByHexString will determine if the statusbar is overlayed and will update the respective variables.

setStatusBarTransparent has been changed so that it now doesn't hard code the statusbar colour and instead will use the variables to change the statusbar color.

By default, the overlay background color defaults to #00000000 (in otherwords, fully transparent). This makes it so, calling on overlaysWebview(true) will hide the statusbar, as it always did before. The overlay background color can be set by supplying a #AARRGGBB hex format to StatusBarBackgroundColor preference.

Testing

npm test and manual testing.

Checklist

I've run the tests to see all new and existing tests pass
I added automated test coverage as appropriate for this change
Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
I've updated the documentation if necessary

…ay state changes

timbru31

I've got some minor change requests. :)

timbru31 · 2019-12-11T19:36:20Z

src/android/StatusBar.java

@@ -38,6 +38,8 @@

 public class StatusBar extends CordovaPlugin {
    private static final String TAG = "StatusBar";
+    private String _bgColor;


IMO these variables should not begin with an underscore

My habits leaked into the PR, even though it's not consistent with Apache's codebase 😁

I'll remove the underscores when I come back to this task.

timbru31 · 2019-12-11T19:37:01Z

src/android/StatusBar.java

@@ -54,13 +56,30 @@ public void initialize(final CordovaInterface cordova, CordovaWebView webView) {
        this.cordova.getActivity().runOnUiThread(new Runnable() {
            @Override
            public void run() {
+
                // Clear flag FLAG_FORCE_NOT_FULLSCREEN which is set initially
                // by the Cordova.
                Window window = cordova.getActivity().getWindow();
                window.clearFlags(WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN);

                // Read 'StatusBarBackgroundColor' from config.xml, default is #000000.


Not your code, but this comment is useless and could be removed.

timbru31 · 2019-12-11T19:37:54Z

src/android/StatusBar.java

+                _bgColor = preferences.getString("StatusBarBackgroundColor", "#000000");
+                setStatusBarBackgroundColor(_bgColor);
+
+                int color;


This could be moved to the try block?

timbru31 · 2019-12-11T19:38:24Z

src/android/StatusBar.java

+                } catch (IllegalArgumentException e) {
+                    LOG.w(TAG, "Invalid color " + _bgColor + ". Defaulting to #00000000.");
+                    _overlayBgColor = "#00000000";
+                }

                // Read 'StatusBarStyle' from config.xml, default is 'lightcontent'.


Same as above with the comment ;)

timbru31 · 2019-12-11T19:38:39Z

src/android/StatusBar.java

+                } else {
+                    _bgColor = colorPref;
+                }
+


pls remove one newline

timbru31 · 2019-12-11T19:42:16Z

src/android/StatusBar.java

+
+                // This is so that we can return to the last set statusbar colours if overlay state changes.
+                int uiOptions = window.getDecorView().getSystemUiVisibility();
+                boolean isOverlayed = ((uiOptions | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN) == uiOptions);


Do we need to take SYSTEM_UI_FLAG_LAYOUT_STABLE into account, too, or is SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN enough?

I think that SYSTEM_UI_FLAG_LAYOUT_STABLE will help a lot. In our code, we've delayed the rendering of the map for a harcoded time of 160ms (10 frames at 60fps), just to get around this issue. If we don't add that delay, the map will be resized immediately after it finishes rendering for the first time, and it doesn't look good.

And I think that this method should have a different name, It's name is a bit misleading; You can see that it's used for the overlaysWebView action, but it's name doesn't suggest anything on those lines.

if ("overlaysWebView".equals(action)) { // ... }

I'll try the SYSTEM_UI_FLAG_LAYOUT_STABLE, however it is now deprecated... along with the other system ui flag constants. But it looks like the replacement is only going to be available in the API 30 (unreleased, under API R), soooo we will have no choice but to continue using them for the next foreseeable future.

In our code, we've delayed the rendering of the map for a harcoded time of 160ms (10 frames at 60fps), just to get around this issue. If we don't add that delay, the map will be resized immediately after it finishes rendering for the first time, and it doesn't look good.

Makes me wonder if this will correct #158 ...

timbru31 · 2021-01-08T16:19:33Z

Ping @breautek any chance you want to "re-visit" this PR? :)

breautek · 2021-01-08T16:54:42Z

Ping @breautek any chance you want to "re-visit" this PR? :)

Want to... yes

Will have I the time to... that might be a different story...

Is this potentially blocking something?

timbru31 · 2021-01-08T17:56:49Z

Nope, I was just going through open issues and PRs and Niklas added the 3.0 milestone some time ago.

(android) Background color tracking to remember bg color during overl…

a015b55

…ay state changes

breautek requested a review from timbru31 November 15, 2019 04:50

timbru31 requested changes Dec 11, 2019

View reviewed changes

NiklasMerz added this to the 3.0 milestone Mar 23, 2020

breautek changed the title ~~(android) Remember statusbar color during overlay state changes~~ WIP: (android) Remember statusbar color during overlay state changes May 11, 2020

SchnWalter mentioned this pull request May 11, 2020

[Android] overlaysWebView(true) doesn't work as expected when called in deviceready event #158

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: (android) Remember statusbar color during overlay state changes #172

WIP: (android) Remember statusbar color during overlay state changes #172

breautek commented Nov 15, 2019

timbru31 left a comment

timbru31 Dec 11, 2019

breautek May 11, 2020

timbru31 Dec 11, 2019

timbru31 Dec 11, 2019

timbru31 Dec 11, 2019

timbru31 Dec 11, 2019

timbru31 Dec 11, 2019

SchnWalter May 11, 2020

SchnWalter May 11, 2020

breautek May 11, 2020

timbru31 commented Jan 8, 2021

breautek commented Jan 8, 2021

timbru31 commented Jan 8, 2021

WIP: (android) Remember statusbar color during overlay state changes #172

Are you sure you want to change the base?

WIP: (android) Remember statusbar color during overlay state changes #172

Conversation

breautek commented Nov 15, 2019

Platforms affected

Motivation and Context

Description

Testing

Checklist

timbru31 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timbru31 commented Jan 8, 2021

breautek commented Jan 8, 2021

timbru31 commented Jan 8, 2021