Focus extension when activated (#11168)

mmisol · web-flow · commit 7278d9782f1f · 2020-10-08T21:14:00.000-04:00
* Focus extension when activated

Modifies the mechanism used to add/display extensions to make sure the
extension bar is actually visible and that the right tab is actually
displayed.

* Add unit test
diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs
@@ -205,18 +205,22 @@ public DynamoView(DynamoViewModel dynamoViewModel)
             FocusableGrid.InputBindings.Clear();
         }
 
-        // This method adds a tab item to the right side bar and 
-        // sets the extension window as the tab content.
+        /// <summary>
+        /// Adds a tab item to the extension bar and sets the extension window/control as the tab
+        /// content. It also makes sure the extension is visible.
+        /// </summary>
+        /// <param name="viewExtension">View extension adding the content</param>
+        /// <param name="contentControl">Control being added to the extension bar</param>
+        /// <returns>The tab item if it was added, otherwise null</returns>
         internal TabItem AddExtensionTabItem(IViewExtension viewExtension, ContentControl contentControl)
         {
-            int count = ExtensionTabItems.Count;
-
-            if (!IsExtensionAddedToRightSideBar(viewExtension))
+            var tab = FindExtensionTab(viewExtension);
+            if (tab == null)
             {
                 tabDynamic.DataContext = null;
 
                 // creates a new tab item
-                TabItem tab = new TabItem();
+                tab = new TabItem();
                 tab.Header = viewExtension.Name;
                 tab.Tag = viewExtension.GetType();
                 tab.Uid = viewExtension.UniqueId;
@@ -240,13 +244,21 @@ internal TabItem AddExtensionTabItem(IViewExtension viewExtension, ContentContro
                 }
 
                 //Insert the tab at the end
-                ExtensionTabItems.Insert(count, tab);
+                ExtensionTabItems.Insert(ExtensionTabItems.Count, tab);
 
                 tabDynamic.DataContext = ExtensionTabItems;
                 tabDynamic.SelectedItem = tab;
 
                 return tab;
             }
+
+            // Make sure the extension bar is visible
+            if (ExtensionsCollapsed)
+            {
+                ToggleExtensionBarCollapseStatus();
+            }
+
+            tabDynamic.SelectedItem = tab;
             return null;
         }
 
@@ -316,16 +328,9 @@ private void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs
             this.HideOrShowRightSideBar();
         }
 
-        private Boolean IsExtensionAddedToRightSideBar(IViewExtension viewExtension)
+        private TabItem FindExtensionTab(IViewExtension viewExtension)
         {
-            foreach (TabItem tabItem in ExtensionTabItems)
-            {
-                if (tabItem.Tag.Equals(viewExtension.GetType()))
-                {
-                    return true;
-                }
-            }
-            return false;
+            return ExtensionTabItems.FirstOrDefault(tab => tab.Tag.Equals(viewExtension.GetType()));
         }
 
         private void OnRequestReturnFocusToView()
@@ -1924,6 +1929,14 @@ private void OnCollapsedLeftSidebarClick(object sender, EventArgs e)
         }
 
         private void OnCollapsedRightSidebarClick(object sender, EventArgs e)
+        {
+            ToggleExtensionBarCollapseStatus();
+        }
+
+        /// <summary>
+        /// Made internal for testing purposes only.
+        /// </summary>
+        internal void ToggleExtensionBarCollapseStatus()
         {
             if (ExtensionsCollapsed)
             {
diff --git a/test/DynamoCoreWpfTests/ViewExtensions/ViewExtensionTests.cs b/test/DynamoCoreWpfTests/ViewExtensions/ViewExtensionTests.cs
@@ -1,6 +1,7 @@
 ﻿using System.IO;
 using System.Reflection;
 using System.Windows;
+using System.Windows.Controls;
 using Dynamo.Wpf.Extensions;
 using NUnit.Framework;
 
@@ -68,6 +69,29 @@ public void ExtensionsSideBarExtensionsTest()
             Assert.AreEqual(initialNum + 2, View.ExtensionTabItems.Count); 
         }
 
+        [Test]
+        public void ExtensionSideBarIsUncollapsedOnActivation()
+        {
+            RaiseLoadedEvent(this.View);
+
+            // Add extension
+            View.viewExtensionManager.Add(viewExtension);
+            
+            // Extension bar is shown
+            Assert.IsFalse(View.ExtensionsCollapsed);
+
+            // Collapse extension bar
+            View.ToggleExtensionBarCollapseStatus();
+            Assert.IsTrue(View.ExtensionsCollapsed);
+
+            // Simulate the extension activating the tab content again.
+            // The content here should not matter because it won't be used.
+            View.AddExtensionTabItem(viewExtension, new UserControl());
+
+            // Extension bar is shown
+            Assert.IsFalse(View.ExtensionsCollapsed);
+        }
+
         [Test]
         public void ExtensionNotEnabledLoadingTest()
         {
