Merge pull request #200 from Nfactor26/allow-search-on-control-and-prefab-reference-manager-screen

Nfactor26 · web-flow · commit d28c427f4711 · 2022-12-22T17:24:58.000+05:30
Allow searching for controls and prefabs on control and prefab reference manager screen
diff --git a/src/Pixel.Automation.Designer.ViewModels/VersionManager/ControlReferenceManagerViewModel.cs b/src/Pixel.Automation.Designer.ViewModels/VersionManager/ControlReferenceManagerViewModel.cs
@@ -1,13 +1,17 @@
 ﻿using Dawn;
 using Notifications.Wpf.Core;
+using Pixel.Automation.Core.Controls;
 using Pixel.Automation.Core.Models;
 using Pixel.Automation.Editor.Core.Helpers;
 using Pixel.Automation.Editor.Core.Interfaces;
 using Pixel.Automation.Reference.Manager;
 using Pixel.Automation.Reference.Manager.Contracts;
+using Pixel.Automation.TestExplorer.ViewModels;
 using Pixel.Persistence.Services.Client;
 using Serilog;
 using System.Collections.ObjectModel;
+using System.ComponentModel;
+using System.Windows.Data;
 
 namespace Pixel.Automation.Designer.ViewModels.VersionManager
 {
@@ -27,6 +31,25 @@ public class ControlReferenceManagerViewModel : Caliburn.Micro.Screen, IVersionM
         /// </summary>
         public ObservableCollection<ControlReferenceViewModel> References { get; private set; } = new();
 
+        /// <summary>
+        /// Filter text to filter for controls
+        /// </summary>
+        string filterText = string.Empty;
+        public string FilterText
+        {
+            get
+            {
+                return filterText;
+            }
+            set
+            {
+                filterText = value;
+                var fixtureView = CollectionViewSource.GetDefaultView(References);
+                fixtureView.Refresh();
+                NotifyOfPropertyChange(() => FilterText);
+            }
+        }
+
         /// <summary>
         /// constructor
         /// </summary>
@@ -41,10 +64,27 @@ public ControlReferenceManagerViewModel(IApplicationDataManager applicationDataM
             this.controlReferences = this.referenceManager.GetControlReferences();
             foreach(var reference in this.controlReferences.References)
             {
-                var controls = applicationDataManager.GetControlsById(reference.ApplicationId, reference.ControlId);
-                var controlInUse = controls.FirstOrDefault(a => a.Version.Equals(reference.Version));
-                this.References.Add(new ControlReferenceViewModel( reference, controlInUse.ControlName , reference.Version.ToString(), controls.Select(s => s.Version)));
+                var controls = applicationDataManager.GetControlsById(reference.ApplicationId, reference.ControlId);               
+                this.References.Add(new ControlReferenceViewModel( reference, controls));
             }
+            CreateDefaultView();
+        }
+
+        /// <summary>
+        /// Setup the collection view with grouping and sorting
+        /// </summary>
+        private void CreateDefaultView()
+        {
+            var fixtureGroupedItems = CollectionViewSource.GetDefaultView(References);           
+            fixtureGroupedItems.SortDescriptions.Add(new SortDescription(nameof(ControlReferenceViewModel.ControlName), ListSortDirection.Ascending));          
+            fixtureGroupedItems.Filter = new Predicate<object>((a) =>
+            {
+                if (a is ControlReferenceViewModel controlReference)
+                {
+                    return controlReference.ControlName.Contains(FilterText) || controlReference.ControlName.Equals(FilterText);
+                }
+                return true;
+            });
         }
 
         /// <summary>
diff --git a/src/Pixel.Automation.Designer.ViewModels/VersionManager/ControlReferenceViewModel.cs b/src/Pixel.Automation.Designer.ViewModels/VersionManager/ControlReferenceViewModel.cs
@@ -1,5 +1,6 @@
 ﻿using Dawn;
 using Pixel.Automation.Core;
+using Pixel.Automation.Core.Controls;
 using Pixel.Automation.Core.Models;
 using System.Collections.ObjectModel;
 
@@ -10,7 +11,7 @@ namespace Pixel.Automation.Designer.ViewModels.VersionManager
     /// </summary>
     public class ControlReferenceViewModel : NotifyPropertyChanged
     {
-        internal readonly ControlReference controlReference;
+        internal readonly ControlReference controlReference;       
 
         /// <summary>
         /// Name of the Control
@@ -41,6 +42,9 @@ public Version SelectedVersion
             }
         }
 
+        // <summary>
+        /// Indicate if version was changed
+        /// </summary>
         public bool IsDirty { get; private set; }
 
         /// <summary>
@@ -55,16 +59,18 @@ public Version SelectedVersion
         /// <param name="controlName"></param>
         /// <param name="versionInUse"></param>
         /// <param name="availableVersions"></param>
-        public ControlReferenceViewModel(ControlReference controlReference, string controlName, string versionInUse, IEnumerable<Version> availableVersions)
+        public ControlReferenceViewModel(ControlReference controlReference, IEnumerable<ControlDescription> controls)
         {
-            this.controlReference = Guard.Argument(controlReference).NotNull();         
-            this.ControlName = controlName;
-            this.VersionInUse = versionInUse;
-            foreach (var version in availableVersions)
+            Guard.Argument(controls, nameof(controls)).NotNull().NotEmpty();
+            this.controlReference = Guard.Argument(controlReference, nameof(controlReference)).NotNull();
+            var controlInUse = controls.FirstOrDefault(a => a.Version.Equals(controlReference.Version));          
+            this.ControlName = controlInUse.ControlName;
+            this.VersionInUse = controlReference.Version.ToString();
+            foreach (var version in controls.Select(s => s.Version))
             {
                 this.AvailableVersions.Add(version);
             }
-            this.SelectedVersion = this.AvailableVersions.FirstOrDefault(a => a.ToString().Equals(versionInUse)) ?? this.AvailableVersions.First();
+            this.SelectedVersion = this.AvailableVersions.FirstOrDefault(a => a.ToString().Equals(this.VersionInUse)) ?? this.AvailableVersions.First();
             this.IsDirty = false;
         }
     }
diff --git a/src/Pixel.Automation.Designer.ViewModels/VersionManager/PrefabReferenceManagerViewModel.cs b/src/Pixel.Automation.Designer.ViewModels/VersionManager/PrefabReferenceManagerViewModel.cs
@@ -7,6 +7,8 @@
 using Pixel.Persistence.Services.Client.Interfaces;
 using Serilog;
 using System.Collections.ObjectModel;
+using System.ComponentModel;
+using System.Windows.Data;
 
 namespace Pixel.Automation.Designer.ViewModels.VersionManager
 {
@@ -18,8 +20,30 @@ public class PrefabReferenceManagerViewModel : Caliburn.Micro.Screen, IVersionMa
         private readonly INotificationManager notificationManager;
         public readonly PrefabReferences prefabReferences;
 
+        /// <summary>
+        /// Collection of <see cref="PrefabReference"/> usesd in the project
+        /// </summary>
         public ObservableCollection<PrefabReferenceViewModel> PrefabReferences { get; private set; } = new();
 
+        /// <summary>
+        /// Filter text to filter for prefabs
+        /// </summary>
+        string filterText = string.Empty;
+        public string FilterText
+        {
+            get
+            {
+                return filterText;
+            }
+            set
+            {
+                filterText = value;
+                var fixtureView = CollectionViewSource.GetDefaultView(PrefabReferences);
+                fixtureView.Refresh();
+                NotifyOfPropertyChange(() => FilterText);
+            }
+        }
+
         public PrefabReferenceManagerViewModel(IPrefabDataManager prefabDataManager, IReferenceManager referenceManager,
             INotificationManager notificationManager)
         {
@@ -40,6 +64,24 @@ public PrefabReferenceManagerViewModel(IPrefabDataManager prefabDataManager, IRe
                     }
                 }
             }
+            CreateDefaultView();
+        }
+
+        /// <summary>
+        /// Setup the collection view with grouping and sorting
+        /// </summary>
+        private void CreateDefaultView()
+        {
+            var fixtureGroupedItems = CollectionViewSource.GetDefaultView(PrefabReferences);       
+            fixtureGroupedItems.SortDescriptions.Add(new SortDescription(nameof(PrefabReferenceViewModel.PrefabName), ListSortDirection.Ascending));
+            fixtureGroupedItems.Filter = new Predicate<object>((a) =>
+            {
+                if (a is PrefabReferenceViewModel prefabReference)
+                {
+                    return prefabReference.PrefabName.Contains(FilterText) || prefabReference.PrefabName.Equals(FilterText);
+                }
+                return true;
+            });
         }
 
         public async Task SaveAsync()
diff --git a/src/Pixel.Automation.Designer.ViewModels/VersionManager/PrefabReferenceViewModel.cs b/src/Pixel.Automation.Designer.ViewModels/VersionManager/PrefabReferenceViewModel.cs
@@ -4,16 +4,28 @@
 using System.Collections.ObjectModel;
 
 namespace Pixel.Automation.Designer.ViewModels.VersionManager
-{
+{ 
+    /// <summary>
+    /// View Model wrapper for <see cref="PrefabReference"/>
+    /// </summary>
     public class PrefabReferenceViewModel : NotifyPropertyChanged
     {
         internal readonly PrefabReference prefabReference;
 
+        /// <summary>
+        /// Name of the Prefab
+        /// </summary>
         public string PrefabName { get; private set; }
 
+        /// <summary>
+        /// Version of prefaab used in current version of project
+        /// </summary>
         public string VersionInUse { get; private set; }
 
         private PrefabVersion selectedVersion;
+        /// <summary>
+        /// Select version of prefab on view
+        /// </summary>
         public PrefabVersion SelectedVersion
         {
             get => this.selectedVersion;
@@ -29,10 +41,21 @@ public PrefabVersion SelectedVersion
             }
         }
 
+        /// <summary>
+        /// Indicate if version was changed
+        /// </summary>
         public bool IsDirty { get; private set; }
 
+        /// <summary>
+        /// Available versions of Prefab
+        /// </summary>
         public ObservableCollection<PrefabVersion> AvailableVersions { get; private set; } = new();
 
+        /// <summary>
+        /// constructor
+        /// </summary>
+        /// <param name="prefabProject"></param>
+        /// <param name="prefabReference"></param>
         public PrefabReferenceViewModel(PrefabProject prefabProject, PrefabReference prefabReference)
         {
             Guard.Argument(prefabProject).NotNull();
diff --git a/src/Pixel.Automation.Designer.Views/VersionManager/ControlReferenceManagerView.xaml b/src/Pixel.Automation.Designer.Views/VersionManager/ControlReferenceManagerView.xaml
@@ -11,16 +11,21 @@
     </controls:MetroWindow.Resources>
     <Grid>
         <Grid.RowDefinitions>
-            <RowDefinition Height="*"></RowDefinition>
-            <RowDefinition Height="90"></RowDefinition>
+            <RowDefinition Height="Auto"></RowDefinition>
+            <RowDefinition Height="*"></RowDefinition>          
             <RowDefinition Height="60"></RowDefinition>
         </Grid.RowDefinitions>
 
-        <DataGrid Grid.Row="0" x:Name="References" ItemsSource="{Binding References}" MaxHeight="600"
+        <TextBox x:Name="Filter" Grid.Row="0" Text="{Binding FilterText, UpdateSourceTrigger=PropertyChanged}"
+                 controls:TextBoxHelper.ClearTextButton="True" controls:TextBoxHelper.UseFloatingWatermark="True"                     
+                 controls:TextBoxHelper.Watermark="Search"  HorizontalAlignment="Left" MinWidth="400"
+                 VerticalAlignment="Top" Margin="15,20,10,10"></TextBox>
+
+        <DataGrid Grid.Row="1" x:Name="References" ItemsSource="{Binding References}" MaxHeight="600"
                   CanUserSortColumns="True" CanUserAddRows="False" CanUserResizeRows="False" CanUserResizeColumns="True"                 
                   Grid.Column="1" GridLinesVisibility="All"
                   Margin="10" Padding="5" ScrollViewer.HorizontalScrollBarVisibility="Disabled"    
-                  AutoGenerateColumns="False"           
+                  AutoGenerateColumns="False"  EnableRowVirtualization="True"         
                   RowHeaderWidth="0" HorizontalAlignment="Center" VerticalAlignment="Top">
             <DataGrid.Columns>
                 <DataGridTemplateColumn Header="Control Name">
diff --git a/src/Pixel.Automation.Designer.Views/VersionManager/PrefabReferenceManagerView.xaml b/src/Pixel.Automation.Designer.Views/VersionManager/PrefabReferenceManagerView.xaml
@@ -3,8 +3,7 @@
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
              xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
              xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
-             xmlns:iconPacks="http://metro.mahapps.com/winfx/xaml/iconpacks"
-             xmlns:local="clr-namespace:Pixel.Automation.Designer.Views.VersionManager"
+             xmlns:iconPacks="http://metro.mahapps.com/winfx/xaml/iconpacks"           
              xmlns:controls="clr-namespace:MahApps.Metro.Controls;assembly=MahApps.Metro"
              mc:Ignorable="d" WindowStartupLocation="CenterScreen" SizeToContent="WidthAndHeight"
              d:DesignHeight="450" d:DesignWidth="800" MinHeight="450">
@@ -13,16 +12,22 @@
     </controls:MetroWindow.Resources>
     <Grid>
         <Grid.RowDefinitions>
+            <RowDefinition Height="Auto"></RowDefinition>
             <RowDefinition Height="*"></RowDefinition>
             <RowDefinition Height="60"></RowDefinition>
             <RowDefinition Height="60"></RowDefinition>
         </Grid.RowDefinitions>
 
-        <DataGrid Grid.Row="0" x:Name="PrefabReferences" ItemsSource="{Binding PrefabReferences}" MaxHeight="600"
+        <TextBox x:Name="Filter" Grid.Row="0" Text="{Binding FilterText, UpdateSourceTrigger=PropertyChanged}"
+                 controls:TextBoxHelper.ClearTextButton="True" controls:TextBoxHelper.UseFloatingWatermark="True"                     
+                 controls:TextBoxHelper.Watermark="Search"  HorizontalAlignment="Left" MinWidth="400"
+                 VerticalAlignment="Top" Margin="15,20,10,10"></TextBox>
+
+        <DataGrid Grid.Row="1" x:Name="PrefabReferences" ItemsSource="{Binding PrefabReferences}" MaxHeight="600"
                   CanUserSortColumns="True" CanUserAddRows="False" CanUserResizeRows="False" CanUserResizeColumns="True"                 
                   Grid.Column="1" GridLinesVisibility="All"
                   Margin="10" Padding="5" ScrollViewer.HorizontalScrollBarVisibility="Disabled"    
-                  AutoGenerateColumns="False"           
+                  AutoGenerateColumns="False"  EnableRowVirtualization="True"            
                   RowHeaderWidth="0" HorizontalAlignment="Center" VerticalAlignment="Top">
             <DataGrid.Columns>
                 <DataGridTemplateColumn Header="Prefab Name">
@@ -53,13 +58,13 @@
             </DataGrid.Columns>
         </DataGrid>
         
-        <StackPanel Grid.Row="1" x:Name="WarningPanel" HorizontalAlignment="Stretch" VerticalAlignment="Stretch" Margin="{StaticResource ControlMargin}" 
+        <StackPanel Grid.Row="2" x:Name="WarningPanel" HorizontalAlignment="Stretch" VerticalAlignment="Stretch" Margin="{StaticResource ControlMargin}" 
                             Background="{DynamicResource MahApps.Brushes.ValidationSummary3}" Orientation="Horizontal">
             <iconPacks:PackIconMaterial Kind="Alert" Margin="10,0,0,0" VerticalAlignment="Center"/>
             <TextBlock x:Name="WarningMessage" Margin="10,0,0,0" VerticalAlignment="Center"
                                Text="Upgrading Prefab version can be a breaking change. You might need to redo input and output mapping script for Prefab."/>
         </StackPanel>
-        <DockPanel Grid.Row="2" LastChildFill="False">
+        <DockPanel Grid.Row="3" LastChildFill="False">
             <Border DockPanel.Dock="Top" BorderThickness="1" Height="1" HorizontalAlignment="Stretch" Width="{Binding Path=Width,RelativeSource={RelativeSource Mode=FindAncestor,AncestorType={x:Type DockPanel}}}" BorderBrush="{DynamicResource MahApps.Brushes.Accent}"/>
             <Button x:Name="CloseAsync" Content="CANCEL" Width="100" DockPanel.Dock="Right"  Margin="{StaticResource ControlMargin}" Style="{DynamicResource MahApps.Styles.Button.Square}"/>
             <Button x:Name="SaveAsync" Content="Save" DockPanel.Dock="Right" Width="100"  Margin="{StaticResource ControlMargin}" Style="{DynamicResource MahApps.Styles.Button.Square.Accent}"/>

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using Dawn;`
`2`	`2`	`using Pixel.Automation.Core;`
	`3`	`+using Pixel.Automation.Core.Controls;`
`3`	`4`	`using Pixel.Automation.Core.Models;`
`4`	`5`	`using System.Collections.ObjectModel;`
`5`	`6`
`@@ -10,7 +11,7 @@ namespace Pixel.Automation.Designer.ViewModels.VersionManager`
`10`	`11`	`/// </summary>`
`11`	`12`	`public class ControlReferenceViewModel : NotifyPropertyChanged`
`12`	`13`	`{`
`13`		`- internal readonly ControlReference controlReference;`
	`14`	`+ internal readonly ControlReference controlReference;`
`14`	`15`
`15`	`16`	`/// <summary>`
`16`	`17`	`/// Name of the Control`
`@@ -41,6 +42,9 @@ public Version SelectedVersion`
`41`	`42`	`}`
`42`	`43`	`}`
`43`	`44`
	`45`	`+ // <summary>`
	`46`	`+ /// Indicate if version was changed`
	`47`	`+ /// </summary>`
`44`	`48`	`public bool IsDirty { get; private set; }`
`45`	`49`
`46`	`50`	`/// <summary>`
`@@ -55,16 +59,18 @@ public Version SelectedVersion`
`55`	`59`	`/// <param name="controlName"></param>`
`56`	`60`	`/// <param name="versionInUse"></param>`
`57`	`61`	`/// <param name="availableVersions"></param>`
`58`		`- public ControlReferenceViewModel(ControlReference controlReference, string controlName, string versionInUse, IEnumerable<Version> availableVersions)`
	`62`	`+ public ControlReferenceViewModel(ControlReference controlReference, IEnumerable<ControlDescription> controls)`
`59`	`63`	`{`
`60`		`- this.controlReference = Guard.Argument(controlReference).NotNull();`
`61`		`- this.ControlName = controlName;`
`62`		`- this.VersionInUse = versionInUse;`
`63`		`- foreach (var version in availableVersions)`
	`64`	`+ Guard.Argument(controls, nameof(controls)).NotNull().NotEmpty();`
	`65`	`+ this.controlReference = Guard.Argument(controlReference, nameof(controlReference)).NotNull();`
	`66`	`+ var controlInUse = controls.FirstOrDefault(a => a.Version.Equals(controlReference.Version));`
	`67`	`+ this.ControlName = controlInUse.ControlName;`
	`68`	`+ this.VersionInUse = controlReference.Version.ToString();`
	`69`	`+ foreach (var version in controls.Select(s => s.Version))`
`64`	`70`	`{`
`65`	`71`	`this.AvailableVersions.Add(version);`
`66`	`72`	`}`
`67`		`- this.SelectedVersion = this.AvailableVersions.FirstOrDefault(a => a.ToString().Equals(versionInUse)) ?? this.AvailableVersions.First();`
	`73`	`+ this.SelectedVersion = this.AvailableVersions.FirstOrDefault(a => a.ToString().Equals(this.VersionInUse)) ?? this.AvailableVersions.First();`
`68`	`74`	`this.IsDirty = false;`
`69`	`75`	`}`
`70`	`76`	`}`