Added the setTimeout public method for modifying dojo timeout.

Author: Dev-iL

README.md

@@ -24,6 +24,7 @@ published Wednesday, September 7th, 2016.
 [`getWebWindow`](#getWebWindow) - Extract a `webwindow` handle from a `uifigure` handle.  
 [`getWidgetInfo`](#getWidgetInfo) - Get a list of widgets from the dijit registry.  
 [`setStyle`](#setStyle) - Modify a specified style property.  
+[`setTimeout`](#setTimeout) - Override the default timeout for dojo commands, for a specific `uifigure`.  
 [`textAlign`](#textAlign) - Modify text alignment.  
 
 <a name="aboutDojo"></a>
@@ -109,8 +110,8 @@ mlapptools.fontWeight(myGUI.TextArea, 600);
 #### *mlapptools*.**getHTML**(*hUIFigure*)
 ##### Description
 A method for obtaining the HTML code of a uifigure. Intended for R2017b (and onward?) where the CEF URL cannot be 
-simply opened in a browser. The returned HTML is a deep copy, meaning that any changes will **not** modify the `uifigure`
-where it originated from.
+simply opened in a browser. The returned HTML is a deep copy, meaning that any changes will **not** modify the 
+`uifigure` where it originated from.
 
 ##### Examples
 Using the demo GUI generated by `./Demo/DOMdemoGUI.m`
@@ -181,10 +182,24 @@ mlapptools.setStyle(myGUI.TextArea, 'background-image',...
 ```
 
 
+<a name="setTimeout"></a>
+#### *mlapptools*.**setTimeout**(*hUIFig*)
+##### Description
+Modify the amount of time allotted to dojo queries before they are considered "failed due to timeout". This value is
+`uifigure`-specific. If left unmodified, the default value is `5` seconds.
+
+##### Examples
+```MATLAB
+myGUI = DOMdemoGUI;
+mlapptools.setTimeout(myGUI, 3); % This will wait less for dojo queries to finish.
+```
+
+
 <a name="textAlign"></a>
 #### *mlapptools*.**textAlign**(*uiElement*, *alignment*)
 ##### Description
-Set the horizontal text alignment of the specified UI element, `uiElement`, to that specified by the input alignment string, `alignment`. 
+Set the horizontal text alignment of the specified UI element, `uiElement`, to that specified by the input alignment 
+string, `alignment`. 
 
 Valid alignment strings are:
   * `'left'` - Left align (default)

mlapptools.m

@@ -97,8 +97,9 @@ function fontWeight(uiElement, weight)
               'mlapptools:getWebWindow:NotUIFigure',...
               'The provided window handle is not of a UIFigure.');
 
+            to = mlapptools.getTimeout(hUIFig);
             tic
-            while true && (toc < mlapptools.QUERY_TIMEOUT)
+            while true && (toc < to)
                 try
                     hController = struct(struct(hUIFig).Controller);
                     % Check for Controller version:
@@ -120,24 +121,24 @@ function fontWeight(uiElement, weight)
             end
             mlapptools.toggleWarnings('on')
 
-            if toc >= mlapptools.QUERY_TIMEOUT
+            if toc >= to
                 msgID = 'mlapptools:getWidgetID:QueryTimeout';
                 error(msgID, ...
                     'WidgetID query timed out after %u seconds, UI needs more time to load', ...
-                    mlapptools.QUERY_TIMEOUT);
+                    to);
             end
         end % getWebWindow
 
-        function varargout = getWidgetInfo(hUIFig,verbose)
+        function varargout = getWidgetInfo(hUIFig, verboseFlag)
           % A method for gathering information about dijit widgets.
 
           %% Handle missing inputs:
           if nargin < 1 || isempty(hUIFig)
             throw(MException('getWidgetInfo:noHandleProvided',...
               'Please provide a valid UIFigure handle as a first input.'));
           end
-          if nargin < 2 || isempty(verbose)
-            verbose = false;
+          if nargin < 2 || isempty(verboseFlag)
+            verboseFlag = false;
           end
           %% 
           win = mlapptools.getWebWindow(hUIFig);  
@@ -149,7 +150,7 @@ function fontWeight(uiElement, weight)
             try
               widgets{ind1} = jsondecode(win.executeJS(sprintf('W[%d]', ind1)));
             catch % handle circular references:
-              if verbose
+              if verboseFlag
                 disp(['Node #' num2str(ind1-1) ' with id ' win.executeJS(sprintf('W[%d].id', ind1-1))...
                   ' could not be fully converted. Attempting fallback...']);
               end
@@ -223,6 +224,11 @@ function fontWeight(uiElement, weight)
             end
 
         end % setStyle
+        
+        function setTimeout(hUIFig, newTimeoutInSec)
+          % Sets a custom timeout for dojo queries, specified in [s].
+          setappdata(hUIFig, 'QUERY_TIMEOUT', newTimeoutInSec);
+        end
 
         function textAlign(uiElement, alignment)
         % A method for manipulating text alignment.
@@ -271,8 +277,9 @@ function textAlign(uiElement, alignment)
         function [widgetID] = getWidgetID(win, data_tag)
             widgetquerystr = sprintf('dojo.getAttr(dojo.query("[data-tag^=''%s''] > div")[0], "widgetid")', data_tag);
 
+            to = mlapptools.getTimeout(mlapptools.figFromWebwindow(win));
             tic
-            while true && (toc < mlapptools.QUERY_TIMEOUT)
+            while true && (toc < to)
                 try
                     widgetID = win.executeJS(widgetquerystr);
                     widgetID = widgetID(2:end-1);
@@ -289,14 +296,19 @@ function textAlign(uiElement, alignment)
             end
             mlapptools.toggleWarnings('on')
 
-            if toc >= mlapptools.QUERY_TIMEOUT
+            if toc >= to
                 msgID = 'mlapptools:getWidgetID:QueryTimeout';
                 error(msgID, ...
                       'widgetID query timed out after %u seconds, UI needs more time to load', ...
-                      mlapptools.QUERY_TIMEOUT);
+                      to);
             end
         end % getWidgetID
 
+        function to = getTimeout(hFig)
+            to = getappdata(hFig,'QUERY_TIMEOUT');
+            if isempty(to), to = mlapptools.QUERY_TIMEOUT; end
+        end
+        
         function tf = isUIFigure(hList)
             tf = arrayfun(@(x)isa(x,'matlab.ui.Figure') && ...
                               isstruct(struct(x).ControllerInfo), hList);
@@ -371,6 +383,15 @@ function validateAlignmentStr(alignment)
                 error(msgID, 'Invalid font weight specified: ''%s''', weight);
             end
         end % validateFontWeight
+        
+        function hFig = figFromWebwindow(hWebwindow)
+          hFigs = findall(groot, 'Type', 'figure');
+          mlapptools.toggleWarnings('off');
+          hUIFigs = hFigs(arrayfun(@(x)isstruct(struct(x).ControllerInfo), hFigs));
+          ww = arrayfun(@mlapptools.getWebWindow, hUIFigs);
+          mlapptools.toggleWarnings('on');
+          hFig = hFigs(hWebwindow == ww);          
+        end
 
     end % Private Static Methods