Module org.scijava.desktop

Package org.scijava.desktop.platform.macos

Class MacOSPlatform

java.lang.Object

org.scijava.platform.AbstractPlatform

org.scijava.desktop.platform.macos.MacOSPlatform

All Implemented Interfaces:

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

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

A platform implementation for handling Apple macOS platform issues:

• Application events are rebroadcast as SciJava events.
• macOS screen menu bar is enabled.
• Special screen menu bar menu items are handled.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
MacOSPlatform()

Method Summary

Modifier and Type	Method	Description
void	configure(org.scijava.platform.PlatformService service)
void	dispose()
SchemeInstaller	getSchemeInstaller()	Creates a SchemeInstaller for this platform.
boolean	isDesktopIconPresent()
boolean	isDesktopIconToggleable()
boolean	isFileExtensionsEnabled()
boolean	isFileExtensionsToggleable()
boolean	isWebLinksEnabled()
boolean	isWebLinksToggleable()
protected void	onEvent(org.scijava.display.event.window.WinActivatedEvent evt)
void	open(URL url)
String	osName()
boolean	registerAppMenus(Object menus)
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).

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.desktop.DesktopIntegrationProvider

syncDesktopIntegration

Methods inherited from interface org.scijava.platform.Platform

isTarget, javaVendor, javaVersion, osArch, osVersion

Constructor Detail

MacOSPlatform

public MacOSPlatform()

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

registerAppMenus

public boolean registerAppMenus(Object menus)

Specified by:

registerAppMenus in interface org.scijava.platform.Platform

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)

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

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)

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

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)

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

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

dispose

public void dispose()

Specified by:

dispose in interface org.scijava.Disposable

onEvent

protected void onEvent(org.scijava.display.event.window.WinActivatedEvent evt)