ComboBoxTests.cs

using System.ComponentModel;
using System.Windows.Media;
using MaterialDesignThemes.UITests.WPF.TextBoxes;

namespace MaterialDesignThemes.UITests.WPF.ComboBoxes;

public class ComboBoxTests : TestBase
{
    [Test]
    [Description("Pull Request 2192")]
    public async Task OnComboBoxHelperTextFontSize_ChangesHelperTextFontSize()
    {
        var stackPanel = await LoadXaml<StackPanel>(@"
<StackPanel>
    <ComboBox
        materialDesign:HintAssist.HelperTextFontSize=""20""/>
</StackPanel>");
        var comboBox = await stackPanel.GetElement<ComboBox>("/ComboBox");
        var helpTextBlock = await comboBox.GetElement<TextBlock>("/Grid/Canvas/TextBlock");

        double fontSize = await helpTextBlock.GetFontSize();

        await Assert.That(fontSize).IsEqualTo(20);
    }

    [Test]
    [Description("Pull Request 2192")]
    public async Task OnFilledComboBoxHelperTextFontSize_ChangesHelperTextFontSize()
    {
        var stackPanel = await LoadXaml<StackPanel>(@"
<StackPanel>
    <ComboBox
        Style=""{StaticResource MaterialDesignFilledComboBox}""
        materialDesign:HintAssist.HelperTextFontSize=""20""/>
</StackPanel>");
        var comboBox = await stackPanel.GetElement<ComboBox>("/ComboBox");
        var helpTextBlock = await comboBox.GetElement<TextBlock>("/Grid/Canvas/TextBlock");

        double fontSize = await helpTextBlock.GetFontSize();

        await Assert.That(fontSize).IsEqualTo(20);
    }

    [Test]
    [Description("Issue 2495")]
    public async Task OnComboBox_WithClearButton_ClearsSelection()
    {
        var stackPanel = await LoadXaml<StackPanel>($@"
<StackPanel>
    <ComboBox materialDesign:HintAssist.Hint=""OS""
              materialDesign:TextFieldAssist.HasClearButton=""True""
              SelectedIndex=""1"">
        <ComboBoxItem Content=""Android"" />
        <ComboBoxItem Content=""iOS"" />
        <ComboBoxItem Content=""Linux"" />
        <ComboBoxItem Content=""Windows"" />
    </ComboBox>
</StackPanel>");
        var comboBox = await stackPanel.GetElement<ComboBox>("/ComboBox");
        var clearButton = await comboBox.GetElement<Button>("PART_ClearButton");

        int? selectedIndex = await comboBox.GetSelectedIndex();
        object? text = await comboBox.GetText();

        await Assert.That(selectedIndex >= 0).IsTrue();
        await Assert.That(text).IsNotNull();

        await clearButton.LeftClick();

        await Wait.For(async () =>
        {
            text = await comboBox.GetText();
            await Assert.That(text).IsNull();
            selectedIndex = await comboBox.GetSelectedIndex();
            await Assert.That(selectedIndex >= 0).IsFalse();
        });
    }

    [Test]
    [Description("Issue 2690")]
    public async Task OnEditableComboBox_WithDefaultContextMenu_ShowsCutCopyPaste()
    {
        var comboBox = await LoadXaml<ComboBox>(@"
<ComboBox IsEditable=""True"" Width=""200"" Style=""{StaticResource MaterialDesignComboBox}"">
    <ComboBoxItem Content=""Select1"" />
    <ComboBoxItem>Select2</ComboBoxItem>
    <ComboBoxItem>Select3</ComboBoxItem>
    <ComboBoxItem>Select4</ComboBoxItem>
    <ComboBoxItem>Select5</ComboBoxItem>
</ComboBox>");

        await comboBox.RightClick();

        IVisualElement<ContextMenu>? contextMenu = await comboBox.GetContextMenu();
        await Assert.That(contextMenu).IsNotNull().Because("No context menu set on the ComboBox");
        await Wait.For(async () => await contextMenu!.GetIsVisible());
        await AssertMenu("Cut");
        await AssertMenu("Copy");
        await AssertMenu("Paste");
        async Task AssertMenu(string menuHeader)
        {
            var menuItem = await contextMenu!.GetElement(ElementQuery.PropertyExpression<MenuItem>(x => x.Header, menuHeader));
            await Assert.That(menuItem).IsNotNull().Because($"{menuHeader} menu item not found");
        }
    }

    [Test]
    [Description("Issue 2713")]
    public async Task OnEditableComboBox_ClickInTextArea_FocusesTextBox()
    {
        var stackPanel = await LoadXaml<StackPanel>(@"
<StackPanel Orientation=""Horizontal"">
    <ComboBox x:Name=""EditableComboBox"" IsEditable=""True"" Style=""{StaticResource MaterialDesignComboBox}"">
        <ComboBoxItem>Select1</ComboBoxItem>
        <ComboBoxItem>Select2</ComboBoxItem>
        <ComboBoxItem IsSelected=""True"">Select3</ComboBoxItem>
        <ComboBoxItem>Select4</ComboBoxItem>
        <ComboBoxItem>Select5</ComboBoxItem>
    </ComboBox>
    <Button x:Name=""Button"" />
</StackPanel>");

        var comboBox = await stackPanel.GetElement<ComboBox>("EditableComboBox");
        var editableTextBox = await comboBox.GetElement<TextBox>("PART_EditableTextBox");
        var button = await stackPanel.GetElement<Button>("Button");

        // Open the ComboBox initially
        await comboBox.LeftClick(Position.RightCenter);
        await Task.Delay(50, TestContext.Current!.Execution.CancellationToken);   // Allow a little time for the drop-down to open (and property to change)
        bool wasOpenAfterClickOnToggleButton = await comboBox.GetIsDropDownOpen();

        // Focus (i.e. click) another element
        await button.LeftClick();

        // Click the editable TextBox of the ComboBox
        await editableTextBox.LeftClick();
        await Task.Delay(50, TestContext.Current.Execution.CancellationToken);   // Allow a little time for the drop-down to open (and property to change)
        bool wasOpenAfterClickOnEditableTextBox = await comboBox.GetIsDropDownOpen();
        bool textBoxHasFocus = await editableTextBox.GetIsFocused();
        bool textBoxHasKeyboardFocus = await editableTextBox.GetIsKeyboardFocused();

        await Assert.That(wasOpenAfterClickOnToggleButton).IsTrue().Because("ComboBox should have opened drop down when clicking the toggle button");
        await Assert.That(wasOpenAfterClickOnEditableTextBox).IsFalse().Because("ComboBox should not have opened drop down when clicking the editable ait wTextBox");
        await Assert.That(textBoxHasFocus).IsTrue().Because("Editable TextBox should have focus");
        await Assert.That(textBoxHasKeyboardFocus).IsTrue().Because("Editable TextBox should have keyboard focus");
    }

    [Test]
    [Arguments("MaterialDesignFloatingHintComboBox", null)]
    [Arguments("MaterialDesignFloatingHintComboBox", 5)]
    [Arguments("MaterialDesignFloatingHintComboBox", 20)]
    [Arguments("MaterialDesignFilledComboBox", null)]
    [Arguments("MaterialDesignFilledComboBox", 5)]
    [Arguments("MaterialDesignFilledComboBox", 20)]
    [Arguments("MaterialDesignOutlinedComboBox", null)]
    [Arguments("MaterialDesignOutlinedComboBox", 5)]
    [Arguments("MaterialDesignOutlinedComboBox", 20)]
    public async Task ComboBox_WithHintAndHelperText_RespectsPadding(string styleName, int? padding)
    {
        // FIXME: Tolerance needed because TextFieldAssist.TextBoxViewMargin is in play and slightly modifies the hint text placement in certain cases.
        const double tolerance = 1.5;

        string styleAttribute = $"Style=\"{{StaticResource {styleName}}}\"";
        string paddingAttribute = padding.HasValue ? $"Padding=\"{padding.Value}\"" : string.Empty;

        var comboBox = await LoadXaml<ComboBox>($@"
<ComboBox {styleAttribute} {paddingAttribute}
  materialDesign:HintAssist.Hint=""Hint text""
  materialDesign:HintAssist.HelperText=""Helper text""
  Width=""200"" VerticalAlignment=""Center"" HorizontalAlignment=""Center"" />
");

        var contentHost = await comboBox.GetElement<ScrollViewer>("PART_ContentHost");
        var hint = await comboBox.GetElement<SmartHint>("Hint");
        var helperText = await comboBox.GetElement<TextBlock>("HelperTextTextBlock");

        Rect? contentHostCoordinates = await contentHost.GetCoordinates();
        Rect? hintCoordinates = await hint.GetCoordinates();
        Rect? helperTextCoordinates = await helperText.GetCoordinates();

        await Assert.That(Math.Abs(contentHostCoordinates.Value.Left - hintCoordinates.Value.Left)).IsCloseTo(0, tolerance);
        await Assert.That(Math.Abs(contentHostCoordinates.Value.Left - helperTextCoordinates.Value.Left)).IsCloseTo(0, tolerance);
    }

    [Test]
    [Arguments("MaterialDesignFloatingHintComboBox", null)]
    [Arguments("MaterialDesignFloatingHintComboBox", 5)]
    [Arguments("MaterialDesignFloatingHintComboBox", 20)]
    [Arguments("MaterialDesignFilledComboBox", null)]
    [Arguments("MaterialDesignFilledComboBox", 5)]
    [Arguments("MaterialDesignFilledComboBox", 20)]
    [Arguments("MaterialDesignOutlinedComboBox", null)]
    [Arguments("MaterialDesignOutlinedComboBox", 5)]
    [Arguments("MaterialDesignOutlinedComboBox", 20)]
    public async Task ComboBox_WithHintAndValidationError_RespectsPadding(string styleName, int? padding)
    {
        // FIXME: Tolerance needed because TextFieldAssist.TextBoxViewMargin is in play and slightly modifies the hint text placement in certain cases.
        const double tolerance = 1.5;

        string styleAttribute = $"Style=\"{{StaticResource {styleName}}}\"";
        string paddingAttribute = padding.HasValue ? $"Padding=\"{padding.Value}\"" : string.Empty;

        var comboBox = await LoadXaml<ComboBox>($@"
<ComboBox {styleAttribute} {paddingAttribute}
  materialDesign:HintAssist.Hint=""Hint text""
  materialDesign:HintAssist.HelperText=""Helper text""
  Width=""200"" VerticalAlignment=""Center"" HorizontalAlignment=""Center"">
  <ComboBox.Text>
    <Binding RelativeSource=""{{RelativeSource Self}}"" Path=""Tag"" UpdateSourceTrigger=""PropertyChanged"">
      <Binding.ValidationRules>
        <local:NotEmptyValidationRule ValidatesOnTargetUpdated=""True""/>
      </Binding.ValidationRules>
    </Binding>
  </ComboBox.Text>
</ComboBox>
", ("local", typeof(NotEmptyValidationRule)));

        var contentHost = await comboBox.GetElement<ScrollViewer>("PART_ContentHost");
        var hint = await comboBox.GetElement<SmartHint>("Hint");
        var errorViewer = await comboBox.GetElement<Border>("DefaultErrorViewer");

        Rect? contentHostCoordinates = await contentHost.GetCoordinates();
        Rect? hintCoordinates = await hint.GetCoordinates();
        Rect? errorViewerCoordinates = await errorViewer.GetCoordinates();

        await Assert.That(Math.Abs(contentHostCoordinates.Value.Left - hintCoordinates.Value.Left)).IsCloseTo(0, tolerance);
        await Assert.That(Math.Abs(contentHostCoordinates.Value.Left - errorViewerCoordinates.Value.Left)).IsCloseTo(0, tolerance);
    }

    [Test]
    [Arguments(HorizontalAlignment.Left)]
    [Arguments(HorizontalAlignment.Right)]
    [Arguments(HorizontalAlignment.Center)]
    [Arguments(HorizontalAlignment.Stretch)]
    [Description("Issue 3433")]
    public async Task ComboBox_WithHorizontalContentAlignment_RespectsAlignment(HorizontalAlignment alignment)
    {
        var stackPanel = await LoadXaml<StackPanel>($"""
            <StackPanel>
              <ComboBox HorizontalContentAlignment="{alignment}">
                <ComboBoxItem Content="TEST" IsSelected="True" />
              </ComboBox>
            </StackPanel>
            """);
        var comboBox = await stackPanel.GetElement<ComboBox>("/ComboBox");
        var selectedItemPresenter = await comboBox.GetElement<ContentPresenter>("contentPresenter");

        await Assert.That(await selectedItemPresenter.GetHorizontalAlignment()).IsEqualTo(alignment);
    }

    [Test]
    [Arguments("MaterialDesignFloatingHintComboBox", 0, 0, 0, 1)]
    [Arguments("MaterialDesignFilledComboBox", 0, 0, 0, 1)]
    [Arguments("MaterialDesignOutlinedComboBox", 2, 2, 2, 2)]
    [Description("Issue 3623")]
    public async Task ComboBox_BorderShouldDependOnAppliedStyle(string style, double left, double top, double right, double bottom)
    {
        var stackPanel = await LoadXaml<StackPanel>($$"""
             <StackPanel>
               <ComboBox Style="{StaticResource {{style}}}">
                 <ComboBoxItem Content="TEST" IsSelected="True" />
               </ComboBox>
             </StackPanel>
             """);
        var comboBox = await stackPanel.GetElement<ComboBox>("/ComboBox");
        var border = await comboBox.GetElement<Border>("OuterBorder");

        await comboBox.LeftClick();

        Thickness thickness = await border.GetBorderThickness();
        await Assert.That(thickness).IsEqualTo(new Thickness(left, top, right, bottom));
    }

    [Test]
    [Description("Issue 3887")]
    public async Task ComboBox_UsesDropDownBackgroundResource_WhenBackgroundIsNotSet()
    {
        await using var recorder = new TestRecorder(App);

        var stackPanel = await LoadXaml<StackPanel>($$"""
             <StackPanel>
               <ComboBox Width="200">
                 <ComboBox.Resources>
                   <SolidColorBrush x:Key="MaterialDesign.Brush.ComboBox.DropDown.Background"
                                    Color="#CC336699" />
                 </ComboBox.Resources>
                 <ComboBoxItem Content="Android" />
                 <ComboBoxItem Content="iOS" />
                 <ComboBoxItem Content="Linux" />
               </ComboBox>
             </StackPanel>
             """);

        var comboBox = await stackPanel.GetElement<ComboBox>();
        await comboBox.LeftClick(Position.RightCenter);

        var popup = await Wait.For(async () => await comboBox.GetElement<ComboBoxPopup>("PART_Popup"));
        Color? popupBackground = await popup.GetBackgroundColor();

        await Assert.That(popupBackground).IsNotNull();
        await Assert.That(popupBackground).IsEqualTo((Color)ColorConverter.ConvertFromString("#CC336699"));

        recorder.Success();
    }
}