2014-11-24 17:40:06 +01:00
|
|
|
/*
|
|
|
|
* Copyright 2014 dorkbox, llc
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
2016-02-12 01:51:15 +01:00
|
|
|
package dorkbox.systemTray.swing;
|
2014-11-03 02:11:03 +01:00
|
|
|
|
2015-11-09 16:13:57 +01:00
|
|
|
import java.awt.AWTException;
|
|
|
|
import java.awt.Dimension;
|
|
|
|
import java.awt.Font;
|
|
|
|
import java.awt.Image;
|
|
|
|
import java.awt.Point;
|
|
|
|
import java.awt.Rectangle;
|
|
|
|
import java.awt.SystemTray;
|
|
|
|
import java.awt.TrayIcon;
|
2014-11-03 02:11:03 +01:00
|
|
|
import java.awt.event.MouseAdapter;
|
|
|
|
import java.awt.event.MouseEvent;
|
2016-09-26 02:06:27 +02:00
|
|
|
import java.io.File;
|
2016-02-12 01:51:15 +01:00
|
|
|
import java.io.InputStream;
|
|
|
|
import java.net.URL;
|
2014-11-03 02:11:03 +01:00
|
|
|
|
2016-09-22 15:21:22 +02:00
|
|
|
import javax.swing.ImageIcon;
|
|
|
|
import javax.swing.JMenuItem;
|
|
|
|
|
|
|
|
import dorkbox.systemTray.MenuEntry;
|
|
|
|
import dorkbox.systemTray.SystemTrayMenuAction;
|
2016-09-26 02:06:27 +02:00
|
|
|
import dorkbox.systemTray.util.ImageUtils;
|
2016-09-22 15:21:22 +02:00
|
|
|
import dorkbox.util.ScreenUtil;
|
|
|
|
import dorkbox.util.SwingUtil;
|
|
|
|
|
2014-11-03 02:11:03 +01:00
|
|
|
/**
|
2016-09-22 15:21:22 +02:00
|
|
|
* Class for handling all system tray interaction, via SWING.
|
|
|
|
*
|
|
|
|
* It doesn't work well on linux. See bugs:
|
|
|
|
* http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6267936
|
|
|
|
* http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6453521
|
|
|
|
* https://stackoverflow.com/questions/331407/java-trayicon-using-image-with-transparent-background/3882028#3882028
|
2014-11-03 02:11:03 +01:00
|
|
|
*/
|
2016-09-26 02:06:27 +02:00
|
|
|
@SuppressWarnings({"SynchronizationOnLocalVariableOrMethodParameter", "WeakerAccess"})
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
2016-02-12 01:51:15 +01:00
|
|
|
class SwingSystemTray extends dorkbox.systemTray.SystemTray {
|
2016-02-13 15:06:19 +01:00
|
|
|
volatile SwingSystemTrayMenuPopup menu;
|
2016-02-15 13:27:33 +01:00
|
|
|
|
2015-08-04 21:10:01 +02:00
|
|
|
volatile JMenuItem connectionStatusItem;
|
2016-02-15 13:27:33 +01:00
|
|
|
private volatile String statusText = null;
|
2014-11-24 17:40:06 +01:00
|
|
|
|
2015-08-04 21:10:01 +02:00
|
|
|
volatile SystemTray tray;
|
|
|
|
volatile TrayIcon trayIcon;
|
2014-11-24 17:40:06 +01:00
|
|
|
|
2016-02-12 02:30:33 +01:00
|
|
|
volatile boolean isActive = false;
|
|
|
|
|
2014-11-24 17:40:06 +01:00
|
|
|
/**
|
|
|
|
* Creates a new system tray handler class.
|
|
|
|
*/
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
2016-02-12 02:30:33 +01:00
|
|
|
SwingSystemTray() {
|
2015-11-09 16:13:57 +01:00
|
|
|
super();
|
2016-09-26 02:06:27 +02:00
|
|
|
|
|
|
|
ImageUtils.determineIconSize(dorkbox.systemTray.SystemTray.TYPE_SWING);
|
|
|
|
|
2014-12-12 02:25:50 +01:00
|
|
|
SwingUtil.invokeAndWait(new Runnable() {
|
2014-11-03 02:11:03 +01:00
|
|
|
@Override
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
|
|
|
void run() {
|
2014-11-24 17:40:06 +01:00
|
|
|
SwingSystemTray.this.tray = SystemTray.getSystemTray();
|
|
|
|
if (SwingSystemTray.this.tray == null) {
|
2015-01-23 02:52:09 +01:00
|
|
|
logger.error("The system tray is not available");
|
2015-06-28 01:47:02 +02:00
|
|
|
}
|
2014-11-24 17:40:06 +01:00
|
|
|
}
|
2014-12-12 02:25:50 +01:00
|
|
|
});
|
2014-11-03 02:11:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-11-09 16:13:57 +01:00
|
|
|
@Override
|
|
|
|
public
|
|
|
|
void shutdown() {
|
|
|
|
SwingUtil.invokeAndWait(new Runnable() {
|
|
|
|
@Override
|
|
|
|
public
|
|
|
|
void run() {
|
2015-11-15 14:51:47 +01:00
|
|
|
SwingSystemTray tray = SwingSystemTray.this;
|
|
|
|
synchronized (tray) {
|
|
|
|
tray.tray.remove(tray.trayIcon);
|
2015-11-09 16:13:57 +01:00
|
|
|
|
2015-11-15 14:51:47 +01:00
|
|
|
for (MenuEntry menuEntry : tray.menuEntries) {
|
|
|
|
menuEntry.remove();
|
|
|
|
}
|
|
|
|
tray.menuEntries.clear();
|
2015-11-09 16:13:57 +01:00
|
|
|
|
2015-11-15 14:51:47 +01:00
|
|
|
tray.connectionStatusItem = null;
|
|
|
|
}
|
2015-11-09 16:13:57 +01:00
|
|
|
}
|
|
|
|
});
|
2014-11-24 17:40:06 +01:00
|
|
|
}
|
2014-11-03 02:11:03 +01:00
|
|
|
|
2014-11-24 17:40:06 +01:00
|
|
|
@Override
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
2016-02-15 13:27:33 +01:00
|
|
|
String getStatus() {
|
|
|
|
return this.statusText;
|
|
|
|
}
|
|
|
|
|
2016-04-05 14:07:41 +02:00
|
|
|
protected
|
|
|
|
void dispatch(Runnable runnable) {
|
|
|
|
SwingUtil.invokeLater(runnable);
|
|
|
|
}
|
|
|
|
|
2016-02-15 13:27:33 +01:00
|
|
|
@Override
|
|
|
|
public
|
|
|
|
void setStatus(final String statusText) {
|
|
|
|
this.statusText = statusText;
|
|
|
|
|
2016-04-05 14:07:41 +02:00
|
|
|
dispatch(new Runnable() {
|
2014-11-24 17:40:06 +01:00
|
|
|
@Override
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
|
|
|
void run() {
|
2015-11-15 14:51:47 +01:00
|
|
|
SwingSystemTray tray = SwingSystemTray.this;
|
|
|
|
synchronized (tray) {
|
|
|
|
if (tray.connectionStatusItem == null) {
|
2016-02-15 13:27:33 +01:00
|
|
|
final JMenuItem connectionStatusItem = new JMenuItem(statusText);
|
2015-11-15 14:51:47 +01:00
|
|
|
Font font = connectionStatusItem.getFont();
|
|
|
|
Font font1 = font.deriveFont(Font.BOLD);
|
|
|
|
connectionStatusItem.setFont(font1);
|
|
|
|
|
|
|
|
connectionStatusItem.setEnabled(false);
|
|
|
|
tray.menu.add(connectionStatusItem);
|
|
|
|
|
|
|
|
tray.connectionStatusItem = connectionStatusItem;
|
|
|
|
}
|
|
|
|
else {
|
2016-02-15 13:27:33 +01:00
|
|
|
tray.connectionStatusItem.setText(statusText);
|
2015-11-15 14:51:47 +01:00
|
|
|
}
|
2014-11-24 17:40:06 +01:00
|
|
|
}
|
|
|
|
}
|
2014-12-12 02:25:50 +01:00
|
|
|
});
|
2014-11-03 02:11:03 +01:00
|
|
|
}
|
|
|
|
|
2014-11-24 17:40:06 +01:00
|
|
|
@Override
|
2016-02-12 01:51:15 +01:00
|
|
|
protected
|
2016-09-26 02:06:27 +02:00
|
|
|
void setIcon_(final File iconFile) {
|
2016-04-05 14:07:41 +02:00
|
|
|
dispatch(new Runnable() {
|
2014-11-24 17:40:06 +01:00
|
|
|
@Override
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
|
|
|
void run() {
|
2015-11-15 14:51:47 +01:00
|
|
|
SwingSystemTray tray = SwingSystemTray.this;
|
2016-09-26 02:06:27 +02:00
|
|
|
|
|
|
|
// stupid java won't scale it right away, so we have to do this twice to get the correct size
|
|
|
|
final Image trayImage = new ImageIcon(iconFile.getAbsolutePath()).getImage();
|
|
|
|
trayImage.flush();
|
|
|
|
|
2015-11-15 14:51:47 +01:00
|
|
|
synchronized (tray) {
|
2016-02-12 02:30:33 +01:00
|
|
|
if (!isActive) {
|
2016-02-21 00:55:54 +01:00
|
|
|
// here we init. everything
|
2016-02-12 02:30:33 +01:00
|
|
|
isActive = true;
|
|
|
|
|
2016-02-21 00:55:54 +01:00
|
|
|
menu = new SwingSystemTrayMenuPopup();
|
2016-04-05 14:07:41 +02:00
|
|
|
trayIcon = new TrayIcon(trayImage);
|
2016-02-12 02:30:33 +01:00
|
|
|
|
|
|
|
// appindicators don't support this, so we cater to the lowest common denominator
|
|
|
|
// trayIcon.setToolTip(SwingSystemTray.this.appName);
|
|
|
|
|
|
|
|
trayIcon.addMouseListener(new MouseAdapter() {
|
|
|
|
@Override
|
|
|
|
public
|
|
|
|
void mousePressed(MouseEvent e) {
|
|
|
|
Dimension size = menu.getPreferredSize();
|
|
|
|
|
|
|
|
Point point = e.getPoint();
|
|
|
|
Rectangle bounds = ScreenUtil.getScreenBoundsAt(point);
|
|
|
|
|
|
|
|
int x = point.x;
|
|
|
|
int y = point.y;
|
|
|
|
|
|
|
|
if (y < bounds.y) {
|
|
|
|
y = bounds.y;
|
|
|
|
}
|
|
|
|
else if (y + size.height > bounds.y + bounds.height) {
|
|
|
|
// our menu cannot have the top-edge snap to the mouse
|
|
|
|
// so we make the bottom-edge snap to the mouse
|
|
|
|
y -= size.height; // snap to edge of mouse
|
|
|
|
}
|
|
|
|
|
|
|
|
if (x < bounds.x) {
|
|
|
|
x = bounds.x;
|
|
|
|
}
|
|
|
|
else if (x + size.width > bounds.x + bounds.width) {
|
|
|
|
// our menu cannot have the left-edge snap to the mouse
|
|
|
|
// so we make the right-edge snap to the mouse
|
|
|
|
x -= size.width; // snap to edge of mouse
|
|
|
|
}
|
|
|
|
|
2016-02-21 00:55:54 +01:00
|
|
|
// voodoo to get this to popup to have the correct parent
|
|
|
|
// from: http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6285881
|
2016-02-12 02:30:33 +01:00
|
|
|
menu.setInvoker(menu);
|
|
|
|
menu.setLocation(x, y);
|
|
|
|
menu.setVisible(true);
|
2016-02-21 00:55:54 +01:00
|
|
|
menu.setFocusable(true);
|
|
|
|
menu.requestFocusInWindow();
|
2016-02-12 02:30:33 +01:00
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
try {
|
|
|
|
SwingSystemTray.this.tray.add(trayIcon);
|
|
|
|
} catch (AWTException e) {
|
|
|
|
logger.error("TrayIcon could not be added.", e);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
tray.trayIcon.setImage(trayImage);
|
|
|
|
}
|
2015-11-15 14:51:47 +01:00
|
|
|
}
|
2014-11-24 17:40:06 +01:00
|
|
|
}
|
2014-12-12 02:25:50 +01:00
|
|
|
});
|
2014-11-03 02:11:03 +01:00
|
|
|
}
|
2014-11-24 17:40:06 +01:00
|
|
|
|
|
|
|
/**
|
2015-11-09 16:13:57 +01:00
|
|
|
* Will add a new menu entry, or update one if it already exists
|
2014-11-24 17:40:06 +01:00
|
|
|
*/
|
2016-02-12 01:51:15 +01:00
|
|
|
private
|
2016-09-26 02:06:27 +02:00
|
|
|
void addMenuEntry_(final String menuText, final File imagePath, final SystemTrayMenuAction callback) {
|
2015-11-09 16:13:57 +01:00
|
|
|
if (menuText == null) {
|
|
|
|
throw new NullPointerException("Menu text cannot be null");
|
|
|
|
}
|
|
|
|
|
2016-04-05 14:07:41 +02:00
|
|
|
dispatch(new Runnable() {
|
2014-11-24 17:40:06 +01:00
|
|
|
@Override
|
2015-06-28 01:47:02 +02:00
|
|
|
public
|
|
|
|
void run() {
|
2015-11-15 14:51:47 +01:00
|
|
|
SwingSystemTray tray = SwingSystemTray.this;
|
|
|
|
synchronized (tray) {
|
2016-02-13 15:06:19 +01:00
|
|
|
synchronized (menuEntries) {
|
|
|
|
MenuEntry menuEntry = getMenuEntry(menuText);
|
2014-11-24 17:40:06 +01:00
|
|
|
|
2016-02-13 15:06:19 +01:00
|
|
|
if (menuEntry != null) {
|
|
|
|
throw new IllegalArgumentException("Menu entry already exists for given label '" + menuText + "'");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
menuEntry = new SwingMenuEntry(menu, menuText, imagePath, callback, tray);
|
|
|
|
menuEntries.add(menuEntry);
|
|
|
|
}
|
2014-11-24 17:40:06 +01:00
|
|
|
}
|
|
|
|
}
|
2014-11-03 02:11:03 +01:00
|
|
|
}
|
2014-12-12 02:25:50 +01:00
|
|
|
});
|
2014-11-03 02:11:03 +01:00
|
|
|
}
|
2016-02-12 01:51:15 +01:00
|
|
|
|
|
|
|
@Override
|
|
|
|
public
|
2016-02-14 17:49:02 +01:00
|
|
|
void addMenuEntry(String menuText, final String imagePath, final SystemTrayMenuAction callback) {
|
2016-02-12 01:51:15 +01:00
|
|
|
if (imagePath == null) {
|
|
|
|
addMenuEntry_(menuText, null, callback);
|
|
|
|
}
|
|
|
|
else {
|
2016-09-26 20:56:42 +02:00
|
|
|
addMenuEntry_(menuText, ImageUtils.resizeAndCache(ImageUtils.ENTRY_SIZE, imagePath), callback);
|
2016-02-12 01:51:15 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public
|
2016-02-14 17:49:02 +01:00
|
|
|
void addMenuEntry(final String menuText, final URL imageUrl, final SystemTrayMenuAction callback) {
|
2016-02-12 01:51:15 +01:00
|
|
|
if (imageUrl == null) {
|
|
|
|
addMenuEntry_(menuText, null, callback);
|
|
|
|
}
|
|
|
|
else {
|
2016-09-26 20:56:42 +02:00
|
|
|
addMenuEntry_(menuText, ImageUtils.resizeAndCache(ImageUtils.ENTRY_SIZE, imageUrl), callback);
|
2016-02-12 01:51:15 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public
|
2016-02-14 17:49:02 +01:00
|
|
|
void addMenuEntry(final String menuText, final String cacheName, final InputStream imageStream, final SystemTrayMenuAction callback) {
|
2016-02-12 01:51:15 +01:00
|
|
|
if (imageStream == null) {
|
|
|
|
addMenuEntry_(menuText, null, callback);
|
|
|
|
}
|
|
|
|
else {
|
2016-09-26 20:56:42 +02:00
|
|
|
addMenuEntry_(menuText, ImageUtils.resizeAndCache(ImageUtils.ENTRY_SIZE, cacheName, imageStream), callback);
|
2016-02-12 01:51:15 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
@Deprecated
|
|
|
|
public
|
2016-02-14 17:49:02 +01:00
|
|
|
void addMenuEntry(final String menuText, final InputStream imageStream, final SystemTrayMenuAction callback) {
|
2016-02-12 01:51:15 +01:00
|
|
|
if (imageStream == null) {
|
|
|
|
addMenuEntry_(menuText, null, callback);
|
|
|
|
}
|
|
|
|
else {
|
2016-09-26 20:56:42 +02:00
|
|
|
addMenuEntry_(menuText, ImageUtils.resizeAndCache(ImageUtils.ENTRY_SIZE, imageStream), callback);
|
2016-02-12 01:51:15 +01:00
|
|
|
}
|
|
|
|
}
|
2014-11-03 02:11:03 +01:00
|
|
|
}
|