| |
|
| java.lang.Object
 java.awt.Desktop
| Desktop | | public class Desktop (Code) | | The
Desktop class allows a Java application to launch
associated applications registered on the native desktop to handle
a
java.net.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
author:
Armin Chen
author:
George Zhang |
| Inner Class :public static enum Action | |
| Method Summary | |
| public void | browse(URI uri)
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. | | public void | edit(File file)
Launches the associated editor application and opens a file for
editing. | | public static synchronized Desktop | getDesktop()
Returns the Desktop instance of the current
browser context. | | public static boolean | isDesktopSupported()
Tests whether this class is supported on the current platform. | | public boolean | isSupported(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. | | public void | mail()
Launches the mail composing window of the user default mail
client. | | public void | mail(URI mailtoURI)
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. | | public void | open(File file)
Launches the associated application to open the file. | | public void | print(File file)
Prints a file with the native desktop printing facility, using
the associated application's print command. |
| browse | | public void browse(URI uri) throws IOException(Code) | | 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:
NullPointerException - if uri is null
throws:
UnsupportedOperationException - if the current platformdoes not support the Desktop.Action.BROWSE action
throws:
IOException - if the user default browser is not found,or it fails to be launched, or the default handler applicationfailed to be launched
throws:
SecurityException - if a security manager exists and itdenies theAWTPermission("showWindowWithoutWarningBanner")permission, or the calling thread is not allowed to create asubprocess; and not invoked from within an applet or Java Web Startedapplication
throws:
IllegalArgumentException - if the necessary permissionsare not available and the URI can not be converted to a URL
See Also: java.net.URI
See Also: java.awt.AWTPermission
See Also: java.applet.AppletContext |
| isDesktopSupported | | public static boolean isDesktopSupported()(Code) | | Tests whether this class is supported on the current platform.
If it's supported, use
Desktop.getDesktop() to retrieve an
instance.
true if this class is supported on thecurrent platform; false otherwise
See Also: Desktop.getDesktop() |
| isSupported | | public boolean isSupported(Action action)(Code) | | 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,
Desktop.isSupported may return
true , but the corresponding
action method will throw an
IOException .
Parameters:
action - the specified Action true if the specified action is supported onthe current platform; false otherwise
See Also: Desktop.Action |
|
|
|