Module org.scijava.desktop

Package org.scijava.desktop.platform.linux

Class LinuxPlatform

java.lang.Object

org.scijava.platform.AbstractPlatform

org.scijava.desktop.platform.linux.LinuxPlatform

All Implemented Interfaces:

DesktopIntegrationProvider, org.scijava.Disposable, org.scijava.platform.Platform, org.scijava.plugin.SciJavaPlugin, org.scijava.plugin.SingletonPlugin

public class LinuxPlatform
extends org.scijava.platform.AbstractPlatform
implements DesktopIntegrationProvider

A platform implementation for handling Linux platform issues.

This implementation creates and maintains a .desktop file for the application, enabling proper desktop integration including:

• Application launcher in menus
• Application icon
• File associations
• URI scheme handling

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
LinuxPlatform()

Method Summary

Modifier and Type	Method	Description
void	configure(org.scijava.platform.PlatformService service)
SchemeInstaller	getSchemeInstaller()	Creates a SchemeInstaller for this platform.
boolean	isDesktopIconPresent()
boolean	isDesktopIconToggleable()
boolean	isFileExtensionsEnabled()
boolean	isFileExtensionsToggleable()
boolean	isWebLinksEnabled()
boolean	isWebLinksToggleable()
void	open(URL url)
String	osName()
void	setDesktopIconPresent(boolean install)	Installs or removes the desktop icon (application launcher, menu entry).
void	setFileExtensionsEnabled(boolean enable)	Enables or disables file extension associations (e.g., .tif, .png).
void	setWebLinksEnabled(boolean enable)	Enables or disables URI scheme registration (e.g., myapp:// links).
void	syncDesktopIntegration(boolean webLinks, boolean desktopIcon, boolean fileTypes)	Atomically applies all three desktop integration settings at once.

Methods inherited from class org.scijava.platform.AbstractPlatform

getPlatformService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.platform.Platform

isTarget, javaVendor, javaVersion, osArch, osVersion, registerAppMenus

Constructor Detail

LinuxPlatform

public LinuxPlatform()

Method Detail

osName

public String osName()

Specified by:

osName in interface org.scijava.platform.Platform

configure

public void configure(org.scijava.platform.PlatformService service)

Specified by:

configure in interface org.scijava.platform.Platform

Overrides:

configure in class org.scijava.platform.AbstractPlatform

open

public void open(URL url)
          throws IOException

Specified by:

open in interface org.scijava.platform.Platform

Throws:

IOException

isWebLinksEnabled

public boolean isWebLinksEnabled()

Specified by:

isWebLinksEnabled in interface DesktopIntegrationProvider

isWebLinksToggleable

public boolean isWebLinksToggleable()

Specified by:

isWebLinksToggleable in interface DesktopIntegrationProvider

setWebLinksEnabled

public void setWebLinksEnabled(boolean enable)
                        throws IOException

Description copied from interface: DesktopIntegrationProvider

Enables or disables URI scheme registration (e.g., myapp:// links).

This operation only works if DesktopIntegrationProvider.isWebLinksToggleable() returns true. Otherwise, calling this method may throw UnsupportedOperationException.

Specified by:

setWebLinksEnabled in interface DesktopIntegrationProvider

Parameters:

enable - whether to enable or disable web links

Throws:

IOException - if the operation fails

isDesktopIconPresent

public boolean isDesktopIconPresent()

Specified by:

isDesktopIconPresent in interface DesktopIntegrationProvider

isDesktopIconToggleable

public boolean isDesktopIconToggleable()

Specified by:

isDesktopIconToggleable in interface DesktopIntegrationProvider

setDesktopIconPresent

public void setDesktopIconPresent(boolean install)
                           throws IOException

Description copied from interface: DesktopIntegrationProvider

Installs or removes the desktop icon (application launcher, menu entry).

This operation only works if DesktopIntegrationProvider.isDesktopIconToggleable() returns true. Otherwise, calling this method may throw UnsupportedOperationException.

Specified by:

setDesktopIconPresent in interface DesktopIntegrationProvider

Parameters:

install - whether to install or remove the desktop icon

Throws:

IOException - if the operation fails

isFileExtensionsEnabled

public boolean isFileExtensionsEnabled()

Specified by:

isFileExtensionsEnabled in interface DesktopIntegrationProvider

isFileExtensionsToggleable

public boolean isFileExtensionsToggleable()

Specified by:

isFileExtensionsToggleable in interface DesktopIntegrationProvider

setFileExtensionsEnabled

public void setFileExtensionsEnabled(boolean enable)
                              throws IOException

Description copied from interface: DesktopIntegrationProvider

Enables or disables file extension associations (e.g., .tif, .png).

This operation only works if DesktopIntegrationProvider.isFileExtensionsToggleable() returns true. Otherwise, calling this method may throw UnsupportedOperationException.

When enabled, the application will be registered as a handler for all supported file extensions. The application appears in "Open With" menus, allowing users to choose it for specific file types.

Specified by:

setFileExtensionsEnabled in interface DesktopIntegrationProvider

Parameters:

enable - whether to enable or disable file extension associations

Throws:

IOException - if the operation fails

syncDesktopIntegration

public void syncDesktopIntegration(boolean webLinks,
                                   boolean desktopIcon,
                                   boolean fileTypes)
                            throws IOException

Description copied from interface: DesktopIntegrationProvider

Atomically applies all three desktop integration settings at once.

Implementations that store all three settings in a single artifact (e.g. a Linux .desktop file) should override this method to synthesize that artifact in one pass rather than via three independent read-modify-write cycles.

The default implementation calls the three individual setters in order, guarded by the corresponding isXxxToggleable() checks.

Specified by:

syncDesktopIntegration in interface DesktopIntegrationProvider

Parameters:

webLinks - whether URI scheme handlers should be registered

desktopIcon - whether the application launcher entry should be present

fileTypes - whether file-extension associations should be registered

Throws:

IOException - if any part of the update fails

getSchemeInstaller

public SchemeInstaller getSchemeInstaller()

Description copied from interface: DesktopIntegrationProvider

Creates a SchemeInstaller for this platform.

Specified by:

getSchemeInstaller in interface DesktopIntegrationProvider

Returns:

a SchemeInstaller, or null if not supported on this platform