Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor usage of FocusManager to avoid weak table usage #1

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 28 additions & 18 deletions src/Core/src/Handlers/View/ViewHandler.Windows.cs
Original file line number Diff line number Diff line change
@@ -1,31 +1,29 @@
#nullable enable
using System;
using System.Collections.Generic;
using System.ComponentModel;
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Controls;
using Microsoft.UI.Xaml.Controls.Primitives;
using Microsoft.UI.Xaml.Input;
using PlatformView = Microsoft.UI.Xaml.FrameworkElement;

namespace Microsoft.Maui.Handlers
{
public partial class ViewHandler
{
static ViewHandler()
{
FocusManager.GotFocus += FocusManager_GotFocus;
FocusManager.LostFocus += FocusManager_LostFocus;
}

partial void ConnectingHandler(PlatformView? platformView)
{
if (platformView != null)
{
platformView.GotFocus += OnPlatformViewGotFocus;
platformView.LostFocus += OnPlatformViewLostFocus;
}
platformView?.SetMauiHandler(this);
}

partial void DisconnectingHandler(PlatformView platformView)
{
platformView.SetMauiHandler(null);
UpdateIsFocused(false);

platformView.GotFocus -= OnPlatformViewGotFocus;
platformView.LostFocus -= OnPlatformViewLostFocus;
}

static partial void MappingFrame(IViewHandler handler, IView view)
Expand Down Expand Up @@ -88,7 +86,9 @@ public static void MapAnchorY(IViewHandler handler, IView view)
public static void MapToolbar(IViewHandler handler, IView view)
{
if (view is IToolbarElement tb)
{
MapToolbar(handler, tb);
}
}

internal static void MapToolbar(IElementHandler handler, IToolbarElement toolbarElement)
Expand Down Expand Up @@ -133,25 +133,35 @@ internal static void MapContextFlyout(IElementHandler handler, IContextFlyoutEle
}
}

void OnPlatformViewGotFocus(object sender, RoutedEventArgs args)
static void FocusManager_GotFocus(object? sender, FocusManagerGotFocusEventArgs e)
{
UpdateIsFocused(true);
if (e.NewFocusedElement is PlatformView platformView && platformView.GetMauiHandler() is { } handler)
{
handler.UpdateIsFocused(true);
}
}

void OnPlatformViewLostFocus(object sender, RoutedEventArgs args)
static void FocusManager_LostFocus(object? sender, FocusManagerLostFocusEventArgs e)
{
UpdateIsFocused(false);
if (e.OldFocusedElement is PlatformView platformView && platformView.GetMauiHandler() is { } handler)
{
handler.UpdateIsFocused(false);
}
}

void UpdateIsFocused(bool isFocused)
{
if (VirtualView == null)
if (VirtualView is not { } virtualView)
{
return;
}

bool updateIsFocused = (isFocused && !VirtualView.IsFocused) || (!isFocused && VirtualView.IsFocused);
bool updateIsFocused = (isFocused && !virtualView.IsFocused) || (!isFocused && virtualView.IsFocused);

if (updateIsFocused)
VirtualView.IsFocused = isFocused;
{
virtualView.IsFocused = isFocused;
}
}
}
}
21 changes: 20 additions & 1 deletion src/Core/src/Platform/Windows/ViewExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ namespace Microsoft.Maui.Platform
{
public static partial class ViewExtensions
{
internal static readonly DependencyProperty MauiHandlerProperty = DependencyProperty.RegisterAttached("MauiHandler",
typeof(WeakReference<ViewHandler>), typeof(FrameworkElement), new PropertyMetadata(null));

internal static void SetMauiHandler(this FrameworkElement element, ViewHandler? handler)
{
var weakRef = handler != null ? new WeakReference<ViewHandler>(handler) : null;
element.SetValue(MauiHandlerProperty, weakRef);
}

internal static ViewHandler? GetMauiHandler(this FrameworkElement element)
{
var weakRef = (WeakReference<ViewHandler>?)element.GetValue(MauiHandlerProperty);
return weakRef?.TryGetTarget(out var viewHandler) == true ? viewHandler : null;
}

public static void TryMoveFocus(this FrameworkElement platformView, FocusNavigationDirection direction)
{
if (platformView?.XamlRoot?.Content is UIElement elem)
Expand All @@ -36,7 +51,9 @@ public static void Focus(this FrameworkElement platformView, FocusRequest reques
public static void Unfocus(this FrameworkElement platformView, IView view)
{
if (platformView is Control control)
{
UnfocusControl(control);
}
}

public static void UpdateVisibility(this FrameworkElement platformView, IView view)
Expand Down Expand Up @@ -370,8 +387,10 @@ internal static Graphics.Rect GetBoundingBox(this FrameworkElement? platformView

internal static void UnfocusControl(Control control)
{
if (control == null || !control.IsEnabled)
if (!control.IsEnabled)
{
return;
}

var isTabStop = control.IsTabStop;
control.IsTabStop = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ await AttachAndRun<LayoutHandler>(layout, async (contentViewHandler) =>
Assert.True(inputControl1.IsFocused);
Assert.False(inputControl2.IsFocused);

// UNfocus the first control (revert the focus)
// Unfocus the first control (revert the focus)
inputControl1.Handler.Invoke(nameof(IView.Unfocus));

// assert
Expand Down
29 changes: 19 additions & 10 deletions src/TestUtils/src/DeviceTests/AssertionExtensions.Windows.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
using Microsoft.UI.Xaml.Media.Imaging;
using Windows.Graphics.DirectX;
using Windows.Storage.Streams;
using Microsoft.UI.Xaml.Input;
using Xunit;
using Xunit.Sdk;
using WColor = Windows.UI.Color;
Expand Down Expand Up @@ -49,42 +50,50 @@ public static Task SendKeyboardReturnType(this FrameworkElement view, ReturnType
public static async Task WaitForFocused(this FrameworkElement view, int timeout = 1000)
{
TaskCompletionSource focusSource = new TaskCompletionSource();
view.GotFocus += OnFocused;

FocusManager.GotFocus += OnFocused;

try
{
await focusSource.Task.WaitAsync(TimeSpan.FromMilliseconds(timeout));
}
finally
{
view.GotFocus -= OnFocused;
FocusManager.GotFocus -= OnFocused;
}

void OnFocused(object? sender, RoutedEventArgs e)
void OnFocused(object? sender, FocusManagerGotFocusEventArgs e)
{
view.GotFocus -= OnFocused;
focusSource.SetResult();
if (e.NewFocusedElement == view)
{
FocusManager.GotFocus -= OnFocused;
focusSource.SetResult();
}
}
}

public static async Task WaitForUnFocused(this FrameworkElement view, int timeout = 1000)
{
TaskCompletionSource focusSource = new TaskCompletionSource();
view.LostFocus += OnUnFocused;

FocusManager.LostFocus += OnUnFocused;

try
{
await focusSource.Task.WaitAsync(TimeSpan.FromMilliseconds(timeout));
}
finally
{
view.LostFocus -= OnUnFocused;
FocusManager.LostFocus -= OnUnFocused;
}

void OnUnFocused(object? sender, RoutedEventArgs e)
void OnUnFocused(object? sender, FocusManagerLostFocusEventArgs e)
{
view.LostFocus -= OnUnFocused;
focusSource.SetResult();
if (e.OldFocusedElement == view)
{
FocusManager.LostFocus -= OnUnFocused;
focusSource.SetResult();
}
}
}

Expand Down