Merge pull request #6 from cryptomator/feature/tray-menu

Add Tray Menu API

Author: overheadhunter

src/main/java/module-info.java

@@ -1,8 +1,10 @@
+import org.cryptomator.integrations.tray.TrayMenuController;
 import org.cryptomator.integrations.autostart.AutoStartProvider;
 import org.cryptomator.integrations.keychain.KeychainAccessProvider;
 import org.cryptomator.integrations.tray.TrayIntegrationProvider;
 import org.cryptomator.integrations.uiappearance.UiAppearanceProvider;
 
+
 module org.cryptomator.integrations.api {
 	exports org.cryptomator.integrations.autostart;
 	exports org.cryptomator.integrations.keychain;
@@ -12,5 +14,6 @@
 	uses AutoStartProvider;
 	uses KeychainAccessProvider;
 	uses TrayIntegrationProvider;
+	uses TrayMenuController;
 	uses UiAppearanceProvider;
 }

src/main/java/org/cryptomator/integrations/tray/ActionItem.java

@@ -0,0 +1,4 @@
+package org.cryptomator.integrations.tray;
+
+public record ActionItem(String title, Runnable action) implements TrayMenuItem {
+}

src/main/java/org/cryptomator/integrations/tray/SeparatorItem.java

@@ -0,0 +1,4 @@
+package org.cryptomator.integrations.tray;
+
+public record SeparatorItem() implements TrayMenuItem {
+}

src/main/java/org/cryptomator/integrations/tray/SubMenuItem.java

@@ -0,0 +1,6 @@
+package org.cryptomator.integrations.tray;
+
+import java.util.List;
+
+public record SubMenuItem(String title, List<TrayMenuItem> items) implements TrayMenuItem {
+}

src/main/java/org/cryptomator/integrations/tray/TrayIntegrationProvider.java

@@ -4,8 +4,17 @@
 
 import java.util.Optional;
 
+/**
+ * Allows to perform OS-specific tasks when the app gets minimized to or restored from a tray icon.
+ */
 public interface TrayIntegrationProvider {
 
+	/**
+	 * Loads the best-suited TrayIntegrationProvider.
+	 *
+	 * @return preferred TrayIntegrationProvider (if any)
+	 * @since 1.1.0
+	 */
 	static Optional<TrayIntegrationProvider> get() {
 		return IntegrationsLoader.load(TrayIntegrationProvider.class);
 	}

src/main/java/org/cryptomator/integrations/tray/TrayMenuController.java

@@ -0,0 +1,40 @@
+package org.cryptomator.integrations.tray;
+
+import org.cryptomator.integrations.common.IntegrationsLoader;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Displays a tray icon and menu
+ *
+ * @since 1.1.0
+ */
+public interface TrayMenuController {
+
+	static Optional<TrayMenuController> get() {
+		return IntegrationsLoader.load(TrayMenuController.class);
+	}
+
+	/**
+	 * Displays an icon on the system tray.
+	 *
+	 * @param rawImageData  What image to show
+	 * @param defaultAction Action to perform when interacting with the icon directly instead of its menu
+	 * @param tooltip       Text shown when hovering
+	 * @throws IOException thrown when interacting with the given <code>rawImageData</code>
+	 */
+	void showTrayIcon(InputStream rawImageData, Runnable defaultAction, String tooltip) throws IOException;
+
+	/**
+	 * Show the given options in the tray menu.
+	 * <p>
+	 * This method may be called multiple times, e.g. when the vault list changes.
+	 *
+	 * @param items Menu items
+	 */
+	void updateTrayMenu(List<TrayMenuItem> items);
+
+}

src/main/java/org/cryptomator/integrations/tray/TrayMenuItem.java

@@ -0,0 +1,4 @@
+package org.cryptomator.integrations.tray;
+
+public sealed interface TrayMenuItem permits ActionItem, SubMenuItem, SeparatorItem {
+}