declare namespace java { namespace awt { /** * The {@code Desktop} class allows a Java application to launch * associated applications registered on the native desktop to handle * a {@link java.net.URI} or a file. *
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. *
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.
* @since 1.6
* @author Armin Chen
* @author George Zhang
*/
// @ts-ignore
class Desktop extends java.lang.Object {
/**
* Returns the Desktop
instance of the current
* browser 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 of the current browser context
* @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
*/
// @ts-ignore
public static getDesktop(): java.awt.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()
*/
// @ts-ignore
public static isDesktopSupported(): boolean
/**
* 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
*/
// @ts-ignore
public isSupported(action: java.awt.Desktop.Action): boolean
/**
* 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
*/
// @ts-ignore
public open(file: java.io.File): void
/**
* 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
*/
// @ts-ignore
public edit(file: java.io.File): void
/**
* 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
*/
// @ts-ignore
public print(file: java.io.File): void
/**
* 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
*/
// @ts-ignore
public browse(uri: java.net.URI): void
/**
* 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
*/
// @ts-ignore
public mail(): void
/**
* Launches the mail composing window of the user default mail
* client, filling the message fields specified by a {@code
* mailto:} URI.
*
A 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
*/
// @ts-ignore
public mail(mailtoURI: java.net.URI): void
}
}
}