188 lines
5.8 KiB
Java
188 lines
5.8 KiB
Java
/*
|
|
* Copyright 2021 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;
|
|
|
|
import java.awt.Image;
|
|
import java.io.File;
|
|
import java.io.InputStream;
|
|
import java.net.URL;
|
|
|
|
import javax.imageio.stream.ImageInputStream;
|
|
|
|
// This is public ONLY so that it is in the scope for SwingUI and NativeUI system tray components
|
|
public
|
|
class Tray extends Menu {
|
|
// true if we are using gnome (and we have to implement workarounds) or false
|
|
public static volatile boolean gtkGnomeWorkaround = false;
|
|
private final Runnable onRemoveEvent;
|
|
|
|
// appindicators DO NOT support anything other than PLAIN gtk-menus
|
|
// they ALSO do not support tooltips!
|
|
// https://bugs.launchpad.net/indicator-application/+bug/527458/comments/12
|
|
|
|
private volatile String statusText;
|
|
|
|
public
|
|
Tray(final Runnable onRemoveEvent) {
|
|
super();
|
|
this.onRemoveEvent = onRemoveEvent;
|
|
}
|
|
|
|
/**
|
|
* Gets the 'status' string assigned to the system tray
|
|
*/
|
|
public
|
|
String getStatus() {
|
|
return statusText;
|
|
}
|
|
|
|
/**
|
|
* Sets a 'status' string at the first position in the popup menu. This 'status' string appears as a disabled menu entry.
|
|
*
|
|
* @param statusText the text you want displayed, null if you want to remove the 'status' text
|
|
*/
|
|
public
|
|
void setStatus(final String statusText) {
|
|
this.statusText = statusText;
|
|
|
|
// status is ALWAYS at 0 index...
|
|
Entry menuEntry = null;
|
|
|
|
synchronized (menuEntries) {
|
|
// access on this object must be synchronized for object visibility
|
|
if (!menuEntries.isEmpty()) {
|
|
menuEntry = menuEntries.get(0);
|
|
}
|
|
}
|
|
|
|
if (menuEntry instanceof Status) {
|
|
// set the text or delete...
|
|
|
|
if (statusText == null) {
|
|
// delete
|
|
remove(menuEntry);
|
|
}
|
|
else {
|
|
// set text
|
|
((Status) menuEntry).setText(statusText);
|
|
}
|
|
} else {
|
|
// create a new one
|
|
Status status = new Status();
|
|
status.setText(statusText);
|
|
|
|
// status is ALWAYS at 0 index...
|
|
// also calls the hook to add it, so we don't need anything special
|
|
add(status, 0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Specifies the new image to set for the tray icon.
|
|
* <p>
|
|
* If AUTO_SIZE, then this method resize the image (best guess), otherwise the image "as-is" will be used
|
|
*
|
|
* @param imageFile the file of the image to use
|
|
*/
|
|
@Override
|
|
public
|
|
void setImage(final File imageFile) {
|
|
setImageFromTray(imageResizeUtil.shouldResizeOrCache(true, imageFile));
|
|
}
|
|
|
|
/**
|
|
* Specifies the new image to set for the tray icon.
|
|
* <p>
|
|
* If AUTO_SIZE, then this method resize the image (best guess), otherwise the image "as-is" will be used
|
|
*
|
|
* @param imagePath the full path of the image to use
|
|
*/
|
|
@Override
|
|
public
|
|
void setImage(final String imagePath) {
|
|
setImageFromTray(imageResizeUtil.shouldResizeOrCache(true, imagePath));
|
|
}
|
|
|
|
/**
|
|
* Specifies the new image to set for the tray icon.
|
|
* <p>
|
|
* If AUTO_SIZE, then this method resize the image (best guess), otherwise the image "as-is" will be used
|
|
*
|
|
* @param imageUrl the URL of the image to use
|
|
*/
|
|
@Override
|
|
public
|
|
void setImage(final URL imageUrl) {
|
|
setImageFromTray(imageResizeUtil.shouldResizeOrCache(true, imageUrl));
|
|
}
|
|
|
|
/**
|
|
* Specifies the new image to set for the tray icon.
|
|
* <p>
|
|
* If AUTO_SIZE, then this method resize the image (best guess), otherwise the image "as-is" will be used
|
|
*
|
|
* @param imageStream the InputStream of the image to use
|
|
*/
|
|
@Override
|
|
public
|
|
void setImage(final InputStream imageStream) {
|
|
setImageFromTray(imageResizeUtil.shouldResizeOrCache(true, imageStream));
|
|
}
|
|
|
|
/**
|
|
* Specifies the new image to set for the tray icon.
|
|
* <p>
|
|
* If AUTO_SIZE, then this method resize the image (best guess), otherwise the image "as-is" will be used
|
|
*
|
|
* @param image the image of the image to use
|
|
*/
|
|
@Override
|
|
public
|
|
void setImage(final Image image) {
|
|
setImageFromTray(imageResizeUtil.shouldResizeOrCache(true, image));
|
|
}
|
|
|
|
/**
|
|
* Specifies the new image to set for the tray icon.
|
|
* <p>
|
|
* If AUTO_SIZE, then this method resize the image (best guess), otherwise the image "as-is" will be used
|
|
*
|
|
* @param imageStream the ImageInputStream of the image to use
|
|
*/
|
|
@Override
|
|
public
|
|
void setImage(final ImageInputStream imageStream) {
|
|
setImageFromTray(imageResizeUtil.shouldResizeOrCache(true, imageStream));
|
|
}
|
|
|
|
/**
|
|
* This removes all menu entries from the tray icon menu AND removes the tray icon from the system tray!
|
|
* <p>
|
|
* You will need to recreate ALL parts of the menu to see the tray icon + menu again!
|
|
*/
|
|
@Override
|
|
public
|
|
void remove() {
|
|
super.remove();
|
|
|
|
// we have to tell our parent that we have been removed.
|
|
// This is HERE instead of inside of the tray implementations because of visibility requirements.
|
|
|
|
// This is internal and should NEVER be called by someone else or ANYWHERE else!
|
|
onRemoveEvent.run();
|
|
}
|
|
}
|