Rich Matlab editbox contents

In an earlier post, I mentioned that most Matlab uicontrols support HTML strings. Unfortunately, HTML is not supported in multi-line editbox contents. Today I will show how this limitation can be removed for a multi-line editbox, thereby enabling rich contents (enabling HTML for a single-line editbox needs a different solution).

We first need to get the editbox’s underlying Java object, as explained in my previous article about the findjobj utility. Since a multi-line editbox is contained within a scroll-pane, we need to dig within the scrollpane container to find the actual editable area object:

% Create a multi-line (Max>1) editbox uicontrol
hEditbox = uicontrol('style','edit', 'max',5, ...);
 
% Get the Java scroll-pane container reference
jScrollPane = findjobj(hEditbox);
 
% List the scroll-pane's contents:
>> jScrollPane.list
com.mathworks.hg.peer.utils.UIScrollPane[,0,0,100x50,...]
 javax.swing.JViewport[,1,1,81x48,...]
  com.mathworks.hg.peer.EditTextPeer$hgTextEditMultiline[,0,0,81x48,...,kit=javax.swing.text.StyledEditorKit@ce05fc,...]
 com.mathworks.hg.peer.utils.UIScrollPane$1[,82,1,17x48,...]
  com.sun.java.swing.plaf.windows.WindowsScrollBarUI$WindowsArrowButton[,0,31,17x17,...]
  com.sun.java.swing.plaf.windows.WindowsScrollBarUI$WindowsArrowButton[,0,0,17x17,...]
 com.mathworks.hg.peer.utils.UIScrollPane$2[,0,0,0x0,...]
  com.sun.java.swing.plaf.windows.WindowsScrollBarUI$WindowsArrowButton[,0,0,0x0,...]
  com.sun.java.swing.plaf.windows.WindowsScrollBarUI$WindowsArrowButton[,0,0,0x0,...]

In this listing, we see that jScrollPane contains a JViewport and two scrollbars (horizontal and vertical), as expected from standard Java scroll-panes. We need the internal hgTextEditMultiline object:

jViewPort = jScrollPane.getViewport;
jEditbox = jViewPort.getComponent(0);

The retrieved jEditbox reference, is an object of class com.mathworks.hg.peer.EditTextPeer$hgTextEditMultiline, which indirectly extends the standard javax.swing.JTextPane. The default Matlab implementation of the editbox uicontrol simply enables a multi-line vertical-scrollable text area using the system font. However, the underlying JTextPane object enables many important customizations, including the ability to specify different font attributes (size/color/bold/italic etc.) and paragraph attributes (alignment etc.) for text segments (called style runs) and the ability to embed images, HTML and other controls.

Setting rich contents can be done in several alternative ways. From easiest to hardest:

Setting page URL

Use the setPage(url) method to load a text page from the specified URL (any pre-existing editbox content will be erased). The page contents may be plain text, HTML or RTF. The content type will automatically be determined and the relevant StyledEditorKit and StyledDocument will be chosen for that content. Additional StyledEditorKit content parsers can be registered to handle additional content types. Here’s an example loading an HTML page:

jEditbox.setPage('http://tinyurl.com/c27zpt');

where the URL’s contents are:

<html><body>
<img src="images/dukeWaveRed.gif" width="64" height="64">
This is an uneditable <code>JEditorPane</code>, which was
<em>initialized</em> with <strong>HTML</strong> text 
<font size=-2>from</font> a <font size=+2">URL</font>.
<p>An editor pane uses specialized editor kits to read, write,
display, and edit text of different formats. The Swing text 
package includes editor kits for plain text, HTML, and RTF. 
You can also develop custom editor kits for other formats. 
<script language="JavaScript" 
  src="/js/omi/jsc/s_code_remote.js"></script>
</body></html>

Matlab editbox initialized from an HTML webpage URL

Matlab editbox initialized from an HTML webpage URL

Setting the EditorKit and ContentType

Set the requested StyledEditorKit (via setEditorKit()) or ContentType properties and then use setText() to set the text, which should be of the appropriate content type. Note that setting EditorKit or ContentType clears any existing text and left-aligns the contents (hgTextEditMultiline is center aligned by default). Also note that HTML <div>s get their own separate lines and that <html> and <body> opening and closing tags are accepted but unnecessary. For example:

jEditbox.setEditorKit(javax.swing.text.html.HTMLEditorKit);
% alternative: jEditbox.setContentType('text/html');
htmlStr = ['<b><div style="font-family:impact;color:green">'...
           'Matlab</div></b> GUI is <i>' ...
           '<font color="red">highly</font></i> customizable'];
jEditbox.setText(htmlStr)

HTML contents in a Matlab editbox

HTML contents in a Matlab editbox

Let’s show another usage example, of an event log file, spiced with icons and colored text based on event severity. First, define the logging utility function (the icon filenames may need to be changed based on your Matlab release):

function logMessage(jEditbox,text,severity)
   % Ensure we have an HTML-ready editbox
   HTMLclassname = 'javax.swing.text.html.HTMLEditorKit';
   if ~isa(jEditbox.getEditorKit,HTMLclassname)
      jEditbox.setContentType('text/html');
   end
 
   % Parse the severity and prepare the HTML message segment
   if nargin<3,  severity='info';  end
   switch lower(severity(1))
      case 'i',  icon = 'greenarrowicon.gif'; color='gray';
      case 'w',  icon = 'demoicon.gif';       color='black';
      otherwise, icon = 'warning.gif';        color='red';
   end
   icon = fullfile(matlabroot,'toolbox/matlab/icons',icon);
   iconTxt =['<img src="file:///',icon,'" height=16 width=16>'];
   msgTxt = ['&nbsp;<font color=',color,'>',text,'</font>'];
   newText = [iconTxt,msgTxt];
   endPosition = jEditbox.getDocument.getLength;
   if endPosition>0, newText=['<br/>' newText];  end
 
   % Place the HTML message segment at the bottom of the editbox
   currentHTML = char(jEditbox.getText);
   jEditbox.setText(strrep(currentHTML,'</body>',newText));
   endPosition = jEditbox.getDocument.getLength;
   jEditbox.setCaretPosition(endPosition); % end of content
end

Now, let’s use this logging utility function to log some messages:

logMessage(jEditbox, 'a regular info message...');
logMessage(jEditbox, 'a warning message...', 'warn');
logMessage(jEditbox, 'an error message!!!', 'error');
logMessage(jEditbox, 'a regular message again...', 'info');

Rich editbox contents (a log file)

Rich editbox contents (a log file)

HTML editboxes are normally editable, images included. In actual applications, we may wish to prevent editing the display log. To do this, simply call jEditbox.setEditable(false).

Setting a hyperlink handler is easy: first we need to ensure that we’re using an HTML content-type document. Next, set the editbox to be uneditable (hyperlinks display correctly when the editbox is editable, but are unclickable), using jEditbox.setEditable(false). Finally, set the callback function in the editbox’s HyperlinkUpdateCallback property:

jEditbox.setContentType('text/html');
jEditbox.setText('link: <a href= "http://UndocumentedMatlab.com">UndocumentedMatlab.com</a>');
jEditbox.setEditable(false);
hjEditbox = handle(jEditbox,'CallbackProperties');
set(hjEditbox,'HyperlinkUpdateCallback',@linkCallbackFcn);
 
function linkCallbackFcn(src,eventData)
   url = eventData.getURL;      % a java.net.URL object
   description = eventData.getDescription; % URL string
   jEditbox = eventData.getSource;
   switch char(eventData.getEventType)
      case char(eventData.getEventType.ENTERED)
               disp('link hover enter');
      case char(eventData.getEventType.EXITED)
               disp('link hover exit');
      case char(eventData.getEventType.ACTIVATED)
               jEditbox.setPage(url);
   end
end

Hyperlink in editbox

Hyperlink in editbox

Setting the style runs programmatically

Setting the styles programmatically, one style run after another, can be done via the text-pane’s Document property object. Individual character ranges can be set using the Document’s setCharacterAttributes method, or entire style runs can be inserted via insertString. Attributes are updated using the static methods available in javax.swing.text.StyleConstants. These methods include setting character attributes (font/size/bold/italic/strike-through/underline/subscript/superscript and foreground/background colors), paragraph attributes (indentation/spacing/tab-stops/bidi), image icons and any Swing Component (buttons etc.). Here is the end result:

Rich editbox contents: images, controls & font styles

Rich editbox contents: images, controls & font styles

Note that if a styled multi-line editbox is converted to a single-line editbox (by setting hEditbox’s Max property to 1), it loses all style information, embedded images and components. Returning to multi-line mode will therefore show only the plain-text.

Related posts:

  1. Rich-contents log panel Matlab listboxes and editboxes can be used to display rich-contents HTML-formatted strings, which is ideal for log panels. ...
  2. Customizing listbox & editbox scrollbars Matlab listbox and multi-line editbox uicontrols have pre-configured scrollbars. This article shows how they can be customized....
  3. Editbox data input validation Undocumented features of Matlab editbox uicontrols enable immediate user-input data validation...
  4. Customizing help popup contents The built-in HelpPopup, available since Matlab R2007b, has a back-door that enables displaying arbitrary text, HTML and URL web-pages....
  5. Customizing Matlab labels Matlab's text uicontrol is not very customizable, and does not support HTML or Tex formatting. This article shows how to display HTML labels in Matlab and some undocumented customizations...
  6. Setting line position in an edit-box uicontrol Matlab uicontrols have many useful features that are only available via Java. Here's how to access them....

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

Tags: , , ,

Bookmark and SharePrint Print

40 Responses to Rich Matlab editbox contents

  1. Pingback: Customizing listbox & editbox scrollbars | Undocumented Matlab

  2. amichay says:

    Thanks.

    Can you please explain how I can read from the editbox this information – for example what is the color of the first word in the third line?

    I have problems understanding that part or retreiving information.

    • @Amichay – if you use style runs then you can try to use getCharacterAttributes(); if you use HTML you don’t have an easy solution AFAIK, but if you are in control of the data that is placed in the editbox then you can keep meta-data information stored where it can later be retrieved (for example, in the control’s appdata).

  3. amichay says:

    Yair,
    I actually want to get (by copy paste) a text with colored text (such for example as some editros like matlab m-file editor) into the editbox (or if you can suggest something better) and process the text also according to the text color. Can you suggest what to do?

    • @Amichay – when you copy a styled Matlab text, it gets copied as Rich-Text Formatted (RTF) data. Some applications, like MS Word, automatically know how to use RTF data when you paste sch contents into them. If you need to paste into your own application, you need to create a dedicated RTF-sensitive CCP drop target. This is a very technical issue that is well outside the boundaries of this comment (or blog). You can start here.

  4. Youlian says:

    Hello,
    first I would like to thank you for the usefull information I found in your blog. And now to my question: Do you know an easy way to have a matlab editor like features (syntax highliting, smart indent, …) in an editable multiline text box?

    Thank you!

    Best regards

    Youlian

    • @Youlian – Yes it is possible. Here’s a short code snippet demonstrating this (I will provide more details and other possibilities in an article sometime in the upcoming weeks):

      jCodePane = com.mathworks.widgets.SyntaxTextPane;
      codeType = com.mathworks.widgets.text.mcode.MLanguage.M_MIME_TYPE;
      jCodePane.setContentType(codeType)
      str = ['% create a file for output\n' ...
             '!touch testFile.txt\n' ...
             'fid = fopen(''testFile.txt'', ''w'');\n' ...
             'for i=1:10\n' ...
             '    % Unterminated string:\n' ...
             '    fprintf(fid,''%6.2f \\n, i);\n' ...
             'end'];
      str = sprintf(strrep(str,'%','%%'));
      jCodePane.setText(str)
      jScrollPane = com.mathworks.mwswing.MJScrollPane(jCodePane);
      [jhPanel,hContainer] = javacomponent(jScrollPane,[10,10,300,100],gcf);

      SyntaxTextPane panel (Matlab MIME type)
      SyntaxTextPane panel (Matlab MIME type)

  5. Youlian says:

    Hello Yair,

    thank you very much for your fast response. The code you posted worked quite well, with one exception, which is probably Matlab version dependent. The statement:
    codeType = com.mathworks.widgets.text.mcode.MLanguage.M_MIME_TYPE;

    led in Matlab 2008b to the following Matlab error:
    ??? Undefined variable “com” or class
    “com.mathworks.widgets.text.mcode.MLanguage.M_MIME_TYPE”.

    Instead of it I used:
    codeType = com.mathworks.widgets.SyntaxTextPane.M_MIME_TYPE;

    I tested it in Matlab 7.1, 2006b, 2007a and 2008b and it worked well.

    Thank you very much once again!

    Best regards

    Youlian

  6. @Youlian and any other reader interested in syntax highlighting – I posted an expanded article about this topic in http://undocumentedmatlab.com/blog/syntax-highlighted-labels-panels/

  7. Camilo says:

    Hello,
    it’s possible to set this property (Matlab Syntax) in a uicontrol type text?
    thanks.

    Thank you!

    Best regards

    Camilo

  8. Noushin says:

    Hi
    Thank you very much for the useful info. In my GUI, I first read a long string from an editbox (multiple lines) and then I’d like to change the font color of a portion of this text and display it in the same editbox. I’m not familiar with HTML coding but that’s what I did using your example above:

    hEditbox=handles.my_editbox;
    jScrollPane = findjobj(hEditbox);
    jViewPort = jScrollPane.getViewport;
    jEditbox = jViewPort.getComponent(0);
    jEditbox.setEditorKit(javax.swing.text.html.HTMLEditorKit);
    htmlStr = [str_part1,'<b>', str_part2,'</b>', str_part3);
    jEditbox.setText(htmlStr);

    the formatted string is displayed in the editbox however, it is no longer divided nicely between multiple lines! There is a very long first line where most of the string is out of the right margin. I was wondering is there is another setting that I need to tune for this to be properly displayed?

    I appreciate your help, Noushin

    • @Noushin – of course; HTML is not multi-line by default, as you will notice if you prepare a multi-line HTML file and load it in your browser. To separate lines, you can use the HTML <p> or <br> tags. The W3Schools website is a good reference & tutorial for HTML and related technologies.

  9. Jorge says:

    Nice article with useful information. But i have problem. I try overline text, but it doesnt work.

    htmlStr = ['Matlab'];
    jEditbox.setText(htmlStr)

    Is there any change, how to make overline text ?

    Thank you for answer

  10. Andrew says:

    Hi Yair,
    I’m creating a message log on an application I’m working on. I appreciate your tutorial on how to do this using HTML tags. I saw on the w3school website that the HTML “font” tag has been depricated. It says to use style tags instead. I tried modifying your logMessage function to use styles instead of the depricated tags. When I do this, it only works for the most recent line. When I looked closer, it appeared that either “setText” or “getText” is removing a bunch of the HTML tags I put in. As a result, all the previous lines show up unformatted. Please let me know your thoughts.
    Thanks!
    ~Andrew

    • @Andrew – only a subset of CSS is processed correctly by Swing (which is used for Matlab’s controls). I showed a simple example of using CSS styles in the EditorKit section of the article, but note that many style directives are simply ignored. The Font tag may be deprecated but it works great…

      Re setText(), remember that it sets the entire text, so you must preserve the previous hyper-text tags and styles when you add new lines. There’s no magic in there, recheck your code.

    • Andrew says:

      Hi Yair,
      Thanks for the feedback. I’ve got one more question for ya. I’m using your logMessage function (modified for my purposes). Any idea on how I could keep the log window from flickering when it updates? It looks like, when you set the text, it jumps to the top, then when setting the caret position, it jumps back down. Is there any way to default it to the bottom of the text?
      Thanks!
      ~Andrew

    • @Andrew – try calling drawnow only after you update the underlying Java component. Also, keep the Java handle cached in the listbox’s UserData or ApplicationData properties (or some other place) so that you don’t need to call findjobj each time you update the log.

  11. Nick says:

    Hi Yair,

    How did you get the text to wrap in the “Setting the style runs programmatically” section above? When I place a long line in a multiline editbox formatted for HTML, it continues past the right boundary of the box without wrapping. Did you manually insert breaks in the HTML? Or did the box handle wrapping automatically via some setting?

  12. Nick says:

    Here’s an example of “Setting the style runs programmatically”. I thought it might save folks a little time if they want to, for instance, highlight a certain character or do other formatting without involving HTML.

    % Create new figure and edit box populated with string
    f = figure;
    editboxString = sprintf('Summary Results\nResult: Fail\nCriteria: 1,2,3\nTest Path: c:/users/nick/asdfasdfkasdaadsfvsd/asdfasdfas/fdadsfa/asdfsadf/adsfa');
    h = uicontrol('Style','edit','Position',[70 70 200 300],'max',5, 'HorizontalAlignment','Left', 'String',editboxString);
     
    % Get Java components of editbox
    jScrollPane = findjobj(h);
    jViewPort = jScrollPane.getComponent(0);
    jEditbox = jViewPort.getComponent(0);
    jDocument = jEditbox.getDocument();
     
    % Create new attribute set to highlight "Fail" in red
    jAttributeSet = javax.swing.text.SimpleAttributeSet();
    jColor = java.awt.Color(1,0,0);
    javax.swing.text.StyleConstants.setForeground(jAttributeSet,jColor);
     
    % Search for "Fail" and highlight it
    indices = strfind(editboxString,'Fail');
    if ~isempty(indices)   
       for iLoop = 1:length(indices)
          % Note: subtract 1 for Java 0-based indices
          jDocument.setCharacterAttributes(indices(iLoop)-1,length('Fail'),jAttributeSet,true);
       end
    end
  13. Chris Hoogeboom says:

    Hi Yair,

    Thanks so much for your site. It has been incredibly useful!

    I am currently making something similar to your log message function above. I’ve enabled HTML in my message box by calling

    jEditbox.setContentType('text/html');

    and I’ve disabled the editing of text by calling

    jEditbox.setEditable(false);

    Unfortunately, I can’t select the text anymore (eg. to copy it)! Do you have any idea why this might be? Let me know if you need any more details!

    Best,

    Chris

    • Chris Hoogeboom says:

      Nevermind… I immediately figured it out after posting my comment!

      I had set the ‘MouseDownCallback’ to send focus elsewhere.

  14. Keming says:

    Dear Yair,

    I have modified your logMessage function for my purposes. I am able to show a text on the edit box like what I want by logMessage function , but I don’t know how to remove all the text from the edit box.
    Actually, I can remove all text by first time to use “set(handles.edit,’String’,”)”. But if I implement logMessage to show text again, the code “set(handles.edit,’String’,”)” is not working any more!
    Could you please to help me sovle this problem?
    Thank you in advance!

  15. Pingback: Real-time trading system demo | Undocumented Matlab

  16. Shakes says:

    Hello,

    This is very useful.

    I have used your editbox example and I can format it exactly the way I want. However, when I added a hyperlink I want it to be like this:
    <a href="a=3">Name</a>

    So it executes something in Matlab. However it throws an error:
    Error using TradeDetails>linkCallbackFcn (line 152)
    Java exception occurred:
    java.io.IOException: invalid url

    at javax.swing.JEditorPane.setPage(Unknown Source)

    From an editbox like this how can I execute a matlab function?

    Thank you.

    • Yair Altman says:

      @Shakes – Matlab commands typically need the “matlab:” prefix (see here for example). However, I am not sure that this is supported in editbox hyperlinks.

    • Shakes says:

      Thank you for the quick reply Yair. I forgot to include that in the post but I did include it but it did not work.

      Instead I just entered a link such as magic(4)

      URL does not show it in your example but the description does (as a string of course – saw it after my reply here). I used that to execute it. So little bit of a workaround but it is effective!

      Thank you very much.

  17. Hannah says:

    Hi Yair,

    Thank you again for this post, this is very useful! I was wondering if I could do the same thing for a msgbox() application? Like is there a way similar to this to also edit the text in java/html using a msgbox?

    • @Hanna – a msgbox is simply a small figure window that has a text label, uicontrol button and (optionally) an axes that displays an icon. Take a look at msgbox.m, it’s pretty simple. You can do the same thing in your own figure window, placing an editbox in there. Then you can customize it as shown in the article.

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

  19. Ravi says:

    hi,

    I’m new to matlab but i have been working on a project where a data from the gui login frame have to be saved on word file(.doc) i have created login frame but unable to get the data into word file. can u please help me on this.

Leave a Reply

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

*

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