«
»

Setting system tray popup messages

Tuesday, March 31st, 2009

Continuing my previous post about setting system-tray icons, I will now show how to set informational popup messages next to these icons.

Asynchronous informational messages can be presented next to the sys-tray icon, in a fashion similar to what we came to expect from modern programs. This could be used to indicate some unexpected event that was detected, or the end of a complex calculation phase. The message title, text and severity icon are all customizable.

Unfortunately, the Java method used to display messages, java.awt.TrayIcon.displayMessage(), expects an object of type java.awt.TrayIcon.MessageType, which is an enumeration within the TrayIcon class. However, Matlab’s dot-notation does not recognize what should have been the following correct notation, so we need to resort to Java reflection:

>> trayIcon.displayMessage('title','info msg',TrayIcon.MessageType.INFO);
??? No appropriate method or public field MessageType for class java.awt.TrayIcon

>> trayIconClasses = trayIcon.getClass.getClasses;
>> trayIconClasses(1)
ans =
class java.awt.TrayIcon$MessageType	<= hurray!!!
>> MessageTypes = trayIconClasses(1).getEnumConstants
MessageTypes =
java.awt.TrayIcon$MessageType[]:
    [java.awt.TrayIcon$MessageType]	<= 1: ERROR
    [java.awt.TrayIcon$MessageType]	<= 2: WARNING
    [java.awt.TrayIcon$MessageType]	<= 3: INFO
    [java.awt.TrayIcon$MessageType]	<= 4: NONE
>> trayIcon.displayMessage('title','info msg',MessageTypes(3));

systray INFO message

and another example, now with a WARNING icon:

systray WARNING message

If the title string is left empty, then neither title nor the severity icon will be displayed. The message can still be manually dismissed by clicking within its boundaries:


systray messages without a title (hence also without a severity icon)
systray messages without a title (hence also without a severity icon)

Informational popup messages are automatically aligned and positioned by the system. Messages are automatically dismissed by the system after some time, if not dismissed by the user first. The exact time is determined by system and user activity and other such external factors. Informational messages replace one another, if the previous message has still not been cleared by the user.

I have created a utility function called SYSTRAY, which is a convenience function that facilitates the setup and update of system tray icons and messages. SYSTRAY (with source code) can be downloaded from the File Exchange.

I would be happy to hear if and how you’re using the new system-tray functionality in your application – let me know below.

Related posts:

  1. Setting system tray icons System-tray icons can be programmatically set and controlled from within Matlab, using new functionality available since R2007b....
  2. 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....
  3. Setting status-bar text The Matlab desktop and figure windows have a usable statusbar which can only be set using undocumented methods. This post shows how to set the status-bar text....
  4. setPrompt – Setting the Matlab Desktop prompt The Matlab Desktop's Command-Window prompt can easily be modified using some undocumented features...
  5. Setting the Matlab desktop layout programmatically The Matlab desktop enables saving and switching layouts using the main menu. This post shows how to do so programmatically....
  6. EditorMacro v2 – setting Command Window key-bindings The EditorMacro utility was extended to support built-in Matlab Editor and Command-Window actions and key-bindings. This post describes the changes and the implementation details....

Tags: , ,

Categories: Desktop, GUI, Icons, Java, Low risk of breaking in future versions

This entry was posted on Tuesday, March 31st, 2009 at 4:09 pm PST
You can follow any responses to this entry through the RSS 2.0 feed.
You can leave a response, or trackback from your own site.

PoorSo-soHelpfulVery helpfulExcellent! (No Ratings Yet)
Loading ... Loading ...
 Bookmark and Share Print Print
If you like this post, please consider buying me a cup of coffee.

8 Responses to “Setting system tray popup messages”

  1. Jason McMains Jason McMains says:
    July 10, 2009 at 8:06 am

    Yair,
    Thanks again for this utility, just thought I would let you know that I’m using this to replace any helpdlg boxes that I previously used to give process direction during a program, like click here, or define this range. Using this, a user can breeze through a program if they know what to do, or go slowly and read the pop-ups.

  2. Updating speaker sound volume | Undocumented Matlab Updating speaker sound volume | Undocumented Matlab says:
    October 15, 2009 at 9:14 am

    [...] Unfortunately, Matlab prevents using Java classnames containing a period (e.g., Port.Info) or static Interface values, so we cannot directly access Port.Info.SPEAKER or FloatControl.Type.VOLUME. I’ve reported this bug to Mathworks earlier this year, and I do not know in which Matlab release (if at all) they intend to fix it. Until then we need to use workarounds, as in the code above. I posted a similar issue (and its workaround) earlier in this blog, when setting system-tray popup message. [...]

  3. Albert Albert says:
    December 17, 2009 at 5:11 am

    On the version (R2007b) of Matlab I use this statement does not work:
    trayIconClasses = trayIcon.getClass.getClasses;
    ??? No method ‘getClass’ with matching signature found for class ‘java.awt.TrayIcon’.

    Is it supprted on later versions?

  4. Yair Altman Yair Altman says:
    December 27, 2009 at 3:53 pm

    Albert – it should work on Matlab installations that run JVM 1.6+. To determine your JVM version, type the following in your Command Window:

    version -java

    If this is not helpful, try to inspect the trayIcon object using the methodsview function, to see why the getClass method fails:

    methodsview(trayIcon);
  5. andandgui andandgui says:
    June 4, 2010 at 12:29 pm

    i couldn’t run SoundVolume function on Matlab.. When i write SoundVolume=10; then nothing happens .. How can i run the SoundVolume function which is written at

    http://undocumentedmatlab.com/blog/updating-speaker-sound-volume/

  6. Yair Altman Yair Altman says:
    June 5, 2010 at 11:19 am

    @andandgui – did you even read the SoundVolume help?

    SoundVolume is not a variable that you can assign like SoundVolume=10, but a function that accepts input parameters like SoundVolume (1.0) and it only accepts values between 0.0-1.0 so 10 is not a valid value.

    Also, next time, please post the question in the relevant page (http://undocumentedmatlab.com/blog/updating-speaker-sound-volume/) – your question has nothing to do with this page.

  7. Peter Peter says:
    June 16, 2010 at 2:54 am

    Dear Yair

    This looks like a great utility. Unfortunately it does not work properly on my system (Matlab 2010a, Windows XP, Java 1.6.0_12-b04). To start with I call

    hIcon = systray('C:\Program Files\MATLAB\R2010a\toolbox\matlab\icons\help_ex.png');

    Afterwards, the only command that works is the set command for deletion. Setting message pop-ups and the like does not work (does not yield any error messages, but does not affect the icon).

    Furthermore, if I click the icon in the system tray I get the exception pasted below.

    Have you any suggestions on how to get around this. I have tried the exception fix you link to on the uisplitpane post, but that does not help either. Thanks for a great site and lots of cool applications

    Peter

    Exception in thread “AWT-EventQueue-0″ java.lang.ClassCastException: 
java.awt.TrayIcon cannot be cast to java.awt.Component
at com.mathworks.widgets.tooltip.ToolTipAndComponentAWTListener.mouseInTipComponent(ToolTipAndComponentAWTListener.java:175)
at com.mathworks.widgets.tooltip.ToolTipAndComponentAWTListener.eventDispatched(ToolTipAndComponentAWTListener.java:125)
at java.awt.Toolkit$SelectiveAWTEventListener.eventDispatched(Unknown Source)
at java.awt.Toolkit$ToolkitEventMulticaster.eventDispatched(Unknown Source)
...
at java.awt.Toolkit$ToolkitEventMulticaster.eventDispatched(Unknown Source)
at java.awt.Toolkit.notifyAWTEventListeners(Unknown Source)
at java.awt.TrayIcon.dispatchEvent(Unknown Source)
at java.awt.EventQueue.dispatchEvent(Unknown Source)
at java.awt.EventDispatchThread.pumpOneEventForFilters(Unknown Source)
at java.awt.EventDispatchThread.pumpEventsForFilter(Unknown Source)
at java.awt.EventDispatchThread.pumpEventsForHierarchy(Unknown Source)
at java.awt.EventDispatchThread.pumpEvents(Unknown Source)
at java.awt.EventDispatchThread.pumpEvents(Unknown Source)
at java.awt.EventDispatchThread.run(Unknown Source)
  8. Setting status-bar text | Undocumented Matlab Setting status-bar text | Undocumented Matlab says:
    June 23, 2010 at 3:09 am

    [...] Note: Users interested in non-intrusive status-bar messages, may also be interested in another non-intrusive messaging mechanism which I have described some months ago: Setting system tray popup messages. [...]

Leave a Reply


Wrap code fragments inside <pre lang="matlab"> tags, like this: 

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