Fixes #4027. Add collection search matcher

Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs

@@ -58,7 +58,7 @@ public class CollectionNavigatorTester : Scenario
         "$200.00",
         "$210.99",
         "$$",
-        "appricot",
+        "apricot",
         "arm",
         "丗丙业丞",
         "丗丙丛",

Examples/UICatalog/UICatalogTop.cs

@@ -380,11 +380,6 @@ private void UpdateThemesMenu ()
 
     public static ObservableCollection<Scenario>? CachedScenarios { get; set; }
 
-    // UI Catalog uses TableView for the scenario list instead of a ListView to demonstrate how
-    // TableView works. There's no real reason not to use ListView. Because we use TableView, and TableView
-    // doesn't (currently) have CollectionNavigator support built in, we implement it here, within the app.
-    private readonly CollectionNavigator _scenarioCollectionNav = new ();
-
     // If set, holds the scenario the user selected to run
     public static Scenario? CachedSelectedScenario { get; set; }
 
@@ -561,16 +556,6 @@ private void CategoryView_SelectedChanged (object? sender, ListViewItemEventArgs
                                                                    }
                                                                   );
 
-        // Create a collection of just the scenario names (the 1st column in our TableView)
-        // for CollectionNavigator. 
-        List<object> firstColumnList = [];
-
-        for (var i = 0; i < _scenarioList.Table.Rows; i++)
-        {
-            firstColumnList.Add (_scenarioList.Table [i, 0]);
-        }
-
-        _scenarioCollectionNav.Collection = firstColumnList;
     }
 
     #endregion Category List

Terminal.Gui/Views/CollectionNavigation/CollectionNavigation.cd

@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ClassDiagram MajorVersion="1" MinorVersion="1">
+  <Comment CommentText="Views that use the CollectionNavigation system">
+    <Position X="0.5" Y="0.5" Height="0.458" Width="1.856" />
+  </Comment>
+  <Comment CommentText="Specialized navigators for each collection type (e.g. list, tree etc)">
+    <Position X="4.646" Y="0.5" Height="0.5" Width="3.169" />
+  </Comment>
+  <Comment CommentText="Shared matching component (users should provide alternative implementations of this class if they want to modify collection navigation behaviour)">
+    <Position X="9.448" Y="0.5" Height="0.708" Width="3.169" />
+  </Comment>
+  <Class Name="Terminal.Gui.CollectionNavigatorBase" Collapsed="true">
+    <Position X="6.25" Y="1.5" Width="2" />
+    <TypeIdentifier>
+      <HashCode>AAgEAAAAAAAQAAAIAAEAAgAAAAAABAAEAAAAACwAAAA=</HashCode>
+      <FileName>Views\CollectionNavigation\CollectionNavigatorBase.cs</FileName>
+    </TypeIdentifier>
+    <ShowAsAssociation>
+      <Property Name="Matcher" />
+    </ShowAsAssociation>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.CollectionNavigator" Collapsed="true">
+    <Position X="4.5" Y="3.5" Width="2" />
+    <TypeIdentifier>
+      <HashCode>AAAAAAAAAAAAQAAAAAAAAgAAAAAAAAAEAAAAAAAAAAA=</HashCode>
+      <FileName>Views\CollectionNavigation\CollectionNavigator.cs</FileName>
+    </TypeIdentifier>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.DefaultCollectionNavigatorMatcher">
+    <Position X="9.5" Y="2.5" Width="2.75" />
+    <TypeIdentifier>
+      <HashCode>AAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAQA=</HashCode>
+      <FileName>Views\CollectionNavigation\DefaultCollectionNavigatorMatcher.cs</FileName>
+    </TypeIdentifier>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.TableCollectionNavigator" Collapsed="true">
+    <Position X="4.75" Y="6.5" Width="2.25" />
+    <TypeIdentifier>
+      <HashCode>AAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAEAAAAIAAAAAA=</HashCode>
+      <FileName>Views\CollectionNavigation\TableCollectionNavigator.cs</FileName>
+    </TypeIdentifier>
+  </Class>
+  <Class Name="Terminal.Gui.ListView" Collapsed="true">
+    <Position X="0.5" Y="4.25" Width="1.5" />
+    <TypeIdentifier>
+      <HashCode>AAE+ASAkEnAAABAAKGAggYAZJAIAABEAcBAaAwAQIAA=</HashCode>
+      <FileName>Views\ListView.cs</FileName>
+    </TypeIdentifier>
+    <ShowAsAssociation>
+      <Property Name="KeystrokeNavigator" />
+    </ShowAsAssociation>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.FileDialog" Collapsed="true">
+    <Position X="0.5" Y="5.5" Width="1.75" />
+    <Compartments>
+      <Compartment Name="Nested Types" Collapsed="false" />
+    </Compartments>
+    <TypeIdentifier>
+      <HashCode>iIY4LQFUHDKVIHIESBgigQcFT6GxhBDABGJItBQAwAQ=</HashCode>
+      <FileName>Views\FileDialog.cs</FileName>
+    </TypeIdentifier>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.FileDialogCollectionNavigator" Collapsed="true">
+    <Position X="4.75" Y="5.5" Width="2.25" />
+    <TypeIdentifier>
+      <HashCode>AAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAEAAAAAAAAAAA=</HashCode>
+      <FileName>Views\FileDialogCollectionNavigator.cs</FileName>
+    </TypeIdentifier>
+  </Class>
+  <Class Name="Terminal.Gui.TableView" Collapsed="true" BaseTypeListCollapsed="true">
+    <Position X="0.5" Y="6.5" Width="1.5" />
+    <TypeIdentifier>
+      <HashCode>QwUeAxwgICIAcABIABeR0oBAkhoFGGOBDABgAN3oPEI=</HashCode>
+      <FileName>Views\TableView\TableView.cs</FileName>
+    </TypeIdentifier>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.TreeView" Collapsed="true">
+    <Position X="0.5" Y="3" Width="1.5" />
+    <TypeIdentifier>
+      <HashCode>AAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAA=</HashCode>
+      <FileName>Views\TreeView\TreeView.cs</FileName>
+    </TypeIdentifier>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Class Name="Terminal.Gui.TreeView&lt;T&gt;" Collapsed="true">
+    <Position X="0.5" Y="2" Width="1.5" />
+    <TypeIdentifier>
+      <HashCode>UwAGySBgBSBGMAQgIiCaBDUItJIBSAWwRMQOSgQCwJI=</HashCode>
+      <FileName>Views\TreeView\TreeView.cs</FileName>
+    </TypeIdentifier>
+    <ShowAsAssociation>
+      <Property Name="KeystrokeNavigator" />
+    </ShowAsAssociation>
+    <Lollipop Position="0.2" />
+  </Class>
+  <Interface Name="Terminal.Gui.ICollectionNavigatorMatcher" Collapsed="true">
+    <Position X="9.5" Y="1.5" Width="2.75" />
+    <TypeIdentifier>
+      <HashCode>AAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAA=</HashCode>
+      <FileName>Views\CollectionNavigation\ICollectionNavigatorMatcher.cs</FileName>
+    </TypeIdentifier>
+  </Interface>
+  <Interface Name="Terminal.Gui.IListCollectionNavigator" Collapsed="true">
+    <Position X="3.75" Y="2.25" Width="2" />
+    <TypeIdentifier>
+      <HashCode>AAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=</HashCode>
+      <FileName>Views\CollectionNavigation\IListCollectionNavigator.cs</FileName>
+    </TypeIdentifier>
+  </Interface>
+  <Interface Name="Terminal.Gui.ICollectionNavigator" Collapsed="true">
+    <Position X="3.75" Y="1.5" Width="2" />
+    <TypeIdentifier>
+      <HashCode>AAgAAAAAAAAAAAAIAAAAAAAAAAAABAAAAAAAACgAAAA=</HashCode>
+      <FileName>Views\CollectionNavigation\ICollectionNavigator.cs</FileName>
+    </TypeIdentifier>
+  </Interface>
+  <Font Name="Segoe UI" Size="9" />
+</ClassDiagram>

Terminal.Gui/Text/CollectionNavigator.cs → Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs

@@ -2,9 +2,9 @@
 
 namespace Terminal.Gui;
 
-/// <inheritdoc/>
+/// <inheritdoc cref="CollectionNavigatorBase"/>
 /// <remarks>This implementation is based on a static <see cref="Collection"/> of objects.</remarks>
-public class CollectionNavigator : CollectionNavigatorBase
+internal class CollectionNavigator : CollectionNavigatorBase, IListCollectionNavigator
 {
     /// <summary>Constructs a new CollectionNavigator.</summary>
     public CollectionNavigator () { }
@@ -13,12 +13,12 @@ public CollectionNavigator () { }
     /// <param name="collection"></param>
     public CollectionNavigator (IList collection) { Collection = collection; }
 
-    /// <summary>The collection of objects to search. <see cref="object.ToString()"/> is used to search the collection.</summary>
+    /// <inheritdoc/>
     public IList Collection { get; set; }
 
     /// <inheritdoc/>
     protected override object ElementAt (int idx) { return Collection [idx]; }
 
     /// <inheritdoc/>
     protected override int GetCollectionLength () { return Collection.Count; }
-}
+}