Skip to content

Commit

Permalink
Merge pull request unoplatform#11605 from unoplatform/dev/xygu/202303…
Browse files Browse the repository at this point in the history 
…03/droid-kb-hides-tbox
  • Loading branch information
@Xiaoy312
Xiaoy312 authored Mar 14, 2023
2 parents db7fe6f + 1ac3abd commit 560a449
Show file tree
Hide file tree
Showing 3 changed files with 173 additions and 4 deletions.
151 changes: 150 additions & 1 deletion src/Uno.UI.RuntimeTests/Tests/Windows_UI_Xaml_Controls/Given_ScrollViewer.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@
using System.Threading.Tasks;
using FluentAssertions;
using FluentAssertions.Execution;
using Windows.Foundation;
using Windows.UI;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Shapes;
using Windows.Foundation;
using Windows.UI.ViewManagement;
using static Private.Infrastructure.TestServices;
using Uno.Disposables;

namespace Uno.UI.RuntimeTests.Tests.Windows_UI_Xaml_Controls
{
Expand Down Expand Up @@ -432,5 +434,152 @@ public async Task When_Nested_Scroll_BringIntoView()
Assert.AreEqual(0, outerScrollViewer.HorizontalOffset);
Assert.AreEqual(320, outerScrollViewer.VerticalOffset);
}

#if __ANDROID__
[TestMethod]
[RunsOnUIThread]
[RequiresFullWindow]
public async Task When_NonNested_BringIntoView()
{
if (ContextHelper.Current is not Android.App.Activity activity)
{
Assert.Inconclusive("The current android activity is not accessible.");
return;
}

// set AdjustNothing mode and prepare for cleanup
var oldMode = activity.Window.Attributes.SoftInputMode;
activity.Window.SetSoftInputMode(oldMode & ~Android.Views.SoftInput.MaskAdjust | Android.Views.SoftInput.AdjustNothing);
using var cleanup = Disposable.Create(() => activity.Window.SetSoftInputMode(oldMode));

// load a tmp textbox to ...
var tmpTextbox = new TextBox();
WindowHelper.WindowContent = tmpTextbox;
await WindowHelper.WaitForLoaded(tmpTextbox);
await WindowHelper.WaitForIdle();
tmpTextbox.Focus(FocusState.Programmatic);

// ... measure keyboard height
var kb = InputPane.GetForCurrentView();
await WindowHelper.WaitFor(() => kb.Visible, message: "Failed to summon keyboard via Focus(FocusState.Programmatic).");
await WindowHelper.WaitFor(() => kb.OccludedRect.Height > 0, message: "Failed to summon keyboard via Focus(FocusState.Programmatic).");
var kbHeight = kb.OccludedRect.Height;
kb.Visible = false;

// load actual test setup
// ScrollViewer's viewport is set to be 50px taller than the keyboard.
// There is a 200px tall filler Rectangle above the TextBox, guaranteeing the latter will be hidden behind keyboard.
var SUT = new TextBox();
var panel = new StackPanel()
{
Spacing = 5,
Children =
{
new Windows.UI.Xaml.Shapes.Rectangle() { Height = 200, Fill = SolidColorBrushHelper.SkyBlue },
SUT,
},
};
var sv = new ScrollViewer()
{
Height = kbHeight + 50,
Content = panel,
VerticalAlignment = VerticalAlignment.Bottom
};
var container = new Border() { Child = sv };

WindowHelper.WindowContent = container;
await WindowHelper.WaitForLoaded(container);
await WindowHelper.WaitForIdle();

// when the TextBox is focused, we expect BringIntoView to push the TextBox above the keyboard
// note: This test can be flaky, as it would randomly close the keyboard right after opening it.
SUT.Focus(FocusState.Programmatic);
await WindowHelper.WaitFor(() => kb.Visible, message: "Failed to summon keyboard via Focus(FocusState.Programmatic).");
Assert.IsTrue(SUT.ActualHeight < 50, $"TextBox should be no taller than 50px. (ActualHeight = {SUT.ActualHeight})");

var minOffset = 200 - (50 - SUT.ActualHeight); // tbox sticks to the top of viewport
var maxOffset = 205; // tbox sticks to the bottom of viewport
await WindowHelper.WaitFor<double>(
() => sv.VerticalOffset,
default, // unused, since are we doing between comparison
value => $"Failed to make keyboard appear above keyboard. (sv.VOffset = {value})",
comparer: (value, _) => minOffset <= value && value <= maxOffset);
}

[TestMethod]
[RunsOnUIThread]
[RequiresFullWindow]
public async Task When_DoublyNested_BringIntoView()
{
// note: Compared to When_NonNested_BringIntoView, we are using 2 SVs here, one nesting another.
// Other than that, the expected result should still be the same, as in the outer SV should be the one
// being padded and scrolled by the same amount, AND NOT the inner one.
if (ContextHelper.Current is not Android.App.Activity activity)
{
Assert.Inconclusive("The current android activity is not accessible.");
return;
}

// set AdjustNothing mode and prepare for cleanup
var oldMode = activity.Window.Attributes.SoftInputMode;
activity.Window.SetSoftInputMode(oldMode & ~Android.Views.SoftInput.MaskAdjust | Android.Views.SoftInput.AdjustNothing);
using var cleanup = Disposable.Create(() => activity.Window.SetSoftInputMode(oldMode));

// load a tmp textbox to ...
var tmpTextbox = new TextBox();
WindowHelper.WindowContent = tmpTextbox;
await WindowHelper.WaitForLoaded(tmpTextbox);
await WindowHelper.WaitForIdle();
tmpTextbox.Focus(FocusState.Programmatic);

// ... measure keyboard height
var kb = InputPane.GetForCurrentView();
await WindowHelper.WaitFor(() => kb.Visible, message: "Failed to summon keyboard via Focus(FocusState.Programmatic).");
await WindowHelper.WaitFor(() => kb.OccludedRect.Height > 0, message: "Failed to summon keyboard via Focus(FocusState.Programmatic).");
var kbHeight = kb.OccludedRect.Height;
kb.Visible = false;

// load actual test setup
// ScrollViewer's viewport is set to be 50px taller than the keyboard.
// There is a 200px tall filler Rectangle above the TextBox, guaranteeing the latter will be hidden behind keyboard.
var SUT = new TextBox();
var panel = new StackPanel()
{
Spacing = 5,
Children =
{
new Windows.UI.Xaml.Shapes.Rectangle() { Height = 200, Fill = SolidColorBrushHelper.SkyBlue },
SUT,
},
};
var innerSV = new ScrollViewer() { Content = panel };
var outerSV = new ScrollViewer()
{
Height = kbHeight + 50,
Content = innerSV,
VerticalAlignment = VerticalAlignment.Bottom
};
var container = new Border() { Child = outerSV };

WindowHelper.WindowContent = container;
await WindowHelper.WaitForLoaded(container);
await WindowHelper.WaitForIdle();

// when the TextBox is focused, we expect BringIntoView to push the TextBox above the keyboard
// note: This test can be flaky, as it would randomly close the keyboard right after opening it.
SUT.Focus(FocusState.Programmatic);
await WindowHelper.WaitFor(() => kb.Visible, message: "Failed to summon keyboard via Focus(FocusState.Programmatic).");
Assert.IsTrue(SUT.ActualHeight < 50, $"TextBox should be no taller than 50px. (ActualHeight = {SUT.ActualHeight})");

var minOffset = 200 - (50 - SUT.ActualHeight); // tbox sticks to the top of viewport
var maxOffset = 205; // tbox sticks to the bottom of viewport
await WindowHelper.WaitFor<double>(
() => outerSV.VerticalOffset,
default, // unused, since are we doing between comparison
value => $"Failed to make keyboard appear above keyboard. (sv.VOffset = {value})",
comparer: (value, _) => minOffset <= value && value <= maxOffset);
}

#endif
}
}
13 changes: 10 additions & 3 deletions src/Uno.UI/UI/ViewManagement/InputPane/InputPane.Android.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,17 @@ partial void EnsureFocusedElementInViewPartial()

if (Visible && FocusManager.GetFocusedElement() is UIElement focusedElement)
{
var scrollContentViewer = focusedElement.FindFirstParent<ScrollContentPresenter>();
if (scrollContentViewer != null)
if (focusedElement.FindFirstParent<ScrollContentPresenter>() is { } scp)
{
_padScrollContentPresenter = scrollContentViewer.Pad(OccludedRect);
// ScrollViewer can be nested, but the outer-most SV isn't necessarily the one to handle this "padded" scroll.
// Only the first SV that is constrained would be the one, as unconstrained SV can just expand freely.
while (double.IsPositiveInfinity(scp.LastAvailableSize.Height)
&& scp.FindFirstParent<ScrollContentPresenter>(includeCurrent: false) is { } outerScv)
{
scp = outerScv;
}

_padScrollContentPresenter = scp.Pad(OccludedRect);
}
focusedElement.StartBringIntoView();
}
Expand Down
13 changes: 13 additions & 0 deletions src/Uno.UI/UI/Xaml/Controls/ScrollContentPresenter/ScrollContentPresenter.mux.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ protected override void OnBringIntoViewRequested(BringIntoViewRequestedEventArgs
var viewportHeight = ViewportHeight;
var zoomFactor = Scroller.ZoomFactor;

#if __ANDROID__ // Adjust for region blocked by keyboard.
viewportHeight -= _occludedRectPadding.Bottom;
#endif

// Compute the target offsets based on the provided BringIntoViewRequestedEventArgs.
ComputeBringIntoViewTargetOffsets(
content,
Expand Down Expand Up @@ -129,6 +133,11 @@ private void ComputeBringIntoViewTargetOffsets(
var viewportWidth = ViewportWidth;
var viewportHeight = ViewportHeight;
var zoomFactor = Scroller.ZoomFactor;

#if __ANDROID__ // Adjust for region blocked by keyboard.
viewportHeight -= _occludedRectPadding.Bottom;
#endif

if (!double.IsNaN(requestEventArgs.HorizontalAlignmentRatio))
{
// Account for the horizontal alignment ratio
Expand Down Expand Up @@ -167,6 +176,10 @@ private void ComputeBringIntoViewTargetOffsets(
double scrollableWidth = Scroller.ScrollableWidth;
double scrollableHeight = Scroller.ScrollableHeight;

#if __ANDROID__ // Adjust for region blocked by keyboard.
scrollableHeight += _occludedRectPadding.Bottom;
#endif

targetZoomedHorizontalOffsetTmp = targetZoomedHorizontalOffsetTmp.Clamp(0.0, scrollableWidth);
targetZoomedVerticalOffsetTmp = targetZoomedVerticalOffsetTmp.Clamp(0.0, scrollableHeight);

Expand Down

0 comments on commit 560a449

Please sign in to comment.