java.lang.Object
- java.awt.Desktop

public class Desktop extends java.lang.Object
The Desktop class allows a Java application to launch associated applications registered on the native desktop to handle a URI or a file.
Supported operations include:
- launching the user-default browser to show a specified URI;
- launching the user-default mail client with an optional mailto URI;
- launching a registered application to open, edit or print a specified file.
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.
An application is registered to a URI or file type; for example, the "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 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.
Since:

1.6

Nested Classes
	Modifier and Type	Class and Description
	Action	`static class` Action Represents an action type. `static class` Action Represents an action type. Each platform supports a different set of actions. You may use the `isSupported(java.awt.Desktop.Action)` method to determine if the given action is supported by the current platform. Since: 1.6 See Also: `isSupported(java.awt.Desktop.Action)`

Static Methods
	Modifier and Type	Static Method and Description
	getDesktop	`static Desktop` getDesktop() Returns the `Desktop` instance of the current browser context. public static Desktop getDesktop() Returns the `Desktop` instance of the current browser context. On some platforms the Desktop API may not be supported; use the `isDesktopSupported()` method to determine if the current desktop is supported. Returns: the Desktop instance of the current browser context Throws: `HeadlessException` - if `GraphicsEnvironment.isHeadless()` returns `true` `java.lang.UnsupportedOperationException` - if this class is not supported on the current platform See Also: `isDesktopSupported()`, `GraphicsEnvironment.isHeadless()`
	isDesktopSupported	`static boolean` isDesktopSupported() Tests whether this class is supported on the current platform. public static boolean isDesktopSupported() Tests whether this class is supported on the current platform. If it's supported, use `getDesktop()` to retrieve an instance. Returns: `true` if this class is supported on the current platform; `false` otherwise See Also: `getDesktop()`

Methods
	Modifier and Type	Method and Description
	browse	`void` browse(java.net.URI uri) Launches the default browser to display a `URI`. public void browse(java.net.URI uri) throws java.io.IOException Launches the default browser to display a `URI`. If the default browser is not able to handle the specified `URI`, the application registered for handling `URIs` of the specified type is invoked. The application is determined from the protocol and path of the `URI`, as defined by the `URI` class. If the calling thread does not have the necessary permissions, and this is invoked from within an applet, `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, `BasicService.showDocument()` is used. Parameters: `uri` - the URI to be displayed in the user default browser Throws: `java.lang.NullPointerException` - if `uri` is `null` `java.lang.UnsupportedOperationException` - if the current platform does not support the `Desktop.Action.BROWSE` action `java.io.IOException` - if the user default browser is not found, or it fails to be launched, or the default handler application failed to be launched `java.lang.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 `java.lang.IllegalArgumentException` - if the necessary permissions are not available and the URI can not be converted to a `URL` See Also: `URI`, `AWTPermission`, `AppletContext`
	edit	`void` edit(java.io.File file) Launches the associated editor application and opens a file for editing. public void edit(java.io.File file) throws java.io.IOException Launches the associated editor application and opens a file for editing. Parameters: `file` - the file to be opened for editing Throws: `java.lang.NullPointerException` - if the specified file is `null` `java.lang.IllegalArgumentException` - if the specified file doesn't exist `java.lang.UnsupportedOperationException` - if the current platform does not support the `Desktop.Action.EDIT` action `java.io.IOException` - if the specified file has no associated editor, or the associated application fails to be launched `java.lang.SecurityException` - if a security manager exists and its `SecurityManager.checkRead(java.lang.String)` method denies read access to the file, or `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 Also: `AWTPermission`
	isSupported	`boolean` isSupported(Desktop.Action action) Tests whether an action is supported on the current platform. public boolean isSupported(Desktop.Action action) 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 `Desktop.Action.OPEN` action. But for a specific file, there may not be an application registered to open it. In this case, `isSupported(java.awt.Desktop.Action)` may return `true`, but the corresponding action method will throw an `IOException`. Parameters: `action` - the specified `Desktop.Action` Returns: `true` if the specified action is supported on the current platform; `false` otherwise See Also: `Desktop.Action`
	mail	`void` mail() Launches the mail composing window of the user default mail client. public void mail() throws java.io.IOException Launches the mail composing window of the user default mail client. Throws: `java.lang.UnsupportedOperationException` - if the current platform does not support the `Desktop.Action.MAIL` action `java.io.IOException` - if the user default mail client is not found, or it fails to be launched `java.lang.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 Also: `AWTPermission`
	mail	`void` mail(java.net.URI mailtoURI) Launches the mail composing window of the user default mail client, filling the message fields specified by a `mailto:` URI. public void mail(java.net.URI mailtoURI) throws java.io.IOException Launches the mail composing window of the user default mail client, filling the message fields specified by a `mailto:` URI. A `mailto:` URI can specify message fields including "to", "cc", "subject", "body", etc. See The mailto URL scheme (RFC 2368) for the `mailto:` URI specification details. Parameters: `mailtoURI` - the specified `mailto:` URI Throws: `java.lang.NullPointerException` - if the specified URI is `null` `java.lang.IllegalArgumentException` - if the URI scheme is not `"mailto"` `java.lang.UnsupportedOperationException` - if the current platform does not support the `Desktop.Action.MAIL` action `java.io.IOException` - if the user default mail client is not found or fails to be launched `java.lang.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 Also: `URI`, `AWTPermission`
	open	`void` open(java.io.File file) Launches the associated application to open the file. public void open(java.io.File file) throws java.io.IOException 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. Parameters: `file` - the file to be opened with the associated application Throws: `java.lang.NullPointerException` - if `file` is `null` `java.lang.IllegalArgumentException` - if the specified file doesn't exist `java.lang.UnsupportedOperationException` - if the current platform does not support the `Desktop.Action.OPEN` action `java.io.IOException` - if the specified file has no associated application or the associated application fails to be launched `java.lang.SecurityException` - if a security manager exists and its `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 Also: `AWTPermission`
	print	`void` print(java.io.File file) Prints a file with the native desktop printing facility, using the associated application's print command. public void print(java.io.File file) throws java.io.IOException Prints a file with the native desktop printing facility, using the associated application's print command. Parameters: `file` - the file to be printed Throws: `java.lang.NullPointerException` - if the specified file is `null` `java.lang.IllegalArgumentException` - if the specified file doesn't exist `java.lang.UnsupportedOperationException` - if the current platform does not support the `Desktop.Action.PRINT` action `java.io.IOException` - if the specified file has no associated application that can be used to print it `java.lang.SecurityException` - if a security manager exists and its `SecurityManager.checkRead(java.lang.String)` method denies read access to the file, or its `SecurityManager.checkPrintJobAccess()` method denies the permission to print the file, or the calling thread is not allowed to create a subprocess

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

SourceForge

Class Desktop

Methods inherited from class java.lang.Object