- Undocumented Matlab - https://undocumentedmatlab.com -

Adding a context-menu to a uitree

Posted By Yair Altman On March 27, 2009 | 33 Comments

A CSSM poster asked a few days ago whether it was possible to add a context (right-click) menu to uitree nodes. Uitree is an internal, undocumented and unsupported Matlab function, which does not enable easy setting of a uicontextmenu like its uicontrol relatives.

However, using some undocumented Java magic, it is possible to do so. Being undocumented and unsupported, this solution might break in future releases, although this is unlikely since it relies on some very basic Java functionality that is unlikely to be broken soon.

Note that the context-menu in the following example uses HTML formatting. As explained in an earlier post, all Swing components (and by extension, most Matlab uicontrols) support HTML formatting [3].

% Prepare the context menu (note the use of HTML labels)
menuItem1 = javax.swing.JMenuItem('action #1');
menuItem2 = javax.swing.JMenuItem('<html><b>action #2');
menuItem3 = javax.swing.JMenuItem('<html><i>action #3');

% Set the menu items' callbacks
set(menuItem1,'ActionPerformedCallback',@myFunc1);
set(menuItem2,'ActionPerformedCallback',{@myfunc2,data1,data2});
set(menuItem3,'ActionPerformedCallback','disp ''action #3...'' ');

% Add all menu items to the context menu (with internal separator)
jmenu = javax.swing.JPopupMenu;
jmenu.add(menuItem1);
jmenu.add(menuItem2);
jmenu.addSeparator;
jmenu.add(menuItem3);

% Set the tree mouse-click callback
% Note: MousePressedCallback is better than MouseClickedCallback
%       since it fires immediately when mouse button is pressed,
%       without waiting for its release, as MouseClickedCallback does
set(jtree, 'MousePressedCallback', {@mousePressedCallback,jmenu});

% Set the mouse-press callback
function mousePressedCallback(hTree, eventData, jmenu)
   if eventData.isMetaDown  % right-click is like a Meta-button
      % Get the clicked node
      clickX = eventData.getX;
      clickY = eventData.getY;
      jtree = eventData.getSource;
      treePath = jtree.getPathForLocation(clickX, clickY);
      try
         % Modify the context menu or some other element
         % based on the clicked node. Here is an example:
         node = treePath.getLastPathComponent;
         nodeName = ['Current node: ' char(node.getName)];
         item = jmenu.add(nodeName);

         % remember to call jmenu.remove(item) in item callback
         % or use the timer hack shown here to remove the item:
         timerFcn = {@removeItem,jmenu,item};
         start(timer('TimerFcn',timerFcn,'StartDelay',0.2));
      catch
         % clicked location is NOT on top of any node
         % Note: can also be tested by isempty(treePath)
      end

      % Display the (possibly-modified) context menu
      jmenu.show(jtree, clickX, clickY);
      jmenu.repaint;
   end
end

% Remove the extra context menu item after display
function removeItem(hObj,eventData,jmenu,item)
   jmenu.remove(item);
end

% Menu items callbacks must receive at least 2 args:
% hObject and eventData – user-defined args follow after these two
function myfunc1(hObject, eventData)
   % ... 

function myFunc2(hObject, eventData, myData1, myData2)
    % ... 

uitree node-specific context-menu

uitree node-specific context-menu
(note the HTML formatting of menu items)

If the issue of undocumented Matlab interests you, please review the list of future post topics [4] and let me know if you have any preference, or would like to see some other (unlisted) topics.

Yair

Categories: GUI, Java, Low risk of breaking in future versions, UI controls


33 Comments (Open | Close)

33 Comments To "Adding a context-menu to a uitree"

#1 Comment By Darik Gamble On March 27, 2009 @ 7:20 pm

Yair,

I’m glad to see you’ve got a blog — I remember learning from your newsgroup posts a couple years ago that I could add custom properties and event listeners to handle graphics objects, and both features have helped me immensely (and made it into the Matlab documention!)

My votes on your to do list include customizing menus and the two schema topics.

Cheers,

dg

#2 Comment By Venky On March 31, 2009 @ 9:27 pm

Yair,
It’s interesting to know that it is possible to add uicontextmenus to uitree.
Your post saved my time.
Thanks a lot

#3 Comment By Scott Koch On June 9, 2009 @ 3:00 pm

If you have access to the figure handle (stored as User Data for instance) you could also use the click event coordinates to display a GUIDE created context menu:

...
if eventData.isMetaDown
  fh = get(hTree,'UserData');%Get figure handle
  cm = findobj(fh,'tag','mycontextmenu');%Get context menu handle.
  tpos = get(hTree,'PixelPosition');
 
  set(cm,'position',[eventData.getX()+tpos(1) (tpos(4)-eventData.getY)+tpos(2)],'Visible','on');
 
...

#4 Pingback By Setting listbox mouse actions | Undocumented Matlab On September 15, 2009 @ 6:30 am

[…] months ago I explained how to set a context (right-click) menu on a uitree control. I shall now show how to implement a similar dynamic context-menu on a listbox. The code is an […]

#5 Comment By Bass On July 7, 2010 @ 4:35 pm

Awesome article.

I was looking for something that would allow me to create a right click context menu for any figure or uitable.

When I use similar code (see below for example with a figure) I don’t get any context window displayed (although the mousePressedCallback is called). The same code using the handle of juitable, doesn’t even result in the mousePressCallback being called

Am I doing something wrong or is this

h = figure;
juit = findjobj(h);
 
% Prepare the context menu (note the use of HTML labels)
menuItem1 = javax.swing.JMenuItem('action #1');
 
% Set the menu items' callbacks
set(menuItem1,'ActionPerformedCallback',@myFunc1);
 
% Add all menu items to the context menu (with internal separator)
jmenu = javax.swing.JPopupMenu;
jmenu.add(menuItem1);
 
set(juit, 'MousePressedCallback', {@mousePressedCallback,jmenu});
 
function mousePressedCallback(hTree, eventData, jmenu)
   display('here')
   jmenu.repaint;
end

#6 Comment By Yair Altman On July 7, 2010 @ 4:56 pm

@Bassam – you forgot the all-important display of the jmenu:

jmenu.show(jComponent, jEventData.getX, jEventData.getY)

(jComponent can be real or [])

#7 Pingback By Customizing uitree | Undocumented Matlab On August 25, 2010 @ 11:02 am

[…] As an example customization that uses jtree, consider one of my earliest articles on this website: Adding a context-menu to a uitree. […]

#8 Comment By Yan On November 8, 2012 @ 3:03 am

Hi Yair,

Good work, very useful post. I was wondering if you can also add specific Tool Tip on nodes (not for the entire tree) possibly different ones depending on node hierarchy.

Thanks!

#9 Comment By Yair Altman On November 8, 2012 @ 11:37 am

@Yan – you could trap the relevant events using Matlab callbacks, as I have explained in [11]. You’d probably be looking for the MouseMoved event/callback. I explain the mechanism in Section 6.6.3 (page 406) of my [12].

#10 Comment By Nuno Benavente On May 11, 2013 @ 10:26 am

Hello Yair,
First of all, congratulations for your book and excellent blog.
I’ve been trying to implement a context menu to my needs but I’m stuck.
Say my uitree displays a list of text file names (e.g. image1.txt, image2.txt, …)
I want my context menu’s first option to be something like ‘visualize matrix’ of the image I right click in…
How do I pass that information to my 1st context menu option’s callback function?

Thank you very much in advance!
Nuno

#11 Comment By Nuno Benavente On May 12, 2013 @ 8:45 am

Nevermind, I figured out a solution.
Thank you anyway :)

#12 Comment By Nuno Benavente On May 13, 2013 @ 4:58 am

Well, now I have another problem and I suck at java; perhaps you can help?
One of my mtree’s context menu options is ‘delete file’ so, in my callback, after I delete the file, I’d like my tree to be ‘refreshed’ (I’m displaying it in a GUI, with a uipanel as parent).
My approach to create the original nodes was through a for cycle, reading all the files in a given folder and creating the nodes one by one. That works fine, but after I delete one file is there a simple way to ‘redraw’ my mtree inside the same uipanel?

Thanks!

#13 Comment By Yair Altman On May 28, 2013 @ 5:27 pm

@Nuno – you’d need to remove the relevant node and then repaint() the tree object

#14 Comment By Ioannis On January 17, 2014 @ 6:18 am

Dear Yair,

Is it possible by double clicking a specific node of the uitree to open a new GUI window or figure? Can you give an example?

Thanks

#15 Comment By Chris Hoogeboom On March 14, 2014 @ 10:00 am

Hi Yair,

Great article! I’m trying to implement this in MATLAB R2014a, but I am unable to set the ‘MousePressedCallback’ for the uitree object. I get the following error when I try to set it on the tree object returned by uitree

set(tree, 'MousePressedCallback', callback);
 
Error using javahandle_withcallbacks.com.mathworks.hg.peer.UITreePeer/set
The name 'MousePressedCallback' is not an accessible property for an instance of class
'com.mathworks.hg.peer.UITreePeer'.

The following does not work either

set(tree.getTree(), 'MousePressedCallback', callback);
 
Error using DependencyMap/displayReport (line 281)
The name 'MousePressedCallback' is not an accessible property for an instance of class
'com.mathworks.hg.peer.utils.UIMJTree'.

Do you know of any other way to set the MousePressedCallback, or is this undocumented feature broken now?

#16 Comment By Yair Altman On March 15, 2014 @ 5:37 pm

hTree = handle(tree.getTree, 'CallbackProperties');
set(hTree, 'MousePressedCallback', callback);

#17 Comment By Ramiro Massol On March 17, 2014 @ 6:04 am

hi Yair
just to let you know that the new version of matlab, 2014a, has somehow removed all callbacks from JMenuItem. I found this when I tried to use create table with JMenuItems and “ActionPerformedCallback” as a callback (line 493). I’m not sure there’s any way to fix this problem,
best
ramiro

#18 Comment By Chris Hoogeboom On March 18, 2014 @ 11:35 am

You can used the ‘MousePressedCallback’ instead. See Yair’s response to my question above.

#19 Comment By Ramiro Massol On March 20, 2014 @ 5:26 am

hi Yair and Chris
thanks Chris for the tip, but unfortunately the bright minds at Mathworks remove more than just the callbacks for JMenuItems but also almost everything linked to Java. I have many GUIs depending on JTextFields, JComboBoxes, etc, and none of the callbacks show up anymore.
best

#20 Comment By Yair Altman On March 20, 2014 @ 5:44 am

@Ramiro – MathWorks only removed the ability to access callbacks on naked Java references, but you can still use the handle(javaObject,’CallbackProperties’) syntax to use them, just as before. In fact, this has always been the preferred alternative, as explained [13]. If you look at my answer to Chris above, this is exactly what I did.

#21 Comment By Ramiro Massol On March 21, 2014 @ 5:24 am

thanks Yair, the handle syntax works ok now. By the way, I also noticed that the functions enableDisableFig and statusbar don’t work well with the R2014a. I fixed some issues with enableDisableFig (e.g. when using R2014 and setting the enable/edit state, it must be using 1 or 0, nor ‘on’ or ‘off’ as in the past).

#22 Comment By Ramiro Massol On March 25, 2014 @ 5:56 am

hi Yair
I just realized that if I use handle(javaObject,…) anytime in a JMenu, this will prevent normal function of any java controls launched after firing any of the callbacks of the Jmenu. The callbacks of the java controls are triggered but if any of those tries to call subimage, bar, plot, etc, they won’t do anything at all and no errors will show up. Any ideas on this?
best

#23 Comment By Yair Altman On March 25, 2014 @ 3:35 pm

This sounds very strange to me. I haven’t encountered a similar phenomenon before. The HG functions are supposed to be entirely independent of Java, they don’t mix at all.

#24 Comment By Ramiro Massol On March 26, 2014 @ 4:53 am

hi, I agree it’s very odd behavior. It’s easy to reproduce. If you create a GUI (let’s name it FirstGUI) with let’s say a jslider controlling the display on the same GUI of 2 images (use subimage to display them). Then create another GUI figure with a table (use createtable for this) and associate a contextmenu that will just launch the first GUI (the one with the jslider). Now, if you run FirstGUI and launch the jslider GUI using the contextmenu callback, the jslider GUI will display normally and the jslider will work fine scrolling between the 2 images. However, if you use the handle function when creating the JMenuItem of the contextmenu, the jslider callback will be fired but the image shown will not refresh.

#25 Comment By Ramiro Massol On March 27, 2014 @ 6:57 am

a guy at mathworks fixed the problem, I just needed to add:

set(0,'ShowHiddenHandles','on')

to allow for this bug to go away.
best

#26 Comment By Yair Altman On March 27, 2014 @ 7:32 am

It sounds like you have updated the GUI using gcf, gca, or direct plotting (via plot or image), without directly specifying the target container handle. Since you use hidden handles in your code, the function targets whatever GUI container that has a non-hidden handle was last made active. By setting the ShowHiddenProperties of the root you simply made all handles visible, but this merely hides the root cause of your problem, which is the fact that you have not directly specified the target handle. Once you do that, there will no longer be a need for setting ShowHiddenProperties.

In short, it’s an application bug, not a Matlab bug.

#27 Comment By Ramiro Massol On March 27, 2014 @ 11:27 am

I’m not sure it’s an application bug. Before subimage I actually target both the figure and the axes by using “figure(handle); axes(axeshandle)”. I have not used gcf or gca at all. Thanks anyway,
best

#28 Comment By Deepak Bhatia On September 4, 2015 @ 8:45 am

Hi,
I am also trying to set the MousePressedCallback of jtree where jtree is com.mathworks.hg.peer.utils.UIMJTree.
I dont know Java at all but I am modifying an exisiting code to work with ML2015. I get the error

The name 'MousePressedCallback' is not an accessible property for an instance of class 'com.mathworks.hg.peer.utils.UIMJTree

Any Ideas how I can do this: i noticed that the jtree.getTree is also not present.
I just have the following.
jtree.getTreeSelectionListeners
Help will be appreciated

#29 Comment By Yair Altman On September 5, 2015 @ 10:27 am

[14]

#30 Comment By Ian Alan On February 6, 2018 @ 6:29 am

Yair,

I am trying to create a uitree one a resizable panel created with your uisplitpane() function.

The tree won’t show up at all in the figure until I drag the divider around with the mouse to resize the panes, and then it shows up like it should. Do you have any suggestions on how I could fix this?

I am using MATLAB 2011a, if it matters.

#31 Comment By Yair Altman On February 6, 2018 @ 11:20 am

@Ian – try to call the Java object’s repaint() method (function), after adding it to the panel (presumably using a call to javacomponent)

#32 Comment By Hironori Tokuno On September 6, 2018 @ 9:33 am

Hello Mr. Altman

Thank you for this variable informations

How could I get the Output variable from the function “myFunc2” using the command
set(menuItem2,'ActionPerformedCallback',{@myFunc2,data1,data2});” at this case?

% -- Example
function output = myFunc2(hObject, eventData, myData1, myData2)
output = myData1 + myData2;
end

I need to get the variable “output” into my main function after the mouse right button action was performed.

Will you please advise me for this?

Thanks in advance
Best regards
Hiro Tokuno

#33 Comment By Yair Altman On September 6, 2018 @ 10:09 am

@Hironori – callback functions run asynchronously, not synchronously, so they do not return any value. You can save the results in some persistent place (like a global variable or the figure’s UserData property) and in your main program you can later access this data. You can read about Matlab callbacks and how to use them in Matlab’s standard documentation.


Article printed from Undocumented Matlab: https://undocumentedmatlab.com

URL to article: https://undocumentedmatlab.com/blog/adding-context-menu-to-uitree

URLs in this post:

[1] Image: http://undocumentedmatlab.com/feed/

[2] email feed: http://undocumentedmatlab.com/subscribe_email.html

[3] all Swing components (and by extension, most Matlab uicontrols) support HTML formatting: https://undocumentedmatlab.com/blog/html-support-in-matlab-uicomponents/

[4] the list of future post topics: https://undocumentedmatlab.com/todo/

[5] Uicontrol callbacks : https://undocumentedmatlab.com/blog/uicontrol-callbacks

[6] Customizing Matlab labels : https://undocumentedmatlab.com/blog/customizing-matlab-labels

[7] GUI integrated HTML panel : https://undocumentedmatlab.com/blog/gui-integrated-html-panel

[8] Customizing editboxes : https://undocumentedmatlab.com/blog/customizing-editboxes

[9] Editable combo-box : https://undocumentedmatlab.com/blog/editable-combo-box

[10] Smart listbox & editbox scrollbars : https://undocumentedmatlab.com/blog/smart-listbox-editbox-scrollbars

[11] : http://undocumentedmatlab.com/blog/setting-listbox-mouse-actions/

[12] : http://undocumentedmatlab.com/matlab-java-book/

[13] : http://undocumentedmatlab.com/blog/uicontrol-callbacks/

[14] : http://undocumentedmatlab.com/blog/matlab-callbacks-for-java-events-in-r2014a

Copyright © Yair Altman - Undocumented Matlab. All rights reserved.