DYN-4973-Popups-NotAttached (#13002)

RobertGlobant20 · web-flow · commit e191d22d2e14 · 2022-06-16T14:57:33.000-04:00
* DYN-4973-Popups-NotAttached

I implemented the functionality of  hiding/showing the FileTrustUI and GuidedTours popups when the Dynamo window is inactive (in background).
I've tested the functionality for the User Interface tour and Packages tour and for the exitwindow that appear in the Packages tour.
For the other tours the RealTimeWindow (that appear when exiting the Guide) wont' have this functionality implemented.

* DYN-4973-Popups-NotAttached Code Review

I removed all the functionality of setting a state in the Guide and also added a new event for when the tour is completely closed (just in the case of the Packages guide).

* DYN-4973-Popups-NotAttached Code Review 2

Changed the hard-coded string to use the static string

* DYN-4973-Popups-NotAttached Code Review 2

Event renamed from GuidedTourClosed to GuidedTourFinished.
The property warningPopup was renamed to fileTrustWarningPopup.

* DYN-4973-Popups-NotAttached Code Review 2

Event renamed from GuidedTourFinished to GuidedTourExited

* DYN-4973-Popups-NotAttached Code Review 2

Fixing function name to match event name.

* DYN-4973-Popups-NotAttached Code Review 2

Removed subscriptions to GuidedTourExited event and the empty function handler.

* DYN-4973-Popups-NotAttached Code Review 2

Renaming property to IsGuideExited
diff --git a/src/DynamoCoreWpf/UI/GuidedTour/GuideFlowEvents.cs b/src/DynamoCoreWpf/UI/GuidedTour/GuideFlowEvents.cs
@@ -9,6 +9,7 @@ namespace Dynamo.Wpf.UI.GuidedTour
     public delegate void UpdateLibraryInteractionsEventHandler();
     public delegate void GuidedTourStartEventHandler(GuidedTourStateEventArgs args);
     public delegate void GuidedTourFinishEventHandler(GuidedTourStateEventArgs args);
+    public delegate void GuidedTourExitedEventHandler(GuidedTourStateEventArgs args);
 
     /// <summary>
     /// This static class will be used to raise events when the tooltip, welcome and survey popup buttons are clicked.
@@ -18,6 +19,7 @@ public static class GuideFlowEvents
         //Event that will be raised when the Popup Next button is pressed, the value passed as parameter is the current Step Sequence
         public static event GuidedTourNextEventHandler GuidedTourNextStep;
         private static bool isAnyGuideActive { get; set; } = false;
+        private static bool isGuideExited { get; set; } = false;
         public static void OnGuidedTourNext()
         {
             if (GuidedTourNextStep != null)
@@ -39,6 +41,7 @@ internal static void OnGuidedTourStart(string name)
             if (GuidedTourStart != null)
             {
                 isAnyGuideActive = true;
+                isGuideExited = false;
                 GuidedTourStart(new GuidedTourStateEventArgs(name));
             }              
         }
@@ -54,6 +57,13 @@ internal static void OnGuidedTourFinish(string name)
             }
         }
 
+        //Event that will be raised when the Guide is completely closed (this is specific for the Packages guide that allows the user to continue or exit the guide)
+        public static event GuidedTourExitedEventHandler GuidedTourExited;
+        internal static void OnGuidedTourExited(string name)
+        {
+            isGuideExited = true;
+        }
+
         //Event that will be raised when we want to update the Popup location of the current step being executed
         public static event UpdatePopupLocationEventHandler UpdatePopupLocation;
         public static void OnUpdatePopupLocation()
@@ -71,13 +81,22 @@ public static void OnUpdateLibraryInteractions()
         }
 
         /// <summary>
-        /// This property will returm if the a guide is being executed or not. 
+        /// This property will return if the a guide is being executed or not. 
         /// </summary>
         public static bool IsAnyGuideActive
         {
             get { return isAnyGuideActive; }
             set { isAnyGuideActive = value; }
         }
+
+        /// <summary>
+        /// This property will return a value that says if the tour has been completely closed or not
+        /// </summary>
+        public static bool IsGuideExited
+        {
+            get { return isGuideExited; }
+            set { isGuideExited = value; }
+        }
     }
 
     /// <summary>
diff --git a/src/DynamoCoreWpf/UI/GuidedTour/GuidesManager.cs b/src/DynamoCoreWpf/UI/GuidedTour/GuidesManager.cs
@@ -25,7 +25,7 @@ public sealed class GuidesManager
         /// <summary>
         /// currentGuide will contain the Guide being played
         /// </summary>
-        private Guide currentGuide;
+        internal Guide currentGuide;
 
         private GuideBackground guideBackgroundElement;
         private readonly UIElement mainRootElement;
@@ -209,7 +209,7 @@ private void TourFinished(GuidedTourStateEventArgs args)
             currentGuide = (from guide in Guides where guide.Name.Equals(args.GuideName) select guide).FirstOrDefault();
 
             //Check if it's packages guide to open the exit modal 
-            if (args.GuideName == "Packages" && currentGuide.CurrentStep.StepType != Step.StepTypes.SURVEY)
+            if (args.GuideName == GuidesManager.PackagesGuideName && currentGuide.CurrentStep.StepType != Step.StepTypes.SURVEY)
             {
                 guideBackgroundElement.ClearHighlightSection();
                 guideBackgroundElement.ClearCutOffSection();
@@ -249,7 +249,7 @@ private void ExitTour()
                 GuideFlowEvents.GuidedTourStart -= TourStarted;
                 GuideFlowEvents.GuidedTourFinish -= TourFinished;
 
-                if(exitGuideWindow != null)
+                if (exitGuideWindow != null)
                 {
                     exitGuideWindow.ExitTourButton.Click -= ExitTourButton_Click;
                     exitGuideWindow.ContinueTourButton.Click -= ContinueTourButton_Click;
@@ -278,6 +278,24 @@ internal void CreateExitModal(ExitGuide exitGuide)
             exitGuideWindow.IsOpen = true;
         }
 
+        /// <summary>
+        /// Shows/Hides the Popup based in if the DynamoView is Active or not
+        /// </summary>
+        /// <param name="isActive"></param>
+        internal void ManagePopupActivation(bool isActive)
+        {
+            if (GuideFlowEvents.IsAnyGuideActive)
+            {
+                if (currentGuide.CurrentStep.stepUIPopup.IsOpen == !isActive)
+                    currentGuide.CurrentStep.stepUIPopup.IsOpen = isActive;
+            }
+            else if (GuideFlowEvents.IsAnyGuideActive == false && GuideFlowEvents.IsGuideExited == false)
+            {
+                if(exitGuideWindow != null && currentGuide.Name.Equals(GuidesManager.PackagesGuideName))
+                    exitGuideWindow.IsOpen = isActive;
+            }
+        }
+
         private void ContinueTourButton_Click(object sender, RoutedEventArgs e)
         {
             exitGuideWindow.IsOpen = false;
@@ -291,6 +309,7 @@ private void ContinueTourButton_Click(object sender, RoutedEventArgs e)
         private void ExitTourButton_Click(object sender, RoutedEventArgs e)
         {
             exitGuideWindow.IsOpen = false;
+            GuideFlowEvents.OnGuidedTourExited(currentGuide.Name);
             ExitTour();
         }
 
diff --git a/src/DynamoCoreWpf/UI/GuidedTour/Step.cs b/src/DynamoCoreWpf/UI/GuidedTour/Step.cs
@@ -179,7 +179,7 @@ internal Popup StepUIPopup
         #endregion
 
         #region Protected Properties
-        protected Popup stepUIPopup;
+        internal Popup stepUIPopup;
         protected Func<bool, bool> validator;
         /// <summary>
         /// This property describe which will be the pointing direction of the tooltip (if is a Welcome or Survey popup then is not used)
diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml
@@ -30,6 +30,8 @@
         SnapsToDevicePixels="True"
         ResizeMode="CanResizeWithGrip"
         UseLayoutRounding="True"
+        Activated="DynamoView_Activated"
+        Deactivated="DynamoView_Deactivated"
         Style="{DynamicResource DynamoWindowStyle}">
 
     <Window.Resources>
diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs
@@ -42,6 +42,7 @@
 using Dynamo.Wpf.UI.GuidedTour;
 using Dynamo.Wpf.Utilities;
 using Dynamo.Wpf.ViewModels.Core;
+using Dynamo.Wpf.ViewModels.FileTrust;
 using Dynamo.Wpf.Views;
 using Dynamo.Wpf.Views.Debug;
 using Dynamo.Wpf.Views.FileTrust;
@@ -92,7 +93,7 @@ public partial class DynamoView : Window, IDisposable
         internal ViewExtensionManager viewExtensionManager;
         internal Watch3DView BackgroundPreview { get; private set; }
 
-        private FileTrustWarning warningPopup = null;
+        private FileTrustWarning fileTrustWarningPopup = null;
 
         /// <summary>
         /// Constructor
@@ -224,8 +225,8 @@ public DynamoView(DynamoViewModel dynamoViewModel)
             this.dynamoViewModel.Model.WorkspaceOpened += OnWorkspaceOpened;
             FocusableGrid.InputBindings.Clear();
             
-            if(warningPopup == null)
-                warningPopup = new FileTrustWarning(this);
+            if(fileTrustWarningPopup == null)
+                fileTrustWarningPopup = new FileTrustWarning(this);
         }
         private void OnWorkspaceOpened(WorkspaceModel workspace)
         {
@@ -750,8 +751,8 @@ private void DynamoView_LocationChanged(object sender, EventArgs e)
             if(dynamoViewModel.MainGuideManager != null)
                 dynamoViewModel.MainGuideManager.UpdateGuideStepsLocation();
 
-            if (warningPopup != null && warningPopup.IsOpen)
-                warningPopup.UpdatePopupLocation();
+            if (fileTrustWarningPopup != null && fileTrustWarningPopup.IsOpen)
+                fileTrustWarningPopup.UpdatePopupLocation();
         }
 
         private void DynamoView_SizeChanged(object sender, SizeChangedEventArgs e)
@@ -763,8 +764,8 @@ private void DynamoView_SizeChanged(object sender, SizeChangedEventArgs e)
             if (dynamoViewModel.MainGuideManager != null)
                 dynamoViewModel.MainGuideManager.UpdateGuideStepsLocation();
 
-            if (warningPopup != null && warningPopup.IsOpen)
-                warningPopup.UpdatePopupLocation();
+            if (fileTrustWarningPopup != null && fileTrustWarningPopup.IsOpen)
+                fileTrustWarningPopup.UpdatePopupLocation();
         }
 
         private void InitializeLogin()
@@ -2495,6 +2496,27 @@ private void FileTrustWarning_Click(object sender, RoutedEventArgs e)
             dynViewModel.FileTrustViewModel.ShowWarningPopup = true;
         }
 
+        private void DynamoView_Activated(object sender, EventArgs e)
+        {
+            if (dynamoViewModel.MainGuideManager != null && dynamoViewModel.MainGuideManager.currentGuide != null)
+            {
+                dynamoViewModel.MainGuideManager.ManagePopupActivation(true);
+            }
+               
+
+            if (fileTrustWarningPopup != null)
+                fileTrustWarningPopup.ManagePopupActivation(true);
+        }
+
+        private void DynamoView_Deactivated(object sender, EventArgs e)
+        {
+            if (dynamoViewModel.MainGuideManager != null && dynamoViewModel.MainGuideManager.currentGuide != null)
+                dynamoViewModel.MainGuideManager.ManagePopupActivation(false);
+
+            if(fileTrustWarningPopup != null)
+                fileTrustWarningPopup.ManagePopupActivation(false);
+        }
+
         public void Dispose()
         {
             viewExtensionManager.Dispose();
@@ -2506,8 +2528,8 @@ public void Dispose()
             // Removing the tab items list handler
             ExtensionTabItems.CollectionChanged -= this.OnCollectionChanged;
 
-            if (warningPopup != null)
-                warningPopup.CleanPopup();
+            if (fileTrustWarningPopup != null)
+                fileTrustWarningPopup.CleanPopup();
         }
     }
 }
diff --git a/src/DynamoCoreWpf/Views/Core/WorkspaceView.xaml b/src/DynamoCoreWpf/Views/Core/WorkspaceView.xaml
@@ -369,7 +369,7 @@
                AllowsTransparency="True"
                Opened="OnContextMenuOpened"
                Placement="MousePoint"
-               StaysOpen="True"
+               StaysOpen="False"
                Style="{StaticResource WorkspaceContextMenuStylePopup}">
             <Popup.Resources>
                 <Style TargetType="{x:Type MenuItem}">
diff --git a/src/DynamoCoreWpf/Views/FileTrust/FileTrustWarning.xaml.cs b/src/DynamoCoreWpf/Views/FileTrust/FileTrustWarning.xaml.cs
@@ -111,6 +111,7 @@ private void SettingsButton_Click(object sender, RoutedEventArgs e)
         private void CloseFileButton_Click(object sender, RoutedEventArgs e)
         {
             fileTrustWarningViewModel.ShowWarningPopup = false;
+            fileTrustWarningViewModel.DynFileDirectoryName = string.Empty;
             if (dynViewModel.CloseHomeWorkspaceCommand.CanExecute(null))
             {
                 dynViewModel.CloseHomeWorkspaceCommand.Execute(null);
@@ -125,6 +126,7 @@ private void YesButton_Click(object sender, RoutedEventArgs e)
         {
             fileTrustWarningViewModel.AllowOneTimeTrust = true;
             fileTrustWarningViewModel.ShowWarningPopup = false;
+            fileTrustWarningViewModel.DynFileDirectoryName = string.Empty;
             RunSettings.ForceBlockRun = false;
             if (FileTrustWarningCheckBox.IsChecked.Value == true)
             {
@@ -164,6 +166,17 @@ internal void CleanPopup()
             }
         }
 
+        /// <summary>
+        /// This method will show/hide the Popup when the main window is Activated or Deactivated
+        /// </summary>
+        internal void ManagePopupActivation(bool activate)
+        {
+            if (dynViewModel.FileTrustViewModel.ShowWarningPopup == !activate &&
+               !string.IsNullOrEmpty(dynViewModel.FileTrustViewModel.DynFileDirectoryName) &&
+               RunSettings.ForceBlockRun == true)
+                IsOpen = activate;
+        }
+
         private void SetUpPopup()
         {
             if (fileTrustWarningViewModel != null)

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ namespace Dynamo.Wpf.UI.GuidedTour`
`9`	`9`	`public delegate void UpdateLibraryInteractionsEventHandler();`
`10`	`10`	`public delegate void GuidedTourStartEventHandler(GuidedTourStateEventArgs args);`
`11`	`11`	`public delegate void GuidedTourFinishEventHandler(GuidedTourStateEventArgs args);`
	`12`	`+ public delegate void GuidedTourExitedEventHandler(GuidedTourStateEventArgs args);`
`12`	`13`
`13`	`14`	`/// <summary>`
`14`	`15`	`/// This static class will be used to raise events when the tooltip, welcome and survey popup buttons are clicked.`
`@@ -18,6 +19,7 @@ public static class GuideFlowEvents`
`18`	`19`	`//Event that will be raised when the Popup Next button is pressed, the value passed as parameter is the current Step Sequence`
`19`	`20`	`public static event GuidedTourNextEventHandler GuidedTourNextStep;`
`20`	`21`	`private static bool isAnyGuideActive { get; set; } = false;`
	`22`	`+ private static bool isGuideExited { get; set; } = false;`
`21`	`23`	`public static void OnGuidedTourNext()`
`22`	`24`	`{`
`23`	`25`	`if (GuidedTourNextStep != null)`
`@@ -39,6 +41,7 @@ internal static void OnGuidedTourStart(string name)`
`39`	`41`	`if (GuidedTourStart != null)`
`40`	`42`	`{`
`41`	`43`	`isAnyGuideActive = true;`
	`44`	`+ isGuideExited = false;`
`42`	`45`	`GuidedTourStart(new GuidedTourStateEventArgs(name));`
`43`	`46`	`}`
`44`	`47`	`}`
`@@ -54,6 +57,13 @@ internal static void OnGuidedTourFinish(string name)`
`54`	`57`	`}`
`55`	`58`	`}`
`56`	`59`
	`60`	`+ //Event that will be raised when the Guide is completely closed (this is specific for the Packages guide that allows the user to continue or exit the guide)`
	`61`	`+ public static event GuidedTourExitedEventHandler GuidedTourExited;`
	`62`	`+ internal static void OnGuidedTourExited(string name)`
	`63`	`+ {`
	`64`	`+ isGuideExited = true;`
	`65`	`+ }`
	`66`	`+`
`57`	`67`	`//Event that will be raised when we want to update the Popup location of the current step being executed`
`58`	`68`	`public static event UpdatePopupLocationEventHandler UpdatePopupLocation;`
`59`	`69`	`public static void OnUpdatePopupLocation()`
`@@ -71,13 +81,22 @@ public static void OnUpdateLibraryInteractions()`
`71`	`81`	`}`
`72`	`82`
`73`	`83`	`/// <summary>`
`74`		`- /// This property will returm if the a guide is being executed or not.`
	`84`	`+ /// This property will return if the a guide is being executed or not.`
`75`	`85`	`/// </summary>`
`76`	`86`	`public static bool IsAnyGuideActive`
`77`	`87`	`{`
`78`	`88`	`get { return isAnyGuideActive; }`
`79`	`89`	`set { isAnyGuideActive = value; }`
`80`	`90`	`}`
	`91`	`+`
	`92`	`+ /// <summary>`
	`93`	`+ /// This property will return a value that says if the tour has been completely closed or not`
	`94`	`+ /// </summary>`
	`95`	`+ public static bool IsGuideExited`
	`96`	`+ {`
	`97`	`+ get { return isGuideExited; }`
	`98`	`+ set { isGuideExited = value; }`
	`99`	`+ }`
`81`	`100`	`}`
`82`	`101`
`83`	`102`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ private void SettingsButton_Click(object sender, RoutedEventArgs e)`
`111`	`111`	`private void CloseFileButton_Click(object sender, RoutedEventArgs e)`
`112`	`112`	`{`
`113`	`113`	`fileTrustWarningViewModel.ShowWarningPopup = false;`
	`114`	`+ fileTrustWarningViewModel.DynFileDirectoryName = string.Empty;`
`114`	`115`	`if (dynViewModel.CloseHomeWorkspaceCommand.CanExecute(null))`
`115`	`116`	`{`
`116`	`117`	`dynViewModel.CloseHomeWorkspaceCommand.Execute(null);`
`@@ -125,6 +126,7 @@ private void YesButton_Click(object sender, RoutedEventArgs e)`
`125`	`126`	`{`
`126`	`127`	`fileTrustWarningViewModel.AllowOneTimeTrust = true;`
`127`	`128`	`fileTrustWarningViewModel.ShowWarningPopup = false;`
	`129`	`+ fileTrustWarningViewModel.DynFileDirectoryName = string.Empty;`
`128`	`130`	`RunSettings.ForceBlockRun = false;`
`129`	`131`	`if (FileTrustWarningCheckBox.IsChecked.Value == true)`
`130`	`132`	`{`
`@@ -164,6 +166,17 @@ internal void CleanPopup()`
`164`	`166`	`}`
`165`	`167`	`}`
`166`	`168`
	`169`	`+ /// <summary>`
	`170`	`+ /// This method will show/hide the Popup when the main window is Activated or Deactivated`
	`171`	`+ /// </summary>`
	`172`	`+ internal void ManagePopupActivation(bool activate)`
	`173`	`+ {`
	`174`	`+ if (dynViewModel.FileTrustViewModel.ShowWarningPopup == !activate &&`
	`175`	`+ !string.IsNullOrEmpty(dynViewModel.FileTrustViewModel.DynFileDirectoryName) &&`
	`176`	`+ RunSettings.ForceBlockRun == true)`
	`177`	`+ IsOpen = activate;`
	`178`	`+ }`
	`179`	`+`
`167`	`180`	`private void SetUpPopup()`
`168`	`181`	`{`
`169`	`182`	`if (fileTrustWarningViewModel != null)`