Merge pull request #159 from mathworks/158-add-searcheditfield-widget

rjackey · web-flow · commit 0dc731723d57 · 2025-09-12T07:59:14.000-04:00
158 add searcheditfield widget
diff --git a/deploy/images/SearchDropdownExampleOpen.png b/deploy/images/SearchDropdownExampleOpen.png
diff --git a/deploy/images/SearchDropdownExampleSearching.png b/deploy/images/SearchDropdownExampleSearching.png
diff --git a/deploy/widget_icons/SearchDropdown.png b/deploy/widget_icons/SearchDropdown.png
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/JMJb_dCLyH7X_iHp2DLoMYNEdokd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/JMJb_dCLyH7X_iHp2DLoMYNEdokd.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/J_q8ERiDV2uofqHvpCu2mo8uB9Ad.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/J_q8ERiDV2uofqHvpCu2mo8uB9Ad.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/S9wGd_pDd1D_9FNVqjfXodz45sod.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/S9wGd_pDd1D_9FNVqjfXodz45sod.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/V0mMK9LtsBu9P5LKljXbNE-C5qwd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/V0mMK9LtsBu9P5LKljXbNE-C5qwd.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/YjX3mbPy2HN8LR96rq4Fzb372VUd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/YjX3mbPy2HN8LR96rq4Fzb372VUd.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/fgSmFlkgej181VWOoxvdiZJ1K9gd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/fgSmFlkgej181VWOoxvdiZJ1K9gd.xml
@@ -1,6 +1,6 @@
-<?xml version='1.0' encoding='UTF-8'?>
+<?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/qR28PGzPsksFVChmMp9R0Zbo0uYd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/qR28PGzPsksFVChmMp9R0Zbo0uYd.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Info>
     <Category UUID="FileClassCategory">
-        <Label UUID="design"/>
+        <Label UUID="test"/>
     </Category>
 </Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/xTX_9QKVz_sRcYaTywWZA4aZm4kd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/xTX_9QKVz_sRcYaTywWZA4aZm4kd.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="test"/>
+    </Category>
+</Info>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/xTX_9QKVz_sRcYaTywWZA4aZm4kp.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/xTX_9QKVz_sRcYaTywWZA4aZm4kp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="SearchDropDown.m" type="File"/>
diff --git a/resources/project/elO4D6tOV7Lp-Jfo7ptgr2NlB30/mBLWFebZLKEYjmQwRCNBG-dcvOEd.xml b/resources/project/elO4D6tOV7Lp-Jfo7ptgr2NlB30/mBLWFebZLKEYjmQwRCNBG-dcvOEd.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>
diff --git a/resources/project/elO4D6tOV7Lp-Jfo7ptgr2NlB30/mBLWFebZLKEYjmQwRCNBG-dcvOEp.xml b/resources/project/elO4D6tOV7Lp-Jfo7ptgr2NlB30/mBLWFebZLKEYjmQwRCNBG-dcvOEp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="SearchDropDown.m" type="File"/>
diff --git a/resources/project/f1CasPtPWEKkULO6lQ_WTjau2Nw/thSBeYSSaW6FYs_WYLbsJvWC9Acd.xml b/resources/project/f1CasPtPWEKkULO6lQ_WTjau2Nw/thSBeYSSaW6FYs_WYLbsJvWC9Acd.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>
diff --git a/resources/project/f1CasPtPWEKkULO6lQ_WTjau2Nw/thSBeYSSaW6FYs_WYLbsJvWC9Acp.xml b/resources/project/f1CasPtPWEKkULO6lQ_WTjau2Nw/thSBeYSSaW6FYs_WYLbsJvWC9Acp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="SearchDropDownExample.mlx" type="File"/>
diff --git a/resources/project/qPaYXYIWInHoCm9ctG8-uEqdxlk/Kc8NyOxBHteHzaAs2Svjccxs8jsd.xml b/resources/project/qPaYXYIWInHoCm9ctG8-uEqdxlk/Kc8NyOxBHteHzaAs2Svjccxs8jsd.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info/>
diff --git a/resources/project/qPaYXYIWInHoCm9ctG8-uEqdxlk/Kc8NyOxBHteHzaAs2Svjccxs8jsp.xml b/resources/project/qPaYXYIWInHoCm9ctG8-uEqdxlk/Kc8NyOxBHteHzaAs2Svjccxs8jsp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="SearchDropdown.png" type="File"/>
diff --git a/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/_08KYHmkQrwI4wltgg7WZLZLxR4d.xml b/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/_08KYHmkQrwI4wltgg7WZLZLxR4d.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info/>
diff --git a/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/_08KYHmkQrwI4wltgg7WZLZLxR4p.xml b/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/_08KYHmkQrwI4wltgg7WZLZLxR4p.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="SearchDropdownExampleOpen.png" type="File"/>
diff --git a/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/rVbGKXEYIRCxCGbb4rKJ4OqWDVod.xml b/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/rVbGKXEYIRCxCGbb4rKJ4OqWDVod.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>
diff --git a/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/rVbGKXEYIRCxCGbb4rKJ4OqWDVop.xml b/resources/project/sSpxFEkGAHXZFJ64I8GyrijBl1s/rVbGKXEYIRCxCGbb4rKJ4OqWDVop.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="SearchDropdownExampleSearching.png" type="File"/>
diff --git a/test/+wt/+test/BaseTest.m b/test/+wt/+test/BaseTest.m
@@ -191,13 +191,34 @@ function verifyPropertyValue(testCase, component, property, expValue)
                 expValue
             end
 
-            import matlab.unittest.constraints.Eventually
-            import matlab.unittest.constraints.IsEqualTo
+            import matlab.unittest.constraints.*
 
             % Verify values
+            if isStringScalar(expValue)
+
+                constraint = IsEqualTo(expValue,...
+                    "Using", StringComparator);
+
+            elseif islogical(expValue)
+
+                constraint = IsEqualTo(expValue,...
+                    "Using", LogicalComparator);
+
+            elseif isnumeric(expValue)
+
+                constraint = IsEqualTo(expValue,...
+                    "Using", NumericComparator);
+
+            else
+
+                constraint = IsEqualTo(expValue);
+
+            end
+
+            % Perform the verification
             testCase.verifyThat(...
                 @()get(component, property),...
-                Eventually(IsEqualTo(expValue), "WithTimeoutOf", 5));
+                Eventually(constraint, "WithTimeoutOf", 5));
             
         end %function
         
diff --git a/test/+wt/+test/BaseWidgetTest.m b/test/+wt/+test/BaseWidgetTest.m
@@ -114,6 +114,10 @@ function verifySetProperty(testCase,propName,newValue,expValue)
             % Verify new property value
             actualValue = testCase.Widget.(propName);
             testCase.verifyEquality(actualValue, expValue);
+
+            % Tried to use this one, but the above works better because
+            % strings can equate to enumeration strings, etc.
+            % testCase.verifyPropertyValue(testCase.Widget, propName, expValue);
             
         end %function
         
@@ -134,7 +138,7 @@ function verifySetPropertyError(testCase,propName,newValue,errorId)
         end %function
         
         
-        function verifyTypeAction(testCase,control,newValue,propName,expValue)
+        function verifyTypeAction(testCase,component,newValue,propName,expValue)
             
             % If no expected new value after set was given, assume it
             % matches the newValue provided as usual
@@ -143,12 +147,16 @@ function verifyTypeAction(testCase,control,newValue,propName,expValue)
             end
             
             % Type the new value into the control
-            testCase.type(control, newValue);
+            testCase.type(component, newValue);
             
             % Verify new property value
             actualValue = testCase.Widget.(propName);
             testCase.verifyEquality(actualValue, expValue);
-            
+
+            % Tried to use this one, but the above works better because
+            % strings can equate to enumeration strings, etc.
+            % testCase.verifyPropertyValue(component, propName, expValue);
+
         end %function
         
         
diff --git a/test/+wt/+test/SearchDropDown.m b/test/+wt/+test/SearchDropDown.m
@@ -0,0 +1,129 @@
+classdef SearchDropDown < wt.test.BaseWidgetTest
+    % Implements a unit test for a widget or component
+    
+    %   Copyright 2025 The MathWorks Inc.
+
+    %% Properties
+    properties
+        ItemNames = [
+            "Voltage A"
+            "Voltage B"
+            "Current A"
+            "Current B"
+            "Power A"
+            "Power B"
+            ];
+        ItemData = [
+            11
+            12
+            21
+            22
+            31
+            32
+            ];
+    end
+
+    
+    %% Class Setup
+    methods (TestClassSetup)
+        
+        function createFigure(testCase)
+            
+            % Start with superclass
+            testCase.createFigure@wt.test.BaseWidgetTest();
+            
+            % Adjust grid size
+            testCase.Figure.Position(3:4) = [1200 700];
+            testCase.Grid.RowHeight = repmat({'fit'},1,4);
+            testCase.Grid.ColumnWidth = repmat({'1x'},1,6);
+            
+        end %function
+        
+    end %methods
+    
+    
+    %% Test Method Setup
+    methods (TestMethodSetup)
+        
+        function setup(testCase)
+            
+            fcn = @()wt.SearchDropDown(testCase.Grid);
+            testCase.Widget = verifyWarningFree(testCase,fcn);
+            drawnow
+            
+            % Set the initial items
+            testCase.verifySetProperty("Items", testCase.ItemNames);
+
+            % Verify empty default
+            expValue = "";
+            testCase.verifyPropertyValue(testCase.Widget, "Value", expValue)
+            testCase.verifyPropertyValue(testCase.Widget.EditField, "Value", char(expValue))
+
+            % Set callback
+            testCase.Widget.ValueChangedFcn = @(s,e)onCallbackTriggered(testCase,e);
+            
+        end %function
+        
+    end %methods
+    
+    
+    %% Unit Test
+    methods (Test)
+
+        function testValueProperty(testCase)
+
+            % Get the component
+            comp = testCase.Widget;
+
+            % Set a value from the list
+            expValue = testCase.ItemNames(3);
+            testCase.Widget.Value = expValue;
+            testCase.verifyPropertyValue(comp, "Value", expValue)
+            testCase.verifyPropertyValue(comp.EditField, "Value", char(expValue))
+
+            % Clear the value
+            expValue = "";
+            testCase.Widget.Value = expValue;
+            testCase.verifyPropertyValue(comp, "Value", expValue)
+            testCase.verifyPropertyValue(comp.EditField, "Value", char(expValue))
+
+            % Verify number of callbacks so far
+            testCase.verifyCallbackCount(0)
+
+        end %function
+
+        
+
+        function testInteractivePartialSearch(testCase)
+
+            % Get the component
+            comp = testCase.Widget;
+
+            % Simulate typing to filter the dropdown items
+            testCase.type(comp.EditField, "urren")
+            testCase.verifyPropertyValue(comp.ListBox, "Items", cellstr(testCase.ItemNames(3:4)'));
+
+            % Verify number of callbacks so far
+            testCase.verifyCallbackCount(1)
+
+            % Ensure the listbox is showing
+            % It might not be due to the nature of the type command
+            comp.SearchPanel.Visible = true;
+
+            % Simulate selecting the second item from the filtered list
+            testCase.choose(comp.ListBox, 2);
+
+            testCase.verifyPropertyValue(comp, "Value", testCase.ItemNames(4));
+            testCase.verifyPropertyValue(comp.EditField, "Value", char(testCase.ItemNames(4)));
+
+            % Verify number of callbacks so far
+            testCase.verifyCallbackCount(2)
+
+            % Verify the list is no longer visible
+            testCase.verifyNotVisible(comp.SearchPanel)
+
+        end %function
+        
+    end %methods (Test)
+    
+end %classdef
diff --git a/widgets/+wt/SearchDropDown.m b/widgets/+wt/SearchDropDown.m
diff --git a/widgets/doc/WidgetsList.mlx b/widgets/doc/WidgetsList.mlx
diff --git a/widgets/examples/SearchDropDownExample.mlx b/widgets/examples/SearchDropDownExample.mlx
diff --git a/widgets/resources/appDesigner.json b/widgets/resources/appDesigner.json
