#43 BaseWidget Make a better implementation of requestUpdate, SetupComplete, Dirty flag

Author: rjackey

widgets/+wt/+abstract/BaseWidget.m

@@ -1,68 +1,84 @@
-classdef (Abstract) BaseWidget < matlab.ui.componentcontainer.ComponentContainer & ...
+classdef (Abstract) BaseWidget < ...
+        matlab.ui.componentcontainer.ComponentContainer & ...
+        wt.mixin.BackgroundColorable & ...
+        wt.mixin.PropertyViewable & ...
         wt.mixin.ErrorHandling
     % Base class for a graphical widget
 
-    % Copyright 2020-2021 The MathWorks Inc.
-    
+    % Copyright 2020-2023 The MathWorks Inc.
 
+
     %% Internal properties
-    properties (AbortSet, Transient, NonCopyable, ...
-            Access = {?wt.abstract.BaseWidget, ?matlab.uitest.TestCase} )
+    properties (AbortSet, Transient, NonCopyable, Hidden, SetAccess = protected)
 
-        % List of graphics controls that BackgroundColor should apply to
-        BackgroundColorableComponents (:,1) matlab.graphics.Graphics
+        % The internal grid to manage contents
+        Grid matlab.ui.container.GridLayout
 
     end %properties
-    
-    
-    properties (Transient, NonCopyable, Access = {?matlab.uitest.TestCase})
+
+
+    properties (Transient, NonCopyable, Hidden, SetAccess = private)
+
+        % Internal flag to confirm setup has finished
+        SetupFinished (1,1) logical = false
 
-        % Used internally to indicate when setup has finished
-        SetupFinished_I (1,1) logical = false
+    end %properties
+
+
+    properties (Transient, NonCopyable, UsedInUpdate = true, ...
+            GetAccess = private, SetAccess = protected)
+        
+        % Internal flag to trigger an update call
+        Dirty (1,1) logical = false
 
     end %properties
 
-    
-    properties (Transient, NonCopyable, UsedInUpdate, Access = {?matlab.uitest.TestCase})
+
+    %% Special support for pre-R2021a releases (g2282435)
+    properties (Transient, Access = private)
 
-        % Used internally to request update call
-        RequestUpdate_I (1,1) logical = false
+        % Flag to indicate earlier release (to be updated during setup)
+        IsPre21a (1,1) logical = verLessThan('matlab','9.10')
 
     end %properties
-    
+
 
     %% Debugging Methods
     methods
 
         function forceUpdate(obj)
-           % Forces update to run (For debugging only!)
-           
+            % Forces update to run (For debugging only!)
+
+            disp("DEBUG: Forcing update for " + class(obj));
             obj.update();
-            
+
         end %function
 
     end %methods
 
+
+    %% Constructor
+    methods
+
+        function obj = BaseWidget(varargin)
+
+            % Attach internal postSetup callback
+            args = horzcat(varargin(:), {"CreateFcn",  @(src,evt)postSetup_I(src)});
+
+            % Call superclass constructor
+            obj = [email protected](args{:});
+
+        end %function
+
+    end %methods
 
-    
-    %% Setup
-    properties ( Transient, NonCopyable, ...
-            Access = {?wt.abstract.BaseWidget, ?matlab.uitest.TestCase} )
-        
-        % The internal grid to manage contents
-        Grid matlab.ui.container.GridLayout
-        
-    end %properties
-    
-    
+
+    %% Protected Methods
     methods (Access = protected)
 
         function setup(obj)
             % Configure the widget
-            
-            % Use CreateFcn to tell when setup finishes
-            obj.CreateFcn = @(src,evt)obj.toggleSetupFinished_I();
-            
+
             % Grid Layout to manage building blocks
             obj.Grid = uigridlayout(obj);
             obj.Grid.ColumnWidth = {'1x'};
@@ -71,117 +87,78 @@ function setup(obj)
             obj.Grid.ColumnSpacing = 2;
             obj.Grid.Padding = [0 0 0 0];
 
-            % Listen to BackgroundColor changes
-            addlistener(obj,'BackgroundColor','PostSet',...
-                @(h,e)obj.updateBackgroundColorableComponents());
+        end %function
+
+
+        function postSetup(~)
+            % Optional post-setup method 
+            % (after setup and input arguments set, before update)
 
         end %function
 
-    end %methods
-    
-    
-    
-    %% Protected Methods
-    methods (Access = protected)
 
+        function requestUpdate(obj)
+            % Request update method to run 
+            % (This is for backward compatibility. 
+            % Alternatively just set "obj.Dirty = true")
+
+            % Support for initial release before R2021a
+            if obj.IsPre21a && obj.SetupFinished
+
+                % g2282435 Force a call to update
+                obj.update();
+
+            else
+
+                % Trigger property to request update during next drawnow
+                % (for optimal efficiency)
+                obj.Dirty = true;
+
+            end %if
+            
+        end %function
+        
+
         function updateBackgroundColorableComponents(obj)
             % Update components that are affected by BackgroundColor
+            % (overrides the superclass method)
 
+            % Update grid color
             obj.Grid.BackgroundColor = obj.BackgroundColor;
-            hasProp = isprop(obj.BackgroundColorableComponents,'BackgroundColor');
-            set(obj.BackgroundColorableComponents(hasProp),...
-                "BackgroundColor",obj.BackgroundColor);
+
+            % Call superclass method
+            obj.updateBackgroundColorableComponents@wt.mixin.BackgroundColorable();
 
         end %function
-        
-        
-        function requestUpdate(obj)
-            % Request update method to run
-            
-            if ~obj.SetupFinished_I
-                % Do nothing
-            elseif verLessThan('matlab','9.10')
-                % g228243 Force a call to update
-                obj.update();
-            else
-                % Trigger set of a UsedInUpdate property to request update
-                % during next drawnow. (for optimal efficiency)
-                obj.RequestUpdate_I = true;
-            end
+
+
+        function groups = getPropertyGroups(obj)
+            % Customize the property display
+            % (override to use the mixin implementation, since multiple
+            % superclasses have competing implementations)
+
+            groups = [email protected](obj);
 
         end %function
 
     end %methods
-    
-    
-    
+
+
     %% Private Methods
     methods (Access = private)
 
-        function toggleSetupFinished_I(obj)
+        function postSetup_I(obj)
             % Indicate setup is complete
 
-            obj.SetupFinished_I = true;
+            obj.SetupFinished = true;
             obj.CreateFcn = '';
+
+            % Call any custom postSetup method
+            obj.postSetup();
 
         end %function
 
     end %methods
-    
-    
-    
-    %% Display customization
-    methods (Hidden, Access = protected)
-        
-        function groups = getPropertyGroups(obj)
-            % Customize how the properties are displayed
-            
-            % Ignore most superclass properties for default display
-            persistent superProps
-            if isempty(superProps)
-                superProps = properties('matlab.ui.componentcontainer.ComponentContainer');
-            end
-            
-            % Get the relevant properties
-            allProps = properties(obj);
-            propNames = setdiff(allProps, superProps, 'stable');
-            
-            % Remove props we don't need to see
-            propNames( startsWith(propNames, "Font") ) = [];
-            propNames( matches(propNames, "Enable") ) = [];
-            
-            % Split out the callbacks, fonts
-            isCallback = endsWith(propNames, "Fcn");
-            isColor = endsWith(propNames, "Color");
-            normalProps = propNames(~isCallback & ~isColor);
-            callbackProps = propNames(isCallback & ~isColor);
-            
-            % Define the groups
-            groups = [
-                matlab.mixin.util.PropertyGroup(callbackProps)
-                matlab.mixin.util.PropertyGroup(normalProps)
-                matlab.mixin.util.PropertyGroup(["Position", "Units"])
-                ];
-            
-            % Ignore empty groups
-            groups(~[groups.NumProperties]) = [];
-            
-        end %function
-        
-    end %methods
-    
-    
-    
-    %% Accessors
-    methods
-        
-        function set.BackgroundColorableComponents(obj,value)
-            obj.BackgroundColorableComponents = value;
-            obj.updateBackgroundColorableComponents()
-        end
-        
-    end %methods
-    
-    
-end %classdef
 
+    
+end %classdef