Avalonia/tests/Avalonia.Controls.UnitTests/ListBoxTests_Single.cs

using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using Avalonia.Controls.Presenters;
using Avalonia.Controls.Primitives;
using Avalonia.Controls.Templates;
using Avalonia.Data;
using Avalonia.Input;
using Avalonia.Input.GestureRecognizers;
using Avalonia.Input.Platform;
using Avalonia.LogicalTree;
using Avalonia.Styling;
using Avalonia.UnitTests;
using Avalonia.VisualTree;
using Moq;
using Xunit;

namespace Avalonia.Controls.UnitTests
{
    public class ListBoxTests_Single : ScopedTestBase
    {
        MouseTestHelper _mouse = new MouseTestHelper();
        MouseTestHelper _pen = new MouseTestHelper(PointerType.Pen);
        
        [Fact]
        public void Focusing_Item_With_Tab_Should_Not_Select_It()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                };

                Prepare(target);

                target.Presenter.Panel.Children[0].RaiseEvent(new GotFocusEventArgs
                {
                    NavigationMethod = NavigationMethod.Tab,
                });

                Assert.Equal(-1, target.SelectedIndex);
            }
        }

        [Fact]
        public void Pressing_Space_On_Focused_Item_With_Ctrl_Pressed_Should_Select_It()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                };
                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);

                target.Presenter.Panel.Children[0].RaiseEvent(new GotFocusEventArgs
                {
                    NavigationMethod = NavigationMethod.Directional,
                    KeyModifiers = KeyModifiers.Control
                });

                target.Presenter.Panel.Children[0].RaiseEvent(new KeyEventArgs
                {
                    RoutedEvent = InputElement.KeyDownEvent,
                    Key = Key.Space,
                    KeyModifiers = KeyModifiers.Control
                });

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Clicking_Item_Should_Select_It()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                };
                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);
                _mouse.Click(target.Presenter.Panel.Children[0]);

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Pen_Right_Press_Item_Should_Select_It()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemTemplate = new FuncDataTemplate<string>((x, _) => new TextBlock { Width = 20, Height = 10 }),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " }
                };
                Prepare(target);
                _pen.Down(target.Presenter.Panel.Children[0], MouseButton.Right);

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Pen_Left_Press_Item_Should_Not_Select_It()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemTemplate = new FuncDataTemplate<string>((x, _) => new TextBlock { Width = 20, Height = 10 }),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " }
                };
                Prepare(target);
                _pen.Down(target.Presenter.Panel.Children[0]);

                Assert.Equal(-1, target.SelectedIndex);
            }
        }


        [Theory]
        [InlineData(PointerType.Mouse)]
        [InlineData(PointerType.Pen)]
        public void Pointer_Right_Click_Should_Select_Item_And_Open_Context(PointerType type)
        {
            using (UnitTestApplication.Start(TestServices.StyledWindow))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                    ItemTemplate = new FuncDataTemplate<string>((x, _) => new Border { Height = 10 })
                };
                target.GestureRecognizers.Add(new ScrollGestureRecognizer()
                {
                    CanVerticallyScroll = true, ScrollStartDistance = 50
                });
                Prepare(target);

                var contextRaised = false;
                target.AddHandler(Control.ContextRequestedEvent, (sender, args) =>
                {
                    contextRaised = true;
                    args.Handled = true;
                });

                var pointer = type == PointerType.Mouse ? _mouse : _pen;
                pointer.Click(target.Presenter.Panel.Children[0], MouseButton.Right, position: new Point(5, 5));

                Assert.True(contextRaised);
                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Clicking_Selected_Item_Should_Not_Deselect_It()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                };
                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);
                target.SelectedIndex = 0;

                _mouse.Click(target.Presenter.Panel.Children[0]);

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Clicking_Item_Should_Select_It_When_SelectionMode_Toggle()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                    SelectionMode = SelectionMode.Single | SelectionMode.Toggle,
                };
                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);

                _mouse.Click(target.Presenter.Panel.Children[0]);

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Clicking_Selected_Item_Should_Deselect_It_When_SelectionMode_Toggle()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                    SelectionMode = SelectionMode.Toggle,
                };

                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);
                target.SelectedIndex = 0;

                _mouse.Click(target.Presenter.Panel.Children[0]);

                Assert.Equal(-1, target.SelectedIndex);
            }
        }

        [Fact]
        public void Clicking_Selected_Item_Should_Not_Deselect_It_When_SelectionMode_ToggleAlwaysSelected()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                    SelectionMode = SelectionMode.Toggle | SelectionMode.AlwaysSelected,
                };
                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);
                target.SelectedIndex = 0;

                _mouse.Click(target.Presenter.Panel.Children[0]);

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Clicking_Another_Item_Should_Select_It_When_SelectionMode_Toggle()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                    SelectionMode = SelectionMode.Single | SelectionMode.Toggle,
                };
                AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration());
                Prepare(target);
                target.SelectedIndex = 1;

                _mouse.Click(target.Presenter.Panel.Children[0]);

                Assert.Equal(0, target.SelectedIndex);
            }
        }

        [Fact]
        public void Setting_Item_IsSelected_Sets_ListBox_Selection()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    ItemsSource = new[] { "Foo", "Bar", "Baz " },
                };

                Prepare(target);

                ((ListBoxItem)target.GetLogicalChildren().ElementAt(1)).IsSelected = true;

                Assert.Equal("Bar", target.SelectedItem);
                Assert.Equal(1, target.SelectedIndex);
            }
        }

        [Fact]
        public void SelectedItem_Should_Not_Cause_StackOverflow()
        {
            using (UnitTestApplication.Start(TestServices.MockPlatformRenderInterface))
            {
                var viewModel = new TestStackOverflowViewModel() { Items = new List<string> { "foo", "bar", "baz" } };

                var target = new ListBox
                {
                    Template = new FuncControlTemplate(CreateListBoxTemplate),
                    DataContext = viewModel,
                    ItemsSource = viewModel.Items
                };

                target.Bind(ListBox.SelectedItemProperty,
                    new Binding("SelectedItem") { Mode = BindingMode.TwoWay });

                Assert.Equal(0, viewModel.SetterInvokedCount);

                // In Issue #855, a Stackoverflow occurred here.
                target.SelectedItem = viewModel.Items[2];

                Assert.Equal(viewModel.Items[1], target.SelectedItem);
                Assert.Equal(1, viewModel.SetterInvokedCount);
            }
        }

        private class TestStackOverflowViewModel : INotifyPropertyChanged
        {
            public List<string> Items { get; set; }

            public int SetterInvokedCount { get; private set; }

            public const int MaxInvokedCount = 1000;

            private string _selectedItem;

            public event PropertyChangedEventHandler PropertyChanged;

            public string SelectedItem
            {
                get { return _selectedItem; }
                set
                {
                    if (_selectedItem != value)
                    {
                        SetterInvokedCount++;

                        int index = Items.IndexOf(value);

                        if (MaxInvokedCount > SetterInvokedCount && index > 0)
                        {
                            _selectedItem = Items[index - 1];
                        }
                        else
                        {
                            _selectedItem = value;
                        }

                        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(SelectedItem)));
                    }
                }
            }
        }

        private Control CreateListBoxTemplate(TemplatedControl parent, INameScope scope)
        {
            return new ScrollViewer
            {
                Template = new FuncControlTemplate(CreateScrollViewerTemplate),
                Content = new ItemsPresenter
                {
                    Name = "PART_ItemsPresenter",
                }.RegisterInNameScope(scope)
            };
        }

        private Control CreateScrollViewerTemplate(TemplatedControl parent, INameScope scope)
        {
            return new ScrollContentPresenter
            {
                Name = "PART_ContentPresenter",
                [~ContentPresenter.ContentProperty] =
                    parent.GetObservable(ContentControl.ContentProperty).ToBinding(),
            }.RegisterInNameScope(scope);
        }

        private static void Prepare(ListBox target)
        {
            target.Width = target.Height = 100;
            var root = new TestRoot(target);
            root.LayoutManager.ExecuteInitialLayoutPass();
        }
    }
}