org.cryptomator.integrations.uiappearance.UiAppearanceProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of integrations-api Show documentation

Defines optional service interfaces that may be used by Cryptomator

There is a newer version: 2.0.0-alpha1

package org.cryptomator.integrations.uiappearance;

/**
 * This is the interface used by Cryptomator to get os specific UI appearances and themes.
 */
public interface UiAppearanceProvider {

	/**
	 * Gets the best-matching theme for the OS's current L&F. This might be an approximation, as the OS might support more variations than we do.
	 *
	 * @implSpec Should default to {@link Theme#LIGHT} if the OS theme can't be determined, should not throw exceptions.
	 * @return The current OS theme
	 */
	Theme getSystemTheme();

	/**
	 * Adjusts parts of the UI to the desired theme, that can not be directly controlled from within Java.
	 * This might be required for window decorations or tray icons. Can be no-op.
	 *
	 * @implSpec A best-effort attempt should be made. If adjustments fail, do not throw an exception.
	 * @param theme What theme to adjust to
	 */
	void adjustToTheme(Theme theme);

	/**
	 * Registers a listener that gets notified when the system theme changes.
	 *
	 * @param listener The listener
	 * @throws UiAppearanceException If registering the listener failed.
	 */
	void addListener(UiAppearanceListener listener) throws UiAppearanceException;

	/**
	 * Removes a previously registered listener.
	 * 
	 * If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op.
	 *
	 * @param listener The listener
	 * @throws UiAppearanceException If removing the listener failed.
	 */
	void removeListener(UiAppearanceListener listener) throws UiAppearanceException;

}