Supported operations include: *
This class provides methods corresponding to these * operations. The methods look for the associated application * registered on the current platform, and launch it to handle a URI * or file. If there is no associated application or the associated * application fails to be launched, an exception is thrown. * * Please see {@link Desktop.Action} for the full list of supported operations * and capabilities. * *
An application is registered to a URI or file type; for * example, the {@code "sxi"} file extension is typically registered * to StarOffice. The mechanism of registering, accessing, and * launching the associated application is platform-dependent. * *
Each operation is an action type represented by the {@link * Desktop.Action} class. * *
Note: when some action is invoked and the associated
* application is executed, it will be executed on the same system as
* the one on which the Java application was launched.
*
* @see Action
*
* @since 1.6
* @author Armin Chen
* @author George Zhang
*/
public class Desktop {
/**
* Represents an action type. Each platform supports a different
* set of actions. You may use the {@link Desktop#isSupported}
* method to determine if the given action is supported by the
* current platform.
* @see java.awt.Desktop#isSupported(java.awt.Desktop.Action)
* @since 1.6
*/
public static enum Action {
/**
* Represents an "open" action.
* @see Desktop#open(java.io.File)
*/
OPEN,
/**
* Represents an "edit" action.
* @see Desktop#edit(java.io.File)
*/
EDIT,
/**
* Represents a "print" action.
* @see Desktop#print(java.io.File)
*/
PRINT,
/**
* Represents a "mail" action.
* @see Desktop#mail()
* @see Desktop#mail(java.net.URI)
*/
MAIL,
/**
* Represents a "browse" action.
* @see Desktop#browse(java.net.URI)
*/
BROWSE,
/**
* Represents an AppForegroundListener
* @see java.awt.desktop.AppForegroundListener
* @since 1.9
*/
APP_EVENT_FOREGROUND,
/**
* Represents an AppHiddenListener
* @see java.awt.desktop.AppHiddenListener
* @since 1.9
*/
APP_EVENT_HIDDEN,
/**
* Represents an AppReopenedListener
* @see java.awt.desktop.AppReopenedListener
* @since 1.9
*/
APP_EVENT_REOPENED,
/**
* Represents a ScreenSleepListener
* @see java.awt.desktop.ScreenSleepListener
* @since 1.9
*/
APP_EVENT_SCREEN_SLEEP,
/**
* Represents a SystemSleepListener
* @see java.awt.desktop.SystemSleepListener
* @since 1.9
*/
APP_EVENT_SYSTEM_SLEEP,
/**
* Represents a UserSessionListener
* @see java.awt.desktop.UserSessionListener
* @since 1.9
*/
APP_EVENT_USER_SESSION,
/**
* Represents an AboutHandler
* @see #setAboutHandler(java.awt.desktop.AboutHandler)
* @since 1.9
*/
APP_ABOUT,
/**
* Represents a PreferencesHandler
* @see #setPreferencesHandler(java.awt.desktop.PreferencesHandler)
* @since 1.9
*/
APP_PREFERENCES,
/**
* Represents an OpenFilesHandler
* @see #setOpenFileHandler(java.awt.desktop.OpenFilesHandler)
* @since 1.9
*/
APP_OPEN_FILE,
/**
* Represents a PrintFilesHandler
* @see #setPrintFileHandler(java.awt.desktop.PrintFilesHandler)
* @since 1.9
*/
APP_PRINT_FILE,
/**
* Represents an OpenURIHandler
* @see #setOpenURIHandler(java.awt.desktop.OpenURIHandler)
* @since 1.9
*/
APP_OPEN_URI,
/**
* Represents a QuitHandler
* @see #setQuitHandler(java.awt.desktop.QuitHandler)
* @since 1.9
*/
APP_QUIT_HANDLER,
/**
* Represents a QuitStrategy
* @see #setQuitStrategy(java.awt.desktop.QuitStrategy)
* @since 1.9
*/
APP_QUIT_STRATEGY,
/**
* Represents a SuddenTermination
* @see #enableSuddenTermination()
* @since 1.9
*/
APP_SUDDEN_TERMINATION,
/**
* Represents a requestForeground
* @see #requestForeground(boolean)
* @since 1.9
*/
APP_REQUEST_FOREGROUND,
/**
* Represents a HelpViewer
* @see #openHelpViewer()
* @since 1.9
*/
APP_HELP_VIEWER,
/**
* Represents a menu bar
* @see #setDefaultMenuBar(javax.swing.JMenuBar)
* @since 1.9
*/
APP_MENU_BAR,
/**
* Represents a browse file directory
* @see #browseFileDirectory(java.io.File)
* @since 1.9
*/
BROWSE_FILE_DIR,
/**
* Represents a move to trash
* @see #moveToTrash(java.io.File)
* @since 1.9
*/
MOVE_TO_TRASH
};
private DesktopPeer peer;
/**
* Suppresses default constructor for noninstantiability.
*/
private Desktop() {
Toolkit defaultToolkit = Toolkit.getDefaultToolkit();
// same cast as in isDesktopSupported()
if (defaultToolkit instanceof SunToolkit) {
peer = ((SunToolkit) defaultToolkit).createDesktopPeer(this);
}
}
/**
* Returns the Desktop instance of the current
* desktop context. On some platforms the Desktop API may not be
* supported; use the {@link #isDesktopSupported} method to
* determine if the current desktop is supported.
* @return the Desktop instance
* @throws HeadlessException if {@link
* GraphicsEnvironment#isHeadless()} returns {@code true}
* @throws UnsupportedOperationException if this class is not
* supported on the current platform
* @see #isDesktopSupported()
* @see java.awt.GraphicsEnvironment#isHeadless
*/
public static synchronized Desktop getDesktop(){
if (GraphicsEnvironment.isHeadless()) throw new HeadlessException();
if (!Desktop.isDesktopSupported()) {
throw new UnsupportedOperationException("Desktop API is not " +
"supported on the current platform");
}
sun.awt.AppContext context = sun.awt.AppContext.getAppContext();
Desktop desktop = (Desktop)context.get(Desktop.class);
if (desktop == null) {
desktop = new Desktop();
context.put(Desktop.class, desktop);
}
return desktop;
}
/**
* Tests whether this class is supported on the current platform.
* If it's supported, use {@link #getDesktop()} to retrieve an
* instance.
*
* @return true if this class is supported on the
* current platform; false otherwise
* @see #getDesktop()
*/
public static boolean isDesktopSupported(){
Toolkit defaultToolkit = Toolkit.getDefaultToolkit();
if (defaultToolkit instanceof SunToolkit) {
return ((SunToolkit)defaultToolkit).isDesktopSupported();
}
return false;
}
/**
* Tests whether an action is supported on the current platform.
*
*
Even when the platform supports an action, a file or URI may
* not have a registered application for the action. For example,
* most of the platforms support the {@link Desktop.Action#OPEN}
* action. But for a specific file, there may not be an
* application registered to open it. In this case, {@link
* #isSupported} may return {@code true}, but the corresponding
* action method will throw an {@link IOException}.
*
* @param action the specified {@link Action}
* @return true if the specified action is supported on
* the current platform; false otherwise
* @see Desktop.Action
*/
public boolean isSupported(Action action) {
return peer.isSupported(action);
}
/**
* Checks if the file is a valid file and readable.
*
* @throws SecurityException If a security manager exists and its
* {@link SecurityManager#checkRead(java.lang.String)} method
* denies read access to the file
* @throws NullPointerException if file is null
* @throws IllegalArgumentException if file doesn't exist
*/
private static void checkFileValidation(File file){
if (file == null) throw new NullPointerException("File must not be null");
if (!file.exists()) {
throw new IllegalArgumentException("The file: "
+ file.getPath() + " doesn't exist.");
}
file.canRead();
}
/**
* Checks if the action type is supported.
*
* @param actionType the action type in question
* @throws UnsupportedOperationException if the specified action type is not
* supported on the current platform
*/
private void checkActionSupport(Action actionType){
if (!isSupported(actionType)) {
throw new UnsupportedOperationException("The " + actionType.name()
+ " action is not supported on the current platform!");
}
}
/**
* Calls to the security manager's checkPermission method with
* an AWTPermission("showWindowWithoutWarningBanner")
* permission.
*/
private void checkAWTPermission(){
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPermission(new AWTPermission(
"showWindowWithoutWarningBanner"));
}
}
/**
* Launches the associated application to open the file.
*
*
If the specified file is a directory, the file manager of
* the current platform is launched to open it.
*
* @param file the file to be opened with the associated application
* @throws NullPointerException if {@code file} is {@code null}
* @throws IllegalArgumentException if the specified file doesn't
* exist
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#OPEN} action
* @throws IOException if the specified file has no associated
* application or the associated application fails to be launched
* @throws SecurityException if a security manager exists and its
* {@link java.lang.SecurityManager#checkRead(java.lang.String)}
* method denies read access to the file, or it denies the
* AWTPermission("showWindowWithoutWarningBanner")
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.awt.AWTPermission
*/
public void open(File file) throws IOException {
checkAWTPermission();
checkExec();
checkActionSupport(Action.OPEN);
checkFileValidation(file);
peer.open(file);
}
/**
* Launches the associated editor application and opens a file for
* editing.
*
* @param file the file to be opened for editing
* @throws NullPointerException if the specified file is {@code null}
* @throws IllegalArgumentException if the specified file doesn't
* exist
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#EDIT} action
* @throws IOException if the specified file has no associated
* editor, or the associated application fails to be launched
* @throws SecurityException if a security manager exists and its
* {@link java.lang.SecurityManager#checkRead(java.lang.String)}
* method denies read access to the file, or {@link
* java.lang.SecurityManager#checkWrite(java.lang.String)} method
* denies write access to the file, or it denies the
* AWTPermission("showWindowWithoutWarningBanner")
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.awt.AWTPermission
*/
public void edit(File file) throws IOException {
checkAWTPermission();
checkExec();
checkActionSupport(Action.EDIT);
file.canWrite();
checkFileValidation(file);
peer.edit(file);
}
/**
* Prints a file with the native desktop printing facility, using
* the associated application's print command.
*
* @param file the file to be printed
* @throws NullPointerException if the specified file is {@code
* null}
* @throws IllegalArgumentException if the specified file doesn't
* exist
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#PRINT} action
* @throws IOException if the specified file has no associated
* application that can be used to print it
* @throws SecurityException if a security manager exists and its
* {@link java.lang.SecurityManager#checkRead(java.lang.String)}
* method denies read access to the file, or its {@link
* java.lang.SecurityManager#checkPrintJobAccess()} method denies
* the permission to print the file, or the calling thread is not
* allowed to create a subprocess
*/
public void print(File file) throws IOException {
checkExec();
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPrintJobAccess();
}
checkActionSupport(Action.PRINT);
checkFileValidation(file);
peer.print(file);
}
/**
* Launches the default browser to display a {@code URI}.
* If the default browser is not able to handle the specified
* {@code URI}, the application registered for handling
* {@code URIs} of the specified type is invoked. The application
* is determined from the protocol and path of the {@code URI}, as
* defined by the {@code URI} class.
*
* If the calling thread does not have the necessary permissions,
* and this is invoked from within an applet,
* {@code AppletContext.showDocument()} is used. Similarly, if the calling
* does not have the necessary permissions, and this is invoked from within
* a Java Web Started application, {@code BasicService.showDocument()}
* is used.
*
* @param uri the URI to be displayed in the user default browser
* @throws NullPointerException if {@code uri} is {@code null}
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#BROWSE} action
* @throws IOException if the user default browser is not found,
* or it fails to be launched, or the default handler application
* failed to be launched
* @throws SecurityException if a security manager exists and it
* denies the
* AWTPermission("showWindowWithoutWarningBanner")
* permission, or the calling thread is not allowed to create a
* subprocess; and not invoked from within an applet or Java Web Started
* application
* @throws IllegalArgumentException if the necessary permissions
* are not available and the URI can not be converted to a {@code URL}
* @see java.net.URI
* @see java.awt.AWTPermission
* @see java.applet.AppletContext
*/
public void browse(URI uri) throws IOException {
SecurityException securityException = null;
try {
checkAWTPermission();
checkExec();
} catch (SecurityException e) {
securityException = e;
}
checkActionSupport(Action.BROWSE);
if (uri == null) {
throw new NullPointerException();
}
if (securityException == null) {
peer.browse(uri);
return;
}
// Calling thread doesn't have necessary privileges.
// Delegate to DesktopBrowse so that it can work in
// applet/webstart.
URL url = null;
try {
url = uri.toURL();
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Unable to convert URI to URL", e);
}
sun.awt.DesktopBrowse db = sun.awt.DesktopBrowse.getInstance();
if (db == null) {
// Not in webstart/applet, throw the exception.
throw securityException;
}
db.browse(url);
}
/**
* Launches the mail composing window of the user default mail
* client.
*
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#MAIL} action
* @throws IOException if the user default mail client is not
* found, or it fails to be launched
* @throws SecurityException if a security manager exists and it
* denies the
* AWTPermission("showWindowWithoutWarningBanner")
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.awt.AWTPermission
*/
public void mail() throws IOException {
checkAWTPermission();
checkExec();
checkActionSupport(Action.MAIL);
URI mailtoURI = null;
try{
mailtoURI = new URI("mailto:?");
peer.mail(mailtoURI);
} catch (URISyntaxException e){
// won't reach here.
}
}
/**
* Launches the mail composing window of the user default mail
* client, filling the message fields specified by a {@code
* mailto:} URI.
*
*
A
* Setting the {@link AboutHandler} to
* Setting the {@link PreferencesHandler} to mailto: URI can specify message fields
* including "to", "cc", "subject",
* "body", etc. See The mailto URL
* scheme (RFC 2368) for the {@code mailto:} URI specification
* details.
*
* @param mailtoURI the specified {@code mailto:} URI
* @throws NullPointerException if the specified URI is {@code
* null}
* @throws IllegalArgumentException if the URI scheme is not
* "mailto"
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#MAIL} action
* @throws IOException if the user default mail client is not
* found or fails to be launched
* @throws SecurityException if a security manager exists and it
* denies the
* AWTPermission("showWindowWithoutWarningBanner")
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.net.URI
* @see java.awt.AWTPermission
*/
public void mail(URI mailtoURI) throws IOException {
checkAWTPermission();
checkExec();
checkActionSupport(Action.MAIL);
if (mailtoURI == null) throw new NullPointerException();
if (!"mailto".equalsIgnoreCase(mailtoURI.getScheme())) {
throw new IllegalArgumentException("URI scheme is not \"mailto\"");
}
peer.mail(mailtoURI);
}
private void checkExec() throws SecurityException {
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPermission(new FilePermission("<null reverts it to the
* default behavior.
*
* @param aboutHandler the handler to respond to the
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_ABOUT} action
* {@link AboutHandler#handleAbout} )} message
* @since 1.9
*/
public void setAboutHandler(final AboutHandler aboutHandler) {
checkActionSupport(Action.APP_ABOUT);
peer.setAboutHandler(aboutHandler);
}
/**
* Installs a handler to show a custom Preferences window for your
* application.
* null reverts it to
* the default behavior
*
* @param preferencesHandler the handler to respond to the
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_PREFERENCES} action
* {@link PreferencesHandler#handlePreferences(PreferencesEvent)}
* @since 1.9
*/
public void setPreferencesHandler(final PreferencesHandler preferencesHandler) {
checkActionSupport(Action.APP_PREFERENCES);
peer.setPreferencesHandler(preferencesHandler);
}
/**
* Installs the handler which is notified when the application is asked to
* open a list of files.
*
* @implNote Please note that for Mac OS, notifications
* are only sent if the Java app is a bundled application,
* with a {@code CFBundleDocumentTypes} array present in its
* Info.plist. See the
*
* Info.plist Key Reference for more information about adding a
* {@code CFBundleDocumentTypes} key to your app's Info.plist.
*
* @param openFileHandler handler
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_OPEN_FILE} action
* @since 1.9
*/
public void setOpenFileHandler(final OpenFilesHandler openFileHandler) {
checkActionSupport(Action.APP_OPEN_FILE);
peer.setOpenFileHandler(openFileHandler);
}
/**
* Installs the handler which is notified when the application is asked to
* print a list of files.
*
* @implNote Please note that for Mac OS, notifications
* are only sent if the Java app is a bundled application,
* with a {@code CFBundleDocumentTypes} array present in its
* Info.plist. See the
*
* Info.plist Key Reference for more information about adding a
* {@code CFBundleDocumentTypes} key to your app's Info.plist.
*
* @param printFileHandler handler
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_PRINT_FILE} action
* @since 1.9
*/
public void setPrintFileHandler(final PrintFilesHandler printFileHandler) {
checkActionSupport(Action.APP_PRINT_FILE);
peer.setPrintFileHandler(printFileHandler);
}
/**
* Installs the handler which is notified when the application is asked to
* open a URL.
*
* Setting the handler to null causes all
* {@link OpenURIHandler#openURI(AppEvent.OpenURIEvent)} requests to be
* enqueued until another handler is set.
*
* @implNote Please note that for Mac OS, notifications
* are only sent if the Java app is a bundled application,
* with a {@code CFBundleDocumentTypes} array present in its
* Info.plist. See the
*
* Info.plist Key Reference for more information about adding a
* {@code CFBundleDocumentTypes} key to your app's Info.plist.
*
* @param openURIHandler handler
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_OPEN_URI} action
* @since 1.9
*/
public void setOpenURIHandler(final OpenURIHandler openURIHandler) {
checkActionSupport(Action.APP_OPEN_URI);
peer.setOpenURIHandler(openURIHandler);
}
/**
* Installs the handler which determines if the application should quit. The
* handler is passed a one-shot {@link QuitResponse} which can cancel or
* proceed with the quit. Setting the handler to null causes
* all quit requests to directly perform the default {@link QuitStrategy}.
*
* @param quitHandler the handler that is called when the application is
* asked to quit
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_QUIT_HANDLER} action
* @since 1.9
*/
public void setQuitHandler(final QuitHandler quitHandler) {
checkActionSupport(Action.APP_QUIT_HANDLER);
peer.setQuitHandler(quitHandler);
}
/**
* Sets the default strategy used to quit this application. The default is
* calling SYSTEM_EXIT_0.
*
* @param strategy the way this application should be shutdown
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_QUIT_STRATEGY} action
* @see QuitStrategy
* @since 1.9
*/
public void setQuitStrategy(final QuitStrategy strategy) {
checkActionSupport(Action.APP_QUIT_STRATEGY);
peer.setQuitStrategy(strategy);
}
/**
* Enables this application to be suddenly terminated.
*
* Call this method to indicate your application's state is saved, and
* requires no notification to be terminated. Letting your application
* remain terminatable improves the user experience by avoiding re-paging in
* your application when it's asked to quit.
*
* Note: enabling sudden termination will allow your application to be
* quit without notifying your QuitHandler, or running any shutdown
* hooks.
* E.g. user-initiated Cmd-Q, logout, restart, or shutdown requests will
* effectively "kill -KILL" your application.
*
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_SUDDEN_TERMINATION} action
* @see #disableSuddenTermination()
* @since 1.9
*/
public void enableSuddenTermination() {
checkActionSupport(Action.APP_SUDDEN_TERMINATION);
peer.enableSuddenTermination();
}
/**
* Prevents this application from being suddenly terminated.
*
* Call this method to indicate that your application has unsaved state, and
* may not be terminated without notification.
*
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_SUDDEN_TERMINATION} action
* @see #enableSuddenTermination()
* @since 1.9
*/
public void disableSuddenTermination() {
checkActionSupport(Action.APP_SUDDEN_TERMINATION);
peer.disableSuddenTermination();
}
/**
* Requests this application to move to the foreground.
*
* @param allWindows if all windows of this application should be moved to
* the foreground, or only the foremost one
* @throws SecurityException if a security manager exists and it denies the
* AWTPermission("showWindowWithoutWarningBanner") permission.
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_REQUEST_FOREGROUND} action
* @since 1.9
*/
public void requestForeground(final boolean allWindows) {
checkAWTPermission();
checkActionSupport(Action.APP_REQUEST_FOREGROUND);
peer.requestForeground(allWindows);
}
/**
* Opens the native help viewer application.
*
* @throws SecurityException if a security manager exists and it denies the
* AWTPermission("showWindowWithoutWarningBanner") permission.
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_HELP_VIEWER} action
* @since 1.9
*/
public void openHelpViewer() {
checkAWTPermission();
checkActionSupport(Action.APP_HELP_VIEWER);
peer.openHelpViewer();
}
/**
* Sets the default menu bar to use when there are no active frames.
*
* @implNote Aqua Look and Feel should be active to support this on Mac OS.
*
* @param menuBar to use when no other frames are active
* @throws SecurityException if a security manager exists and it denies the
* AWTPermission("showWindowWithoutWarningBanner") permission.
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#APP_MENU_BAR} action
* @since 1.9
*/
public void setDefaultMenuBar(final JMenuBar menuBar) {
checkAWTPermission();
checkActionSupport(Action.APP_MENU_BAR);
peer.setDefaultMenuBar(menuBar);
}
/**
* Opens a folder containing the {@code file} and selects it
* in a default system file manager.
* @param file the file
* @throws SecurityException If a security manager exists and its
* {@link SecurityManager#checkRead(java.lang.String)} method
* denies read access to the file
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#BROWSE_FILE_DIR} action
* @throws NullPointerException if {@code file} is {@code null}
* @throws IllegalArgumentException if the specified file doesn't
* exist
* @since 1.9
*/
public void browseFileDirectory(File file) {
checkRead();
checkActionSupport(Action.BROWSE_FILE_DIR);
checkFileValidation(file);
peer.browseFileDirectory(file);
}
/**
* Moves the specified file to the trash.
*
* @param file the file
* @return returns true if successfully moved the file to the trash.
* @throws SecurityException If a security manager exists and its
* {@link SecurityManager#checkWrite(java.lang.String)} method
* denies write access to the file
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#MOVE_TO_TRASH} action
* @throws NullPointerException if {@code file} is {@code null}
* @throws IllegalArgumentException if the specified file doesn't
* exist
*
* @since 1.9
*/
public boolean moveToTrash(final File file) {
checkWrite();
checkActionSupport(Action.MOVE_TO_TRASH);
checkFileValidation(file);
return peer.moveToTrash(file);
}
}