org.jboss.forge.addon.ui

Interface UIDesktop

All Known Implementing Classes:

DefaultUIDesktop

public interface UIDesktop

Interacts with the desktop bound to the UIProvider

Author:

George Gastaldi

Method Summary

Methods

Modifier and Type	Method and Description
void	browse(URI uri) Launches the default browser to display a URI.
void	edit(File file) Launches the associated editor application and opens a file for editing.
void	mail() Launches the mail composing window of the user default mail client.
void	mail(URI mailtoURI) Launches the mail composing window of the user default mail client, filling the message fields specified by a mailto: URI.
void	open(File file) Launches the associated application to open the file.
void	print(File file) Prints a file with the native desktop printing facility, using the associated application's print command.

Method Detail

open

void open(File file)
          throws 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:

IOException - if the specified file has no associated application or the associated application fails to be launched

edit

void edit(File file)
          throws IOException

Launches the associated editor application and opens a file for editing.

Parameters:

file - the file to be opened for editing

Throws:

IOException - if the specified file has no associated editor, or the associated application fails to be launched

print

void print(File file)
           throws 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:

IOException - if the specified file has no associated application that can be used to print it

browse

void browse(URI uri)
            throws 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.

Parameters:

uri - the URI to be displayed in the user default browser

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

See Also:

URI, AWTPermission, AppletContext

mail

void mail()
          throws IOException

Launches the mail composing window of the user default mail client.

Throws:

IOException - if the user default mail client is not found, or it fails to be launched

mail

void mail(URI mailtoURI)
          throws 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:

IOException - if the user default mail client is not found or fails to be launched