HTML support in Matlab uicomponents

A common feature of Java Swing components is their acceptance of HTML (and CSS) for any of their JLabels. Since all Matlab uicontrols are based on Swing-derived components (an undocumented aspect), this Swing feature automatically applies to Matlab uicontrol as well. Whatever can be formatted in HTML (font, color, size, …) is inherently available in Matlab controls. Note that HTML tags do not need to be closed (<tag>…</tag>), although it is good practice to close them properly.

For example, let us create a multi-colored Matlab listbox:

uicontrol('Style','list', 'Position',[10,10,70,70], 'String', ...
{'<HTML><FONT color="red">Hello</Font></html>', 'world', ...
 '<html><font style="font-family:impact;color:green"><i>What a', ...
 '<Html><FONT color="blue" face="Comic Sans MS">nice day!</font>'});

Listbox with HTML'ed items

Listbox with HTML colored items

Menus and tooltips can also be customized in a similar fashion:

uicontrol('Style','popup', 'Position',[10,10,150,100], 'String', ...
{'<HTML><BODY bgcolor="green">green background</BODY></HTML>', ...
 '<HTML><FONT color="red" size="+2">Large red font</FONT></HTML>', ...
 '<HTML><BODY bgcolor="#FF00FF"><PRE>fixed-width font'});

Drop-down (popup uicontrol) with HTML'ed items

Drop-down (popup uicontrol) with HTML'ed items

Multi-line HTML'ed tooltip

Multi-line HTML'ed tooltip

Figure main menu modified with HTML items

Figure main menu modified with HTML items

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

Tags: , ,

Bookmark and SharePrint Print

66 Responses to HTML support in Matlab uicomponents

  1. Ashish Sadanandan says:

    Thanks for starting this blog Yair. It’s fun, and often necessary, to mess with Java directly when doing GUI programming in Matlab and this blog should help a lot with that.

    About displaying HTML in uicontrols, is there a way to do that with static text? Simply changing the style parameter to text in your examples does not work.

    Regards,
    Ashish.

    • This is a good point, Ashish – text uicontrols use a class (com.mathworks.hg.peer.LabelPeer$1 which extends com.mathworks.hg.peer.utils.MultilineLabel) that de-HTMLs the content string for some reason that I do not understanding.

      Instead of using uicontrol(‘style’,’text’,…) you could use javacomponent(‘javax.swing.JLabel’), which uses a standard HTML-compliant label (the string is controlled via its ‘Text’ property).

      Yair

    • Ashish Sadanandan says:

      Perfect! That works, but I ended up using a JButton instead because I could define an ActionPerformedCallback for it, the only way I could figure out to respond to user clicks on a JLabel was to add a mouse listener and I had no idea how to do that on the Matlab side. This is the code I’m using:

      hText = javacomponent( 'javax.swing.JButton' );
      set( hText, 'text', '<a href="http://undocumentedmatlab.com/blog/html-support-in-matlab-uicomponents" rel="nofollow">Select Variable</a>' );
      set( hText, 'BorderPainted', false );
      set( hText, 'ContentAreaFilled', false );
      set( hText, 'FocusPainted', false );  
      set( hText, 'Opaque', true );
      set( hText, 'ActionPerformedCallback', @myCallback );

      Now, the next question is, is there a way to make it behave like a HyperLink on hovering i.e. change the cursor to the hand icon, like it does in a web browser?

    • Ah, Ashish – this one’s easy: to change the cursor to a hand icon, simply do this:

      hText.setCursor(java.awt.Cursor.getPredefinedCursor(java.awt.Cursor.HAND_CURSOR));

      Note that in order to prevent memory leaks, it is advisable to use the jObject.setProperty() or set(handle(jObject),'Property',...) formats, instead of set(jObject,'Property',...).

      Yair

    • Ashish Sadanandan says:

      Thanks for the tip about using the SET function, I was digging around a little bit more about that and came up with this link:
      http://mathforum.org/kb/message.jspa?messageID=5950839&tstart=0

      Is what he says about explicitly setting java handles to [] true? I’m not doing that at the moment, but I could stuff all the java handles into GUIDATA and set them to empty in the DeleteFcn callback for the figure containing the Java components.

      Thanks again for answering all my questions, pretty soon you’ll be able to create a new blog post from just these questions :-)

      Oh and I have some feedback about the website, it’s minor and nothing that a text editor can’t fix in a few seconds, but the code that you post cannot be copy-pasted into the Matlab command line directly because of the ‘, “, … etc. characters which instead of the ASCII versions are some HTML versions. The … for instance is a single character instead of 3 .s

    • Alex F says:

      I need exactly what Ashish needed almost 6 years ago and it’s working (HTML doesn’t work for uicontrol(‘style’, ‘text’)). My question is how do I change the size of the text? I was trying to access the method setFont method under handle.Font but it’s not accessible. How do I change the font size? Thanks.

    • @Alex – assuming you are talking about the Java component and not the Matlab uicontrol, you can do this:

      jLabel = javacomponent(...);
      newFont = java.awt.Font('Helvetica', java.awt.Font.PLAIN, 12);  % font name, style, size
      jLabel.setFont(newFont);
    • Alex F says:

      Yair, thank you for your demon reply. At times it gives the impression you are an 24hr AI software working. :) I used methods(jLabel) yesterday but didn’t show setFont, neither I could tab-complete it. Not sure why. Next time I will assume is there whether I see it or not. Thanks a million.

    • Alex F says:

      Sorry. It should have read ….. demon speed* reply….

    • Next time, use my uiinspect and/or checkClass utilities.

  2. Ashish Sadanandan says:

    Forgot to ask one more question I had. I create the JButton using javacomponent and then call the handle function before setting the ActionPerformedCallback

    hText = javacomponent( ‘javax.swing.JButton’, pos, hPanel );
    hText.setText( ‘MyButton’ );
    hText = handle( hText, ‘CallbackProperties’ );
    set( hText, ‘ActionPerformedCallback’, @VarSelectCallback );

    It seems I can move the line containing the call to the HANDLE function right after creating the JButton and then call all the methods the same way as using the handle returned by javacomponent. Is this true? Are the 2 handles equivalent (other than the fact that you should use the one returned by the HANDLE call to set the callback)?

    • Deleting the java handles (or explicitly setting to []) is really important only for very heavy components (JTable/JTree with lots of data etc.) or for components that keep getting replaced with new instances for programmatic reasons. Otherwise it’s just not worth your programming time…

      Thanks for the feedback about the code snippets font – I fixed it and you can now copy-paste directly into Matlab.

      Your observation about handle() is correct. handle() is a large undocumented topic in Matlab which is on my TODO list. Basically, the handle() object is a Matlab wrapper for the Java reference, and whatever you can do with the Java ref you can do with the handle, with some differences that I’ll detail separately (probably over several posts since the topic is large).

  3. Dani says:

    Can this be used to right align text (or center) in uicontrols? On windows the HorizontalAlignment property only works for text and edit boxes. However, I could not find a html instruction that would do it (p align=right…)

    • Yair Altman says:

      @Dani – the “normal” way to do this is to use HorizontalAlignment. In theory, you could use the style=”text-align:right;” CSS directive. However, it appears that the Java engine does not honor this CSS directive (although it does honor font size/color etc.). it doesn’t hurt to try, just don’t be surprised if it is ignored.

  4. Pingback: Changing Matlab’s Command Window colors - part 2 | Undocumented Matlab

  5. Pingback: Spicing up Matlab uicontrol tooltips | Undocumented Matlab

  6. Jason McMains says:

    Yair, I was messing around with the JLabel HTML, and I have a few different links within it. Is there a way to allow for following these links?

    • Yair Altman says:

      @Jason – you can indeed follow hyperlinks. For a few examples, take a look at my UIINSPECT utility on the File Exchange. Specifically, see the link at the very bottom of the figure window, and also the links within the methods pane on the top-left.

    • Jason McMains says:

      Yair, Thanks for the suggestion. Because I have multiple links, I ended up using a browser instance and inserting the html like this:

      jBrowserPanel=com.mathworks.mlwidgets.html.HTMLBrowserPanel;
      browser = javacomponent(jBrowserPanel,browser_position,gcf);
      html = browser.HTMLRenderer;
      html.setHtmlText(message);
  7. Jason McMains says:

    Just to show another usage of this topic, I’m using it as a font name chooser:

    c=listfonts;
    c=cellfun(@(c) ['<html><Font face="' c '">' c '</font></html>'],c,'uni',false);
    set(findobj('tag','FontName'),'string',c,'value',1)
  8. Pingback: Customizing Matlab labels | Undocumented Matlab

  9. Prasath says:

    An example for Jbutton usage in MATLAB

    function test_javaButton
    import javax.swing.JButton;
    hfig = figure();
    button = JButton('Close');
    [hcomponent, hcontainer] = javacomponent(button, [], hfig);
    set(hcontainer,'units','normalized','position',[.1 .1 .5 .5])
    set(button,'ActionPerformedCallback',@buttonClosePressed);
    return;
     
    function buttonClosePressed(handle,event)
    %doSomething();
    disp('test');
    return;
  10. cintix says:

    Hi,
    Is it possible to assign the color of one plot to what is written inside the listbox?I explain my application: I have an axes and a listbox, when I plot different lines, in the listbox it is shown Plot1,Plot2… and I would like those strings to have the color of its corresponding plotted line…is it possible? I just cant get it…
    Thanks in advance

    • @cintix – yes it is possible. You just need to remember how HTML colors are specified. Here is a very simple example that you can modify for your own needs:

      % Let's modify Plot3 for example:
      color = get(hLine(3),'color');  % => [123,234,45]
      colorStr = sprintf('%d,',int16(color));  % extra ',' is ok
      listStrings{3} = ['<html><font color="rgb(' colorStr ')">Plot3</font></html>'];
      set(hListbox,'string',listStrings);

      Yair

  11. Pingback: Tabbed panes – uitab and relatives | Undocumented Matlab

  12. Fil says:

    Dear all,

    Was just wondering if using this technique I would be able to make some options in a popupmenu change colour and more importantly unselectable?

    Thanks for your invaluable help with this website.

    Fil.

    • @Fil – You can use HTML to define separate item colors (see the example in the main article above), but you can’t define unselectable items.

    • Fil says:

      Thanks Yair,

      So there is no way to create a popupmenu with unselectable options using Matlab or Java?

      Thanks for your help,
      Fil

    • You can use HTML to set popup menu items to gray-italic, but you can’t prevent the user from clicking these items. In your callback, simply ignore any clicks made on your “uselectable” items.

  13. Pingback: Customizing uitree nodes – part 1 | Undocumented Matlab

  14. Aurélien says:

    Hi Yair,

    Just a note about using HTML within uicontrols:

    I use a lot of HTML code for my uicontrols . The only drawback I have found is when you decide to set enable off one of them. For example :

    f = uimenu('Label','Workspace');
    h_ui = uimenu(f,'Label','New Figure','enable','off');

    As the ForegroundColor of “New Figure” label is still in red it is not clear that the label is disabled. I would expect to see the label in grey.

    Currently I remove HTML tags as follows:

    set(rr,'Label',regexprep(get(rr,'Label'),' ]*>', ''),'enable','off')

    Note: The regular expression does not display correctly on your site, I am using this one from this tech-note:
    How can I read an HTML file into MATLAB and discard the HTML tags?

    Except this drawback , using HTML in uicontrols is easy and makes GUIs to be more pretty.

    Aurélien

    • It’s a bit late to answer, but for the record this is a known bug in the JVM (i.e., not a Matlab bug). This bug’s webpage contains several workarounds; the full fix is in JVM 1.7, whose Matlab integration date is currently unknown.

      Sorry for the belated answer – it’s in my book (p. 109) so apparently I knew about this for over a year. I’m not sure why I didn’t answer here immediately…

  15. LL says:

    Hi,
    How to pass a variable in the element?
    var
    for example: I have
    var = 10;

  16. Pingback: Uitable cell colors | Undocumented Matlab

  17. David Goldsmith says:

    Is it only uicontrols that are derived from Java Swing components? If not, how can I detect if a given object is so-derived? E.g., are uipanel’s so-derived? (I’d like to use html tags in a uipanel title; is using a uicontrol(‘Type’, ‘text’) the only way to achieve this? Can I make such an object the value of the uipanel’s Title property, or do I have to basically make the control a separate child of the panel and place it manually in a title-like position?) Thanks!

    • @David – in fact, the uipanel title is actually a simple text uicontrol that is a child of the panel and placed in an appropriate position. You can get its handle (and modify it accordingly) using the hidden uipanel property TitleHandle. You can read more about this and see some ideas of customizing the panel title in an article I posted in 2010: http://UndocumentedMatlab.com/blog/panel-level-uicontrols/

      Text uicontrols do not understand HTML, but you can replace the label with a Java-based label that does. See http://UndocumentedMatlab.com/blog/customizing-matlab-labels/

      Finally, you can always elect to use a JPanel directly, rather than a uipanel – JPanels inherently support HTML in their titles, and also enable rounded corners, which is a nice feature that is lacking in uipanels.

      To find out if there is an underlying Java component to a GUI control, use the findjobj utility. You’ll find that there is no such Java control that underlies uipanels.

    • David Goldsmith says:

      Great, thanks!

  18. Emmanuel Alap says:

    Amazing! However, after trying this on a little experiment (a GUI-based Scientific Calculator), I came across a little problem – how do you implement a delete function on special characters in HTML (such as pi which is &#960)?
    I have a pushbutton which deletes regular characters (numbers and letters) on an MJLabel one-by-one using this code

    htmlString = calcu.wt5.getText;
    textString = html2txt(htmlString);
    if strcmp(textString,'') == 1
       calcu.wt5.setText(txt2html(''));
    else
       ss=char(textString);
       lxt = length(textString);
       textString = ss(1:lxt-1);
       calcu.wt5.setText(txt2html(textString));
    end

    The thing is, I can now use special characters (thanks to your tutorials) on static textboxes. But everytime I use my delete command above, the underlying html code is revealed.

    Before delete:
    &#960

    After single-instance delete:
    &#96

  19. eric says:

    does anyone know how to make accepted a code like :

    set((...),'string','[html] blah blah [img src="../img.png"] [/html]');

    (angle brackets instead of [ ])

    The interesting thing for me would be including some images in my text.
    Thanks !

    • @Eric – you got the HTML img URL syntax wrong, that’s why you don’t see the image. I explained this issue here. Many people seem to have this difficulty so I think I’ll write a dedicated article about it shortly – keep following this blog.

      Note that HTML images only work for “real” uicontrols, but not for text labels that are created via the uicontrol function. I explained a workaround for using HTML in text labels here.

    • eric says:

      thank you Yair !

  20. Pingback: Images in Matlab uicontrols & labels | Undocumented Matlab

  21. Pingback: uiinspect | Undocumented Matlab

  22. dev says:

    Hello Sir,
    I want to display dicom file path using uitree by dicom file series wise

  23. Pingback: Rich-contents log panel | Undocumented Matlab

  24. Eike B. says:

    Hello,

    first thank you for your great blog. It helps a lot!

    Right now I struggle a little with the listbox. I try to generate items that contain multirow text using the “br” tag. Right now the listbox ist not extending the item height so the items are not completely visible. Is there a way to tell the listbox to autosize the items or do I have to somehow manually do that?

    Thanks in advance and best regards

    Eike

  25. Yvo G. says:

    hi,

    i’m searching for a method to change the background color of the whole popupmenu window.
    i learned hear how to change the colors of the text and the direct background of the text,

    but i want to change the color of a whole popup-window when i click on the the button right.
    the matlab control offers only the color changings in the untouched menu window, but not in the whole opened one. this is is always white. eve if i change the colors of the text and its background with this html-method, what really works fine, all the rest background in the menu stays white.

    is there a way to change it ?

    • Yair Altman says:

      I do not know how to do it directly from Matlab. I think you will need to do it using a customized Java control. See here.

  26. For your info I have added a FEX submission for converting str2html. for use in uicontrols and uimenus etc….

    I hope you find it useful!

  27. Hannes says:

    Hello,

    Is it possible to highlight different entries of a listbox separately?

    I am looking for a way to be able to (1) highlight the entry my mouse is currently hovering at and (2) at the same time always keep the currently SELECTED entry highlighted (in a different color) aswell?

    And I am not looking for chaning the color of the string via HTML. I’d like to have the whole “line” highlighted.

    Thank you in advance!

    Hannes

    • Hannes says:

      I figured out a workaround. I have some space on the right of the listbox. I placed a simple static text there, without any string but a certain backgroundcolor. And every time my MouseHoverCallback from the listbox executes I update the y-position of the static text in to the corresponding currently hovered index in a discrete manner.
      This is what it looks like: http://hpewd.dorado.uberspace.de/listbox_example.png. The blue-highlighted entry is the currently selected one.

      That provides a simple indicator. However, this is just a workaround. Maybe someone knows a more proper take on this.

  28. Pingback: Rendering of colored listbox text using HTML in deployed application - Tech Magazine

  29. Aaron says:

    I am trying to write Latin characters in a uimenu, such as: á or ñ. However, the ‘&’ symbol is reserved for uimenus to allow mnemonic access to items and so doesn’t display the characters correctly. Do you know a way around this? Is Java required for this?

    Thanks in advance.

    • Aaron says:

      I was able to fix this by putting an ‘&’ before the string as well as using it as an html character.

  30. Momo says:

    Is it possible to integrate CSS to Matlab Guide ?

    I am trying to create one of the buttons here : https://codepen.io/bartekd/pen/qFsDf in my Matlab Guide figure. Is it feasible ?

    Thank you in advance.

    • @Momo – yes, you can include CSS in your controls, even those created using GUIDE. Simply update the control’s String property to include the relevant HTML info. For example:

      hButton.String = '<html><div style="color:red; text-decoration:line-through;">Click me!';

      Note that not all CSS directives are supported by Java Swing (which is the underlying mechanism that parses the HTML/CSS directives).

    • Momo says:

      @Yair Thank you for your reply.

      I have been trying to include a css file for a while but I always get the html code as a string on the button. Can you help me with this issue ? Please refer to the example below (HTML code and it’s corresponding CSS code).

      HTML CODE: <a href="#" rel="nofollow">green</a>
       
      CSS CODE: .myButton {
      	background-color:#44c767;
      	-moz-border-radius:28px;
      	-webkit-border-radius:28px;
      	border-radius:28px;
      	border:1px solid #18ab29;
      	display:inline-block;
      	cursor:pointer;
      	color:#ffffff;
      	font-family:Arial;
      	font-size:17px;
      	padding:16px 31px;
      	text-decoration:none;
      	text-shadow:0px 1px 0px #2f6627;
      }
      .myButton:hover {
      	background-color:#5cbf2a;
      }
      .myButton:active {
      	position:relative;
      	top:1px;
      }
    • @Momo – you cannot include external CSS files. You need to specify the CSS directives directly in the HTML string as I have shown above.

  31. Meade says:

    Is it possible to change the horizontal & vertical alignment of the pushbutton string with CSS tags?
    I see that most directives work, but I don’t see any effect from:

    hButton.String = '<html><div style="text-align:right">My RIGHT ALIGNED string';

    Much thanks for all you do!

    • @Meade – You can use an HTML string such as this:

      pxPos = getpixelposition(hButton);
      hButton.String = ['<html><div width="' num2str(pxPos(3)-20) 'px" align="right">text'];  % button margins use 20px

      A better solution is to use the findjobj utility as explained here. This would be independent of the button’s pixel-size and would work even when the button is resized.

    • Meade says:

      @Yair

      This is a great work-around!
      I’m guessing by your suggestion that Matlab doesn’t interpret any of the ‘align’ commands for text in naked Matlab uibuttons?
      As for suggestion two, I’m very familiar with your great |findjobj| utility. I use it all the time. I was hoping to avoid jButtons if possible, but they might be best choice afterall.
      Many thanks!
      meade

    • @Meade – it’s not Matlab that ignores the align directive but rather the underlying Java Swing behavior, which snugly fits the text in the center of the button, and of course aligning text within a tight-fitting box has no effect. The workaround I suggested simply forces Swing to use a non-tightly-fitting boundary box, within which you can indeed align the text. It’s a pretty standard HTML/CSS behavior workaround, and any decent web developer could probably find several similar alternatives.

Leave a Reply


Your email address will not be published. Required fields are marked *