An interesting uitree utility

March 30, 2011 5 Comments

“uitree” is consistently one of the most-popular search terms on this site, together with “uitable” and “uitab”. I also receive frequent questions about tree components in Matlab.
I already wrote a series of articles on Matlab’s built-in semi-documented uitree (starting here), and I am on a constant lookout for additional interesting angles on uitree to post here. Brett Shoelson’s recent review of 2005’s Pick-of-the-Week utilities, provided me with such an opportunity.
One of 2005’s featured utilities, Structure Explorer by Hassan Lahdili, originally written using Microsoft’s TreeView ActiveX control, was apparently rewritten using Matlab’s Java-based uitree. This enables the utility to run on non-Windows platforms and have a more consistent look-and-feel with Matlab’s Java-based GUI:

Hassan Lahdili's Structure Explorer (click to enlarge)

Hassan’s ExploreStruct utility, in addition to being useful as-is, provides a very useful learning tool for uitree integration in Matlab GUI. This utility uses custom icons for different node types, custom callbacks for node expansion (NodeWillExpandCallback) and node selection (NodeSelectedCallback), and tree context (right-click) menu.
Unfortunately, it appears that the ExploreStruct utility has not been updated for compatibility with the latest Matlab releases. This causes numerous warning messages about not using ‘v0’ when calling uitree and uitreenode. I also had to add a call to drawnow following the uitree‘s creation in line #30, otherwise the tree did not appear (due to EDT issues). Also, I had to comment out line #83 (set(root,’UIContextMenu’, cmenu);) which caused an error (“There is no ‘UIContextMenu’ property in the ‘com.mathworks.hg.peer.UITreeNode’ class”) – the tree’s context-menu actually works even without this line.
Finally, I had to fix line #182 so that the node icons will appear correctly:

%pth = [matlabroot, '\work\exp_struct_icons\'];  %old
pth = [fileparts(which(mfilename)) '\exp_struct_icons\'];  %new

ExploreStruct is not documented and does not have extensive error-checking that I would like to see in real-world applications. But it is relatively easy to read and understand due to its use of internal functions and meaningful variable names.
Altogether, aside from the minor nuances mentioned above, I believe that readers who are interested in implementing custom tree objects in their Matlab GUI can learn a lot from this utility, and you can easily adapt its code for your own needs (or if you can’t, I am always willing to help).

5 Responses

Aurélien April 4, 2011 at 01:03 Reply

I often use this utility in my GUIs that I call directly from uimenu . It allows me to check very quickly the contents of my structures. I also added another cell in the right panel (like Name, Size , Class) to display the current value of selected item. Currently it is the best explorer of structure that I found on the FEX.

I am not really surprised that uitable , uitree are the most-popular search terms. IMHO, these features should have been officially implemented and documented in a MATLAB release for a while since they are really helpful.
Amir May 17, 2015 at 01:48 Reply

Hello Yair,

First your blog is really useful and helpful.
I’m working on a GUI that contain a uitree, now I wanted to export that uitree to enable user to save it to an external variable.
but, there is known problem that the java class is not serializable.
Now I’m try to use that uitree utility in order to convert a struct to a uitree, but the utility is not working. (I’m working with R2015a release)
It getting me an error message:
“Error using set
The name ‘UserData’ is not an accessible property for an instance of class
‘com.mathworks.mwswing.MJScrollPane’.

Error in explorestruct (line 37)
set(tmp, ‘UserData’, cell_Data);”

It looks like there is no ‘UserData’ field for MJScrollPane, do you know why this field is unavailable and how to solve it?

Yair Altman May 17, 2015 at 01:56 Reply

MathWorks removed the UserData property (and some other generic properties such as ApplicationData) from Java components a few releases ago. In general, code that relies on undocumented features cannot be expected to work forever, it may indeed break in some future release.

You will need to contact the utility’s creator to adapt it for new Matlab releases, or modify the relevant utility yourself, or hire a consultant to help you.

Peter Cook October 4, 2017 at 02:09 Reply

Yair,
I wrote this to fill a need I’ve had for a lightweight “structure explorer” type utility that lets me navigate a struct quickly without the need to necessarily plot the data. I create the tree as I traverse the structure so I didn’t have to make an ExpandFcn/MousePressedCallback; I also wrote a version that expands all nodes initially but it can be a bit overwhelming for a broad or deep tree (e.g. a struct returned by xml2struct). Maybe you or someone reading this page will find this useful as the original utility doesn’t work in recent MATLAB releases.

function mtree = mapStruct(s)
 
    hFig1 = figure('pos',[32,32,512,960]);
    hFig1.ToolBar = 'none';
    hFig1.MenuBar = 'none';
    hFig1.Name = 'Struct Explorer';
    hFig1.NumberTitle = 'off';
 
    root = uitreenode('v0','root','root',[],false);
    mtree = uitree('v0','Root',root,'Parent',hFig1);
 
    function structTraverse(s,node)
        f = fieldnames(s);
        %explore each field in the input struct s
        for kField = 1 : length(f)
            structField = s.(f{kField}); %structField = getfield(s,f{kField});
 
            %if struct field is a cell array of structs, convert to struct array IFF structs are identical
            if iscell(structField)
                if all(cellfun(@isstruct,structField))
                    try
                        structField = [structField{:}];
                    catch
                        %add some sort of exception handling
                    end
                end
            end
 
            %if the structure field is also a struct explore each field
            if isstruct(structField) %strcmp(structFieldClass,'struct')
                %determine depth of struct field & enumerate if depth > 1
                structDepth = length(structField);
                if structDepth > 1
                    newNode = uitreenode('v0',f{kField},f{kField},[],false);
                    node.add(newNode);
                    %if the depth of the structure field is greater than 1
                    %add a blank parent node then add each layer/depth level as a node in the tree
                    for kLayer = 1:structDepth
                        nodeLayerName = sprintf('%s(%d)',f{kField},kLayer);
                        nextNode = uitreenode('v0', nodeLayerName,nodeLayerName,[],false);
                        newNode.add(nextNode);
                        structTraverse(structField(kLayer),nextNode)
                    end
                else
                    %if the depth of the structure field is 1 add it as a node
                    nextNode = uitreenode('v0',f{kField},f{kField},[],false);
                    node.add(nextNode);
                    structTraverse(structField,nextNode)
                end
            else
                %make a node for the variable/attribute and display information about the variable
                newNode = uitreenode('v0',f{kField},f{kField},[],false);
                [nRow,nCol] = size(structField);
                structFieldClass = class(structField);
                if isempty(structField)
                    displayString = 'empty';
                elseif nRow==1 && ischar(structField)
                    displayString = structField;
                elseif nRow==1 && nCol==1 && any(strcmp(structFieldClass,{'single','double','logical'}))
                    displayString = sprintf('%f',structField);
                else
                    displayString = sprintf('%dx%d %s',nRow,nCol,structFieldClass);
                end
                nextNode = uitreenode('v0',displayString,displayString,[],true);
                newNode.add(nextNode);
                node.add(newNode);
            end
        end
    end
 
    structTraverse(s,root)
    mtree.reloadNode(root)
    mtree.Position(3) = 512;
 
end

function mtree = mapStruct(s) hFig1 = figure('pos',[32,32,512,960]); hFig1.ToolBar = 'none'; hFig1.MenuBar = 'none'; hFig1.Name = 'Struct Explorer'; hFig1.NumberTitle = 'off'; root = uitreenode('v0','root','root',[],false); mtree = uitree('v0','Root',root,'Parent',hFig1); function structTraverse(s,node) f = fieldnames(s); %explore each field in the input struct s for kField = 1 : length(f) structField = s.(f{kField}); %structField = getfield(s,f{kField}); %if struct field is a cell array of structs, convert to struct array IFF structs are identical if iscell(structField) if all(cellfun(@isstruct,structField)) try structField = [structField{:}]; catch %add some sort of exception handling end end end %if the structure field is also a struct explore each field if isstruct(structField) %strcmp(structFieldClass,'struct') %determine depth of struct field & enumerate if depth > 1 structDepth = length(structField); if structDepth > 1 newNode = uitreenode('v0',f{kField},f{kField},[],false); node.add(newNode); %if the depth of the structure field is greater than 1 %add a blank parent node then add each layer/depth level as a node in the tree for kLayer = 1:structDepth nodeLayerName = sprintf('%s(%d)',f{kField},kLayer); nextNode = uitreenode('v0', nodeLayerName,nodeLayerName,[],false); newNode.add(nextNode); structTraverse(structField(kLayer),nextNode) end else %if the depth of the structure field is 1 add it as a node nextNode = uitreenode('v0',f{kField},f{kField},[],false); node.add(nextNode); structTraverse(structField,nextNode) end else %make a node for the variable/attribute and display information about the variable newNode = uitreenode('v0',f{kField},f{kField},[],false); [nRow,nCol] = size(structField); structFieldClass = class(structField); if isempty(structField) displayString = 'empty'; elseif nRow==1 && ischar(structField) displayString = structField; elseif nRow==1 && nCol==1 && any(strcmp(structFieldClass,{'single','double','logical'})) displayString = sprintf('%f',structField); else displayString = sprintf('%dx%d %s',nRow,nCol,structFieldClass); end nextNode = uitreenode('v0',displayString,displayString,[],true); newNode.add(nextNode); node.add(newNode); end end end structTraverse(s,root) mtree.reloadNode(root) mtree.Position(3) = 512; end

Yair Altman October 4, 2017 at 11:17 Reply

@Peter – Thanks for sharing

HTML tags such as <b> or <i> are accepted.
Wrap code fragments inside <pre lang="matlab"> tags, like this:

<pre lang="matlab">
a = magic(3);
disp(sum(a))
</pre>

I reserve the right to edit/delete comments (read the site policies).
Not all comments will be answered. You can always email me (altmany at gmail) for private consulting.

Click here to cancel reply.

Amin zaami (8 hours 52 minutes ago): I have the same problem as Nicholas, The function works fine on R2022, but when compiled it fails (I used com.mathworks.mlwidgets.help.L ightweightHelpPanel), I tried compiling...
Rolf (18 days 15 hours ago): Disclosure: This comes from the developer/vendor of the Code Checker for MATLAB. Have a look at the Code Checker for MATLAB by MonkeyProof Solutions which has many such (configurable)...
Yair Altman (26 days 8 hours ago): In theory you could use the data: URI scheme (e.g. .load('data:text/html,<html ><body>Hello world</body></html>')), but for some reason it doesn’t work well in...
Sebastian (26 days 14 hours ago): Thanks for your update to the now unsupported `HTMLBrowserPanel`. I tried to replace it with the `LightweightHelpPanel` but the application I am working on is showing generated...
Leuze (48 days 15 hours ago): Hello, I would like to add a new object into SLDD and display columns according to my object properties <>
Eric Delgado (77 days 17 hours ago): Hey Yair, I think your site is the right place to share that I wrote ccTools, a lib that allows a lot of customizations of Matlab built-in web components (such as uifigure,...
Eric Delgado (77 days 17 hours ago): Hey guys, first of all, thanks to @Yair, your site saved me a lot of times! 🙂 That’s why I am sharing that I wrote m2mlapp (*.m => *.mlapp) file conversion, that...
François (94 days 15 hours ago): more than 10 years later it helps me after struggling few hours, so thanks you very much !
Yair Altman (95 days 13 hours ago): I am not familiar with a universal catch-all tab-completion mechanism for all functions, and it also doesn’t make much sense to me, because different functions use...
Arye (96 days 7 hours ago): hi, is there a universal functionSignature.json file that will allow my to get the function hints when opening brackets of my funcs? something that automaticly recognize my function...
Sunham (99 days 2 hours ago): This is an old article, but the issue persists even in 2023. 2023a: z = mat2cell(1:1e6,1,repmat(1,1,1e 6)); f = @() cellfun(‘isempty’, z); g = @() cellfun(@isempty,z);...
Yair Altman (108 days 16 hours ago): Robot only runs when you tell it to run a command such as keyPress. If you don’t tell it to run a command, it uses no CPU, so there’s no need to remove the Robot...
Eric (109 days 3 hours ago): Hey @Kevin, can you share your code about create group of figures in the AppContainer? The container of multiples uifigures could be an amazing improvement over AppDesigner and its...
Elsa Smith (109 days 18 hours ago): I recently used java.awt.Robot to perform GUI testing on MATLAB and found it to be an extremely easy and useful way to control mouse movements.
Elsa Smith (109 days 18 hours ago): I’m suspecting that the slow performance of my GUI may be due to the use of java.awt.Robot. Is there a way to cancel/stop/remove the robot after it has been created, or is...

Related posts:

5 Responses

Leave a Reply