public interface

DesktopPeer

java.awt.peer.DesktopPeer

Class Overview

The DesktopPeer interface provides methods for the operation of open, edit, print, browse and mail with the given URL or file, by launching the associated application.

Each platform has an implementation class for this interface.

Summary

Public Methods
abstract void browse(URI url)
Launches the user default browser to display the given URI.
abstract void edit(File file)
Launches the associated editor and opens the given file for editing.
abstract boolean isSupported(Desktop.Action action)
Returns whether the given action is supported on the current platform.
abstract void mail(URI mailtoURL)
Launches the mail composing window of the user default mail client, filling the message fields including to, cc, etc, with the values specified by the given mailto URL.
abstract void open(File file)
Launches the associated application to open the given file.
abstract void print(File file)
Prints the given file with the native desktop printing facility, using the associated application's print command.

Public Methods

public abstract void browse (URI url)

Launches the user default browser to display the given URI.

Throws
IOException If the user default browser is not found, or it fails to be launched.

public abstract void edit (File file)

Launches the associated editor and opens the given file for editing. The associated editor is registered to be the default editor for the file type of the given file.

Parameters
file the given file.
Throws
IOException If the given file has no associated editor, or the associated application fails to be launched.

public abstract boolean isSupported (Desktop.Action action)

Returns whether the given action is supported on the current platform.

Parameters
action the action type to be tested if it's supported on the current platform.
Returns
  • true if the given action is supported on the current platform; false otherwise.

public abstract void mail (URI mailtoURL)

Launches the mail composing window of the user default mail client, filling the message fields including to, cc, etc, with the values specified by the given mailto URL.

Throws
IOException If the user default mail client is not found, or it fails to be launched.

public abstract void open (File file)

Launches the associated application to open the given file. The associated application is registered to be the default file viewer for the file type of the given file.

Parameters
file the given file.
Throws
IOException If the given file has no associated application, or the associated application fails to be launched.

public abstract void print (File file)

Prints the given file with the native desktop printing facility, using the associated application's print command.

Parameters
file the given file.
Throws
IOException If the given file has no associated application that can be used to print it.