-
Notifications
You must be signed in to change notification settings - Fork 6k
Use getBoundingRects to add support inset MediaQuery/SafeArea when in freeform mode controls are shown. #54294
Changes from all commits
34a0d12
de75b74
21c6111
7dc6abd
ee464bd
91abf9b
ec13d36
243486c
64f7bac
49475fb
9a428c5
e0d38da
a0a1cbc
87cd394
4cbc7a4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -772,6 +772,15 @@ navigationBarVisible && guessBottomKeyboardInset(insets) == 0 | |
viewportMetrics.viewInsetLeft = 0; | ||
} | ||
|
||
// The caption bar inset is a new addition, and the APIs called to query it utilize a list of | ||
// bounding Rects instead of an Insets object, which is a newer API method, as compared to the | ||
// existing Insets-based method calls above. | ||
if (Build.VERSION.SDK_INT >= API_LEVELS.API_35) { | ||
delegate.growViewportMetricsToCaptionBar(getContext(), viewportMetrics); | ||
} else { | ||
Log.w(TAG, "API level " + Build.VERSION.SDK_INT + " is too low to query bounding rects."); | ||
} | ||
|
||
Log.v( | ||
TAG, | ||
"Updating window insets (onApplyWindowInsets()):\n" | ||
|
@@ -1449,6 +1458,13 @@ public void removeFlutterEngineAttachmentListener( | |
.send(); | ||
} | ||
|
||
private FlutterViewDelegate delegate = new FlutterViewDelegate(); | ||
|
||
@VisibleForTesting | ||
public void setDelegate(@NonNull FlutterViewDelegate delegate) { | ||
this.delegate = delegate; | ||
} | ||
|
||
private void sendViewportMetricsToFlutter() { | ||
reidbaker marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looking at the design of this class I am seeing a pattern of the flutterView having methods that trigger on different android lifecycle events, Then ViewportMetrics being updated then at the end of that triggering method calling Looking at this code we do the calculation every send. When I was searching internally I did not find documentation of a lifecycle method to trigger on so maybe this is moot. If this code moved to onApplyWindowInsets would it still work? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just tested this, and it looks good. I've moved it to |
||
if (!isAttachedToFlutterEngine()) { | ||
Log.w( | ||
|
@@ -1460,6 +1476,7 @@ private void sendViewportMetricsToFlutter() { | |
|
||
viewportMetrics.devicePixelRatio = getResources().getDisplayMetrics().density; | ||
viewportMetrics.physicalTouchSlop = ViewConfiguration.get(getContext()).getScaledTouchSlop(); | ||
|
||
reidbaker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
flutterEngine.getRenderer().setViewportMetrics(viewportMetrics); | ||
} | ||
|
||
|
@@ -1485,6 +1502,15 @@ public void setVisibility(int visibility) { | |
} | ||
} | ||
|
||
/** | ||
* Allow access to the viewport metrics so that tests can set them to be valid with nonzero | ||
* dimensions. | ||
*/ | ||
@VisibleForTesting | ||
public FlutterRenderer.ViewportMetrics getViewportMetrics() { | ||
return viewportMetrics; | ||
} | ||
|
||
/** | ||
* Listener that is notified when a {@link io.flutter.embedding.engine.FlutterEngine} is attached | ||
* to/detached from a given {@code FlutterView}. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
package io.flutter.embedding.android; | ||
|
||
import android.app.Activity; | ||
import android.content.Context; | ||
import android.graphics.Rect; | ||
import android.view.Window; | ||
import android.view.WindowInsets; | ||
import androidx.annotation.RequiresApi; | ||
import androidx.annotation.VisibleForTesting; | ||
import io.flutter.Build; | ||
import io.flutter.embedding.engine.renderer.FlutterRenderer; | ||
import io.flutter.util.ViewUtils; | ||
import java.util.Collections; | ||
import java.util.List; | ||
|
||
/** | ||
* A delegate class that performs the task of retrieving the bounding rect values. Logic that is | ||
* independent of the engine, or that tests must access in the absence of an engine, shall reside | ||
* within this class. | ||
*/ | ||
public class FlutterViewDelegate { | ||
/** | ||
* Return the WindowInsets object for the provided Context. A Context will only have a window if | ||
* it is an instance of Activity. If context does not have a window, or it is not an activity, | ||
* this method will return null. Otherwise, this method will return the WindowInsets for the | ||
* provided activity's window. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great documentation |
||
*/ | ||
@RequiresApi(api = Build.API_LEVELS.API_23) | ||
@VisibleForTesting | ||
public WindowInsets getWindowInsets(Context context) { | ||
Activity activity = ViewUtils.getActivity(context); | ||
if (activity == null) { | ||
return null; | ||
} | ||
Window window = activity.getWindow(); | ||
if (window == null) { | ||
return null; | ||
} | ||
return window.getDecorView().getRootWindowInsets(); | ||
} | ||
|
||
@RequiresApi(api = Build.API_LEVELS.API_35) | ||
reidbaker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
public List<Rect> getCaptionBarInsets(Context context) { | ||
WindowInsets insets = getWindowInsets(context); | ||
reidbaker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (insets == null) { | ||
return Collections.emptyList(); | ||
} | ||
return insets.getBoundingRects(WindowInsets.Type.captionBar()); | ||
} | ||
|
||
@RequiresApi(api = Build.API_LEVELS.API_35) | ||
public void growViewportMetricsToCaptionBar( | ||
Context context, FlutterRenderer.ViewportMetrics viewportMetrics) { | ||
List<Rect> boundingRects = getCaptionBarInsets(context); | ||
int viewPaddingTop = viewportMetrics.viewPaddingTop; | ||
for (Rect rect : boundingRects) { | ||
viewPaddingTop = Math.max(viewPaddingTop, rect.bottom); | ||
} | ||
// The value getCaptionBarInset returns is only the bounding rects of the caption bar. | ||
// When assigning the new value of viewPaddingTop, the maximum is taken with its old value | ||
// to ensure that any previous top padding that is greater than that from the caption bar | ||
// is not destroyed by this operation. | ||
// Any potential update that will allow the caption bar to be positioned somewhere other than | ||
// the top of the app window will require that this method be rewritten. | ||
viewportMetrics.viewPaddingTop = viewPaddingTop; | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Digging into go/customizable-window-headers I found APPEARANCE_TRANSPARENT_CAPTION_BAR_BACKGROUND Can you test an app with that flag set vs the default and come up with a recommendation on if we should apply transparent caption bar by default or not?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This comment should not be considered blocking.