davmail.ui

Class OSXAdapter

java.lang.Object

davmail.ui.OSXAdapter

All Implemented Interfaces:

InvocationHandler

public class OSXAdapter
extends Object
implements InvocationHandler

Reflection based MacOS handler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	proxySignature
protected Method	targetMethod
protected Object	targetObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OSXAdapter(String proxySignature, Object target, Method handler) Each OSXAdapter has the name of the EAWT method it intends to listen for (handleAbout, for example), the Object that will ultimately perform the task, and the Method to be called on that Object

Method Summary

Modifier and Type	Method and Description
boolean	callTarget(Object appleEvent) Override this method to perform any operations on the event that comes with the various callbacks.
Object	invoke(Object proxy, Method method, Object[] args) InvocationHandler implementation.
protected boolean	isCorrectMethod(Method method, Object[] args) Compare the method that was called to the intended method when the OSXAdapter instance was created (e.g.
static void	setAboutHandler(Object target, Method aboutHandler) Pass this method an Object and Method equipped to display application info They will be called when the About menu item is selected from the application menu
protected void	setApplicationEventHandled(Object event, boolean handled) It is important to mark the ApplicationEvent as handled and cancel the default behavior.
static void	setFileHandler(Object target, Method fileHandler) Pass this method an Object and a Method equipped to handle document events from the Finder.
static void	setHandler(OSXAdapter adapter) setHandler creates a Proxy object from the passed OSXAdapter and adds it as an ApplicationListener.
static void	setPreferencesHandler(Object target, Method prefsHandler) Pass this method an Object and a Method equipped to display application options.
static void	setQuitHandler(Object target, Method quitHandler) Pass this method an Object and Method equipped to perform application shutdown logic.

Methods inherited from class java.lang.Object

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

Field Detail

targetObject

protected final Object targetObject

targetMethod

protected final Method targetMethod

proxySignature

protected final String proxySignature

Constructor Detail

OSXAdapter

protected OSXAdapter(String proxySignature,
                     Object target,
                     Method handler)

Each OSXAdapter has the name of the EAWT method it intends to listen for (handleAbout, for example), the Object that will ultimately perform the task, and the Method to be called on that Object

Parameters:

proxySignature - proxy signature

target - target object

handler - handler method

Method Detail

setQuitHandler

public static void setQuitHandler(Object target,
                                  Method quitHandler)
                           throws InvocationTargetException,
                                  ClassNotFoundException,
                                  NoSuchMethodException,
                                  InstantiationException,
                                  IllegalAccessException

Pass this method an Object and Method equipped to perform application shutdown logic. The method passed should return a boolean stating whether or not the quit should occur

Parameters:

target - target object

quitHandler - quit method

Throws:

InvocationTargetException - on error

ClassNotFoundException - on error

NoSuchMethodException - on error

InstantiationException - on error

IllegalAccessException - on error

setAboutHandler

public static void setAboutHandler(Object target,
                                   Method aboutHandler)
                            throws InvocationTargetException,
                                   IllegalAccessException,
                                   NoSuchMethodException,
                                   ClassNotFoundException,
                                   InstantiationException

Pass this method an Object and Method equipped to display application info They will be called when the About menu item is selected from the application menu

Parameters:

target - target object

aboutHandler - about method

Throws:

InvocationTargetException - on error

ClassNotFoundException - on error

NoSuchMethodException - on error

InstantiationException - on error

IllegalAccessException - on error

setPreferencesHandler

public static void setPreferencesHandler(Object target,
                                         Method prefsHandler)
                                  throws InvocationTargetException,
                                         IllegalAccessException,
                                         NoSuchMethodException,
                                         ClassNotFoundException,
                                         InstantiationException

Pass this method an Object and a Method equipped to display application options. They will be called when the Preferences menu item is selected from the application menu

Parameters:

target - target object

prefsHandler - preferences method

Throws:

InvocationTargetException - on error

ClassNotFoundException - on error

NoSuchMethodException - on error

InstantiationException - on error

IllegalAccessException - on error

setFileHandler

public static void setFileHandler(Object target,
                                  Method fileHandler)
                           throws InvocationTargetException,
                                  ClassNotFoundException,
                                  NoSuchMethodException,
                                  InstantiationException,
                                  IllegalAccessException

Pass this method an Object and a Method equipped to handle document events from the Finder. Documents are registered with the Finder via the CFBundleDocumentTypes dictionary in the application bundle's Info.plist

Parameters:

target - target object

fileHandler - file method

Throws:

InvocationTargetException - on error

ClassNotFoundException - on error

NoSuchMethodException - on error

InstantiationException - on error

IllegalAccessException - on error

setHandler

public static void setHandler(OSXAdapter adapter)
                       throws ClassNotFoundException,
                              NoSuchMethodException,
                              InvocationTargetException,
                              IllegalAccessException,
                              InstantiationException

setHandler creates a Proxy object from the passed OSXAdapter and adds it as an ApplicationListener.

Parameters:

adapter - OSX adapter

Throws:

InvocationTargetException - on error

ClassNotFoundException - on error

NoSuchMethodException - on error

InstantiationException - on error

IllegalAccessException - on error

callTarget

public boolean callTarget(Object appleEvent)
                   throws InvocationTargetException,
                          IllegalAccessException

Override this method to perform any operations on the event that comes with the various callbacks. See setFileHandler above for an example

Parameters:

appleEvent - apple event object

Returns:

true on success

Throws:

InvocationTargetException - on error

IllegalAccessException - on error

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

InvocationHandler implementation. This is the entry point for our proxy object; it is called every time an ApplicationListener method is invoked

Specified by:

invoke in interface InvocationHandler

Parameters:

proxy - proxy object

method - handler method

args - method arguments

Returns:

null

Throws:

Throwable - on error

isCorrectMethod

protected boolean isCorrectMethod(Method method,
                                  Object[] args)

Compare the method that was called to the intended method when the OSXAdapter instance was created (e.g. handleAbout, handleQuit, handleOpenFile, etc.).

Parameters:

method - handler method

args - method arguments

Returns:

true if method is correct

setApplicationEventHandled

protected void setApplicationEventHandled(Object event,
                                          boolean handled)
                                   throws NoSuchMethodException,
                                          InvocationTargetException,
                                          IllegalAccessException

It is important to mark the ApplicationEvent as handled and cancel the default behavior. This method checks for a boolean result from the proxy method and sets the event accordingly

Parameters:

event - event object

handled - true if event handled

Throws:

NoSuchMethodException - on error

InvocationTargetException - on error

IllegalAccessException - on error