forked from dorkbox/SystemTray
Migrated GtkStatusIcon to use swing menus instead of GTK menus. The
swing menus are the "golden standard", becuase we can controll 100% of it.
This commit is contained in:
parent
0e56ca199a
commit
b936a4cd76
@ -41,7 +41,7 @@ class GtkEntryItem extends GtkEntry implements GCallback {
|
|||||||
|
|
||||||
// The mnemonic will ONLY show-up once a menu entry is selected. IT WILL NOT show up before then!
|
// The mnemonic will ONLY show-up once a menu entry is selected. IT WILL NOT show up before then!
|
||||||
// AppIndicators will only show if you use the keyboard to navigate
|
// AppIndicators will only show if you use the keyboard to navigate
|
||||||
// GtkStatusIndicator will show on mouse+keyboard movement
|
// GtkStatusIconTray will show on mouse+keyboard movement
|
||||||
private volatile char mnemonicKey = 0;
|
private volatile char mnemonicKey = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -19,7 +19,7 @@ import dorkbox.systemTray.SystemTrayMenuAction;
|
|||||||
import dorkbox.systemTray.linux.jna.Gtk;
|
import dorkbox.systemTray.linux.jna.Gtk;
|
||||||
|
|
||||||
// you might wonder WHY this extends MenuEntryItem -- the reason is that an AppIndicator "status" will be offset from everyone else,
|
// you might wonder WHY this extends MenuEntryItem -- the reason is that an AppIndicator "status" will be offset from everyone else,
|
||||||
// where a GtkStatusIndicator + SwingTray will have everything lined up. (with or without icons). This is to normalize how it looks
|
// where a GtkStatusIconTray + SwingTray will have everything lined up. (with or without icons). This is to normalize how it looks
|
||||||
class GtkEntryStatus extends GtkEntryItem {
|
class GtkEntryStatus extends GtkEntryItem {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -71,6 +71,7 @@ class GtkMenu extends Menu {
|
|||||||
/**
|
/**
|
||||||
* Necessary to guarantee all updates occur on the dispatch thread
|
* Necessary to guarantee all updates occur on the dispatch thread
|
||||||
*/
|
*/
|
||||||
|
@Override
|
||||||
protected
|
protected
|
||||||
void dispatchAndWait(final Runnable runnable) {
|
void dispatchAndWait(final Runnable runnable) {
|
||||||
final CountDownLatch countDownLatch = new CountDownLatch(1);
|
final CountDownLatch countDownLatch = new CountDownLatch(1);
|
||||||
|
285
src/dorkbox/systemTray/swing/GtkStatusIconTray.java
Normal file
285
src/dorkbox/systemTray/swing/GtkStatusIconTray.java
Normal file
@ -0,0 +1,285 @@
|
|||||||
|
/*
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
package dorkbox.systemTray.swing;
|
||||||
|
|
||||||
|
import static dorkbox.systemTray.SystemTray.TIMEOUT;
|
||||||
|
|
||||||
|
import java.awt.Dimension;
|
||||||
|
import java.awt.MouseInfo;
|
||||||
|
import java.awt.Point;
|
||||||
|
import java.awt.Rectangle;
|
||||||
|
import java.io.File;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.concurrent.CountDownLatch;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
import java.util.concurrent.atomic.AtomicBoolean;
|
||||||
|
|
||||||
|
import javax.swing.JPopupMenu;
|
||||||
|
|
||||||
|
import com.sun.jna.NativeLong;
|
||||||
|
import com.sun.jna.Pointer;
|
||||||
|
|
||||||
|
import dorkbox.systemTray.MenuEntry;
|
||||||
|
import dorkbox.systemTray.SystemTray;
|
||||||
|
import dorkbox.systemTray.linux.jna.GEventCallback;
|
||||||
|
import dorkbox.systemTray.linux.jna.GdkEventButton;
|
||||||
|
import dorkbox.systemTray.linux.jna.Gobject;
|
||||||
|
import dorkbox.systemTray.linux.jna.Gtk;
|
||||||
|
import dorkbox.systemTray.util.ImageUtils;
|
||||||
|
import dorkbox.util.ScreenUtil;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class for handling all system tray interactions via GTK.
|
||||||
|
* <p/>
|
||||||
|
* This is the "old" way to do it, and does not work with some desktop environments. This is a hybrid class, because we want to show the
|
||||||
|
* swing menu popup INSTEAD of GTK menu popups. The "golden standard" is our swing menu popup, since we have 100% control over it.
|
||||||
|
*/
|
||||||
|
public
|
||||||
|
class GtkStatusIconTray extends SwingMenu {
|
||||||
|
private volatile Pointer trayIcon;
|
||||||
|
|
||||||
|
// http://code.metager.de/source/xref/gnome/Platform/gtk%2B/gtk/deprecated/gtkstatusicon.c
|
||||||
|
// https://github.com/djdeath/glib/blob/master/gobject/gobject.c
|
||||||
|
|
||||||
|
// have to save these in a field to prevent GC on the objects (since they go out-of-scope from java)
|
||||||
|
private final List<Object> gtkCallbacks = new ArrayList<Object>();
|
||||||
|
|
||||||
|
// This is required if we have JavaFX or SWT shutdown hooks (to prevent us from shutting down twice...)
|
||||||
|
private AtomicBoolean shuttingDown = new AtomicBoolean();
|
||||||
|
|
||||||
|
private volatile boolean isActive = false;
|
||||||
|
|
||||||
|
// called on the EDT
|
||||||
|
public
|
||||||
|
GtkStatusIconTray(final SystemTray systemTray) {
|
||||||
|
super(systemTray, null, new SwingSystemTrayMenuPopup());
|
||||||
|
if (SystemTray.FORCE_TRAY_TYPE == SystemTray.TYPE_APP_INDICATOR) {
|
||||||
|
// if we force GTK type system tray, don't attempt to load AppIndicator libs
|
||||||
|
throw new IllegalArgumentException("Unable to start GtkStatusIcon if 'SystemTray.FORCE_TRAY_TYPE' is set to AppIndicator");
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
JPopupMenu popupMenu = (JPopupMenu) _native;
|
||||||
|
popupMenu.pack();
|
||||||
|
popupMenu.setFocusable(true);
|
||||||
|
|
||||||
|
final Runnable popupRunnable = new Runnable() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void run() {
|
||||||
|
Dimension size = _native.getPreferredSize();
|
||||||
|
|
||||||
|
Point point = MouseInfo.getPointerInfo()
|
||||||
|
.getLocation();
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
SwingSystemTrayMenuPopup popupMenu = (SwingSystemTrayMenuPopup) _native;
|
||||||
|
popupMenu.doShow(x, y);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// appindicators DO NOT support anything other than PLAIN gtk-menus
|
||||||
|
// they ALSO do not support tooltips, so we cater to the lowest common denominator
|
||||||
|
// trayIcon.setToolTip(SwingSystemTray.this.appName);
|
||||||
|
|
||||||
|
ImageUtils.determineIconSize();
|
||||||
|
Gtk.startGui();
|
||||||
|
|
||||||
|
Gtk.dispatch(new Runnable() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void run() {
|
||||||
|
final Pointer trayIcon_ = Gtk.gtk_status_icon_new();
|
||||||
|
trayIcon = trayIcon_;
|
||||||
|
|
||||||
|
final GEventCallback gtkCallback = new GEventCallback() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void callback(Pointer notUsed, final GdkEventButton event) {
|
||||||
|
// BUTTON_PRESS only (any mouse click)
|
||||||
|
if (event.type == 4) {
|
||||||
|
// show the swing menu on the EDT
|
||||||
|
dispatch(popupRunnable);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
final NativeLong button_press_event = Gobject.g_signal_connect_object(trayIcon, "button_press_event", gtkCallback,
|
||||||
|
null, 0);
|
||||||
|
|
||||||
|
// have to do this to prevent GC on these objects
|
||||||
|
gtkCallbacks.add(gtkCallback);
|
||||||
|
gtkCallbacks.add(button_press_event);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Gtk.waitForStartup();
|
||||||
|
|
||||||
|
// we have to be able to set our title, otherwise the gnome-shell extension WILL NOT work
|
||||||
|
Gtk.dispatch(new Runnable() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void run() {
|
||||||
|
// by default, the title/name of the tray icon is "java". We are the only java-based tray icon, so we just use that.
|
||||||
|
// If you change "SystemTray" to something else, make sure to change it in extension.js as well
|
||||||
|
|
||||||
|
// necessary for gnome icon detection/placement because we move tray icons around by title. This is hardcoded
|
||||||
|
// in extension.js, so don't change it
|
||||||
|
Gtk.gtk_status_icon_set_title(trayIcon, "SystemTray");
|
||||||
|
|
||||||
|
// can cause
|
||||||
|
// Gdk-CRITICAL **: gdk_window_thaw_toplevel_updates: assertion 'window->update_and_descendants_freeze_count > 0' failed
|
||||||
|
// Gdk-CRITICAL **: IA__gdk_window_thaw_toplevel_updates_libgtk_only: assertion 'private->update_and_descendants_freeze_count > 0' failed
|
||||||
|
|
||||||
|
// ... so, bizzaro things going on here. These errors DO NOT happen if JavaFX is dispatching the events.
|
||||||
|
// BUT this is REQUIRED when running JavaFX. For unknown reasons, the title isn't pushed to GTK, so our
|
||||||
|
// gnome-shell extension cannot see our tray icon -- so naturally, it won't move it to the "top" area and
|
||||||
|
// we appear broken.
|
||||||
|
if (SystemTray.isJavaFxLoaded) {
|
||||||
|
Gtk.gtk_status_icon_set_name(trayIcon, "SystemTray");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@SuppressWarnings("FieldRepeatedlyAccessedInMethod")
|
||||||
|
public
|
||||||
|
void shutdown() {
|
||||||
|
if (!shuttingDown.getAndSet(true)) {
|
||||||
|
final CountDownLatch countDownLatch = new CountDownLatch(1);
|
||||||
|
|
||||||
|
Gtk.dispatch(new Runnable() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void run() {
|
||||||
|
try {
|
||||||
|
// this hides the indicator
|
||||||
|
Gtk.gtk_status_icon_set_visible(trayIcon, false);
|
||||||
|
Gobject.g_object_unref(trayIcon);
|
||||||
|
|
||||||
|
// mark for GC
|
||||||
|
trayIcon = null;
|
||||||
|
gtkCallbacks.clear();
|
||||||
|
} finally {
|
||||||
|
countDownLatch.countDown();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// this is slightly different than how swing does it. We have a timeout here so that we can make sure that updates on the GUI
|
||||||
|
// thread occur in REASONABLE time-frames, and alert the user if not.
|
||||||
|
try {
|
||||||
|
if (!countDownLatch.await(TIMEOUT, TimeUnit.SECONDS)) {
|
||||||
|
SystemTray.logger.error("Event dispatch queue took longer than " + TIMEOUT + " seconds to shutdown. Please adjust " +
|
||||||
|
"`SystemTray.TIMEOUT` to a value which better suites your environment.");
|
||||||
|
}
|
||||||
|
} catch (InterruptedException e) {
|
||||||
|
SystemTray.logger.error("Error waiting for shutdown dispatch to complete.", new Exception());
|
||||||
|
}
|
||||||
|
|
||||||
|
Gtk.shutdownGui();
|
||||||
|
|
||||||
|
super.remove();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public
|
||||||
|
void setImage_(final File iconFile) {
|
||||||
|
Gtk.dispatch(new Runnable() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void run() {
|
||||||
|
Gtk.gtk_status_icon_set_from_file(trayIcon, iconFile.getAbsolutePath());
|
||||||
|
|
||||||
|
if (!isActive) {
|
||||||
|
isActive = true;
|
||||||
|
Gtk.gtk_status_icon_set_visible(trayIcon, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public
|
||||||
|
String getStatus() {
|
||||||
|
synchronized (menuEntries) {
|
||||||
|
MenuEntry menuEntry = menuEntries.get(0);
|
||||||
|
if (menuEntry instanceof SwingEntryStatus) {
|
||||||
|
return menuEntry.getText();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
@SuppressWarnings("Duplicates")
|
||||||
|
public
|
||||||
|
void setStatus(final String statusText) {
|
||||||
|
dispatch(new Runnable() {
|
||||||
|
@Override
|
||||||
|
public
|
||||||
|
void run() {
|
||||||
|
synchronized (menuEntries) {
|
||||||
|
// status is ALWAYS at 0 index...
|
||||||
|
SwingEntry menuEntry = null;
|
||||||
|
if (!menuEntries.isEmpty()) {
|
||||||
|
menuEntry = (SwingEntry) menuEntries.get(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (menuEntry instanceof SwingEntryStatus) {
|
||||||
|
// set the text or delete...
|
||||||
|
|
||||||
|
if (statusText == null) {
|
||||||
|
// delete
|
||||||
|
remove(menuEntry);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// set text
|
||||||
|
menuEntry.setText(statusText);
|
||||||
|
}
|
||||||
|
|
||||||
|
} else {
|
||||||
|
// create a new one
|
||||||
|
menuEntry = new SwingEntryStatus(GtkStatusIconTray.this, statusText);
|
||||||
|
// status is ALWAYS at 0 index...
|
||||||
|
menuEntries.add(0, menuEntry);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
@ -47,9 +47,7 @@ class SwingSystemTray extends SwingMenu {
|
|||||||
volatile SystemTray tray;
|
volatile SystemTray tray;
|
||||||
volatile TrayIcon trayIcon;
|
volatile TrayIcon trayIcon;
|
||||||
|
|
||||||
/**
|
// Called in the EDT
|
||||||
* Creates a new system tray handler class. Called in the EDT
|
|
||||||
*/
|
|
||||||
public
|
public
|
||||||
SwingSystemTray(final dorkbox.systemTray.SystemTray systemTray) {
|
SwingSystemTray(final dorkbox.systemTray.SystemTray systemTray) {
|
||||||
super(systemTray, null, new SwingSystemTrayMenuPopup());
|
super(systemTray, null, new SwingSystemTrayMenuPopup());
|
||||||
@ -91,6 +89,7 @@ class SwingSystemTray extends SwingMenu {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@SuppressWarnings("Duplicates")
|
||||||
public
|
public
|
||||||
void setStatus(final String statusText) {
|
void setStatus(final String statusText) {
|
||||||
dispatch(new Runnable() {
|
dispatch(new Runnable() {
|
||||||
|
@ -36,6 +36,8 @@ import dorkbox.util.OS;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This custom popup is required if we want to be able to show images on the menu,
|
* This custom popup is required if we want to be able to show images on the menu,
|
||||||
|
*
|
||||||
|
* This is our "golden standard" since we have 100% control over it.
|
||||||
*/
|
*/
|
||||||
class SwingSystemTrayMenuPopup extends JPopupMenu {
|
class SwingSystemTrayMenuPopup extends JPopupMenu {
|
||||||
private static final long serialVersionUID = 1L;
|
private static final long serialVersionUID = 1L;
|
||||||
|
Loading…
Reference in New Issue
Block a user