Merge pull request #4756 from LittleEndu/tabcontrol-initial-autosort

Let `TabControl` always sort initial selection if auto sort is on
ppy · Sep 7, 2021 · 63bc389 · 63bc389
2 parents 3739063 + 0fd9563
commit 63bc389
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/osu.Framework.Tests/Visual/UserInterface/TestSceneTabControl.cs b/osu.Framework.Tests/Visual/UserInterface/TestSceneTabControl.cs
@@ -378,6 +378,30 @@ public void TestInitialSelection(bool selectFirstByDefault, TestEnum? expectedIn
             AddAssert("initial selection is correct", () => tabControl.Current.Value == expectedInitialSelection);
         }
 
+        [TestCase(true, TestEnum.Test1, true)]
+        [TestCase(false, TestEnum.Test1, true)]
+        [TestCase(true, TestEnum.Test9, true)]
+        [TestCase(false, TestEnum.Test9, false)]
+        public void TestInitialSort(bool autoSort, TestEnum? initialItem, bool expected)
+        {
+            StyledTabControl tabControlWithBindable = null;
+            Bindable<TestEnum?> testBindable = new Bindable<TestEnum?> { Value = initialItem };
+
+            AddStep("create tab control", () =>
+            {
+                tabControlContainer.Add(tabControlWithBindable = new StyledTabControl
+                {
+                    Size = new Vector2(200, 20),
+                    Items = items.Cast<TestEnum?>().ToList(),
+                    AutoSort = autoSort,
+                    Current = { BindTarget = testBindable }
+                });
+            });
+
+            AddUntilStep("wait for loaded", () => tabControlWithBindable.IsLoaded);
+            AddAssert($"Current selection {(expected ? "visible" : "not visible")}", () => tabControlWithBindable.SelectedTab.IsPresent == expected);
+        }
+
         private class StyledTabControlWithoutDropdown : TabControl<TestEnum>
         {
             protected override Dropdown<TestEnum> CreateDropdown() => null;

diff --git a/osu.Framework/Graphics/UserInterface/TabControl.cs b/osu.Framework/Graphics/UserInterface/TabControl.cs
@@ -204,6 +204,10 @@ protected override void LoadComplete()
                 Current.Value = Items.First();
 
             Current.BindValueChanged(v => selectTab(v.NewValue != null ? tabMap[v.NewValue] : null), true);
+
+            // TabContainer doesn't have valid layout yet, so TabItems all have y=0 and selectTab() didn't call performTabSort() so we call it here instead
+            if (AutoSort && Current.Value != null)
+                performTabSort(tabMap[Current.Value]);
         }
 
         /// <summary>