org.openstreetmap.josm.tools

Class PlatformHookOsx

java.lang.Object

org.openstreetmap.josm.tools.PlatformHookOsx

All Implemented Interfaces:

java.lang.reflect.InvocationHandler, PlatformHook

public class PlatformHookOsx
extends java.lang.Object
implements PlatformHook, java.lang.reflect.InvocationHandler

PlatformHook implementation for Apple macOS (formerly Mac OS X) systems.

Since:

1023

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstreetmap.josm.tools.PlatformHook

PlatformHook.JavaExpirationCallback, PlatformHook.NativeOsCallback

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	oSBuildNumber
private PlatformHook.NativeOsCallback	osCallback

Fields inherited from interface org.openstreetmap.josm.tools.PlatformHook

CONSTRUCT_FROM_PLATFORM

Constructor Summary

Constructors

Constructor and Description
PlatformHookOsx()

Method Summary

Modifier and Type	Method and Description
private static void	auto(Shortcut sc)
private java.lang.String	buildOSBuildNumber()
boolean	canFullscreen() Determines if the platform allows full-screen.
static void	enableOSXFullscreen(java.awt.Window window) Enables fullscreen support for the given window.
protected java.lang.Class<?>	findHandlerClass(java.lang.String className) Find Apple handler class in com.apple.eawt or java.awt.desktop packages.
java.io.File	getDefaultCacheDirectory() Returns the platform-dependent default cache directory.
java.io.File	getDefaultPrefDirectory() Returns the platform-dependent default preferences directory.
java.lang.String	getDefaultStyle() Returns the default LAF to be used on this platform to look almost as a native application.
java.io.File	getDefaultUserDataDirectory() Returns the platform-dependent default user data directory.
int	getMenuShortcutKeyMaskEx() Returns extended modifier key used as the appropriate accelerator key for menu shortcuts.
java.lang.String	getOSBuildNumber() Returns OS build number.
java.lang.String	getOSDescription() Returns a detailed OS description (at least family + version).
Platform	getPlatform() Get the platform corresponding to this platform hook.
java.security.cert.X509Certificate	getX509Certificate(CertificateAmendment.NativeCertAmend certAmend) Returns the X509Certificate matching the given certificate amendment information.
void	initSystemShortcuts() The initSystemShortcuts hook will be called by the Shortcut class after the modifier groups have been read from the config, but before any shortcuts are read from it or registered from within the application.
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
void	openUrl(java.lang.String url) The openURL hook will be used to open an URL in the default web browser.
void	preStartupHook() The preStartupHook will be called extremely early.
protected void	setHandlers(java.lang.Class<?> appClass, java.lang.Class<?> quitHandler, java.lang.Class<?> aboutHandler, java.lang.Class<?> openFilesHandler, java.lang.Class<?> preferencesHandler, java.lang.Object proxy, java.lang.Object appInstance) Registers Apple handlers.
void	setNativeOsCallback(PlatformHook.NativeOsCallback callback) Registers the native OS callback.
void	startupHook(PlatformHook.JavaExpirationCallback callback) The startupHook will be called early, but after the GUI setup has started.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.tools.PlatformHook

afterPrefStartupHook, checkExpiredJava, exec, getDefaultProj4NadshiftDirectories, getPossiblePreferenceDirs, isOpenJDK, rename, resolveFileLink, setupHttpsCertificate

Field Detail

oSBuildNumber

private java.lang.String oSBuildNumber

osCallback

private PlatformHook.NativeOsCallback osCallback

Constructor Detail

PlatformHookOsx

public PlatformHookOsx()

Method Detail

getPlatform

public Platform getPlatform()

Description copied from interface: PlatformHook

Get the platform corresponding to this platform hook.

Specified by:

getPlatform in interface PlatformHook

Returns:

the platform corresponding to this platform hook

preStartupHook

public void preStartupHook()

Description copied from interface: PlatformHook

The preStartupHook will be called extremely early. It is guaranteed to be called before the GUI setup has started. Reason: On OSX we need to inform the Swing libraries that we want to be integrated with the OS before we setup our GUI.

Specified by:

preStartupHook in interface PlatformHook

startupHook

public void startupHook(PlatformHook.JavaExpirationCallback callback)

Description copied from interface: PlatformHook

The startupHook will be called early, but after the GUI setup has started. Reason: On OSX we need to register some callbacks with the OS, so we'll receive events from the system menu.

Specified by:

startupHook in interface PlatformHook

Parameters:

callback - Java expiration callback, providing GUI feedback

getMenuShortcutKeyMaskEx

public int getMenuShortcutKeyMaskEx()

Description copied from interface: PlatformHook

Returns extended modifier key used as the appropriate accelerator key for menu shortcuts. It is advised everywhere to use Toolkit.getMenuShortcutKeyMask() to get the cross-platform modifier, but:

• it returns KeyEvent.CTRL_MASK instead of KeyEvent.CTRL_DOWN_MASK. We used the extended modifier for years, and Oracle recommends to use it instead, so it's best to keep it
• the method throws a HeadlessException ! So we would need to handle it for unit tests anyway

Specified by:

getMenuShortcutKeyMaskEx in interface PlatformHook

Returns:

extended modifier key used as the appropriate accelerator key for menu shortcuts

setHandlers

protected void setHandlers(java.lang.Class<?> appClass,
                           java.lang.Class<?> quitHandler,
                           java.lang.Class<?> aboutHandler,
                           java.lang.Class<?> openFilesHandler,
                           java.lang.Class<?> preferencesHandler,
                           java.lang.Object proxy,
                           java.lang.Object appInstance)
                    throws java.lang.IllegalAccessException,
                           java.lang.reflect.InvocationTargetException,
                           java.lang.NoSuchMethodException

Registers Apple handlers.

Parameters:

appClass - application class

quitHandler - quit handler class

aboutHandler - about handler class

openFilesHandler - open file handler class

preferencesHandler - preferences handler class

proxy - proxy

appInstance - application instance (instance of appClass)

Throws:

java.lang.IllegalAccessException - in case of reflection error

java.lang.reflect.InvocationTargetException - in case of reflection error

java.lang.NoSuchMethodException - if any set*Handler method cannot be found

findHandlerClass

protected java.lang.Class<?> findHandlerClass(java.lang.String className)
                                       throws java.lang.ClassNotFoundException

Find Apple handler class in com.apple.eawt or java.awt.desktop packages.

Parameters:

className - simple class name

Returns:

class

Throws:

java.lang.ClassNotFoundException - if the handler class cannot be found

enableOSXFullscreen

public static void enableOSXFullscreen(java.awt.Window window)

Enables fullscreen support for the given window.

Parameters:

window - The window for which full screen will be available

Since:

7482

setNativeOsCallback

public void setNativeOsCallback(PlatformHook.NativeOsCallback callback)

Description copied from interface: PlatformHook

Registers the native OS callback. Currently only needed for macOS.

Specified by:

setNativeOsCallback in interface PlatformHook

Parameters:

callback - the native OS callback

invoke

public java.lang.Object invoke(java.lang.Object proxy,
                               java.lang.reflect.Method method,
                               java.lang.Object[] args)
                        throws java.lang.Throwable

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

java.lang.Throwable

openUrl

public void openUrl(java.lang.String url)
             throws java.io.IOException

Description copied from interface: PlatformHook

The openURL hook will be used to open an URL in the default web browser.

Specified by:

openUrl in interface PlatformHook

Parameters:

url - The URL to open

Throws:

java.io.IOException - if any I/O error occurs

initSystemShortcuts

public void initSystemShortcuts()

Description copied from interface: PlatformHook

The initSystemShortcuts hook will be called by the Shortcut class after the modifier groups have been read from the config, but before any shortcuts are read from it or registered from within the application. Please note that you are not allowed to register any shortuts from this hook, but only "systemCuts"! BTW: SystemCuts should be named "system:<whatever>", and it'd be best if sou'd recycle the names already used by the Windows and OSX hooks. Especially the later has really many of them. You should also register any and all shortcuts that the operation system handles itself to block JOSM from trying to use them---as that would just not work. Call setAutomatic on them to prevent the keyboard preferences from allowing the user to change them.

Specified by:

initSystemShortcuts in interface PlatformHook

auto

private static void auto(Shortcut sc)

getDefaultStyle

public java.lang.String getDefaultStyle()

Description copied from interface: PlatformHook

Returns the default LAF to be used on this platform to look almost as a native application.

Specified by:

getDefaultStyle in interface PlatformHook

Returns:

The default native LAF for this platform

canFullscreen

public boolean canFullscreen()

Description copied from interface: PlatformHook

Determines if the platform allows full-screen.

Specified by:

canFullscreen in interface PlatformHook

Returns:

true if full screen is allowed, false otherwise

getOSDescription

public java.lang.String getOSDescription()

Description copied from interface: PlatformHook

Returns a detailed OS description (at least family + version).

Specified by:

getOSDescription in interface PlatformHook

Returns:

A detailed OS description.

buildOSBuildNumber

private java.lang.String buildOSBuildNumber()

getOSBuildNumber

public java.lang.String getOSBuildNumber()

Description copied from interface: PlatformHook

Returns OS build number.

Specified by:

getOSBuildNumber in interface PlatformHook

Returns:

OS build number.

getDefaultCacheDirectory

public java.io.File getDefaultCacheDirectory()

Description copied from interface: PlatformHook

Returns the platform-dependent default cache directory.

Specified by:

getDefaultCacheDirectory in interface PlatformHook

Returns:

the platform-dependent default cache directory

getDefaultPrefDirectory

public java.io.File getDefaultPrefDirectory()

Description copied from interface: PlatformHook

Returns the platform-dependent default preferences directory.

Specified by:

getDefaultPrefDirectory in interface PlatformHook

Returns:

the platform-dependent default preferences directory

getDefaultUserDataDirectory

public java.io.File getDefaultUserDataDirectory()

Description copied from interface: PlatformHook

Returns the platform-dependent default user data directory.

Specified by:

getDefaultUserDataDirectory in interface PlatformHook

Returns:

the platform-dependent default user data directory

getX509Certificate

public java.security.cert.X509Certificate getX509Certificate(CertificateAmendment.NativeCertAmend certAmend)
                                                      throws java.security.KeyStoreException,
                                                             java.security.NoSuchAlgorithmException,
                                                             java.security.cert.CertificateException,
                                                             java.io.IOException

Description copied from interface: PlatformHook

Returns the X509Certificate matching the given certificate amendment information.

Specified by:

getX509Certificate in interface PlatformHook

Parameters:

certAmend - certificate amendment

Returns:

the X509Certificate matching the given certificate amendment information, or null

Throws:

java.security.KeyStoreException - in case of error

java.security.NoSuchAlgorithmException - in case of error

java.security.cert.CertificateException - in case of error

java.io.IOException - in case of error