APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.application

public final Class HostServices

extends Object
Class Inheritance
Imports
java.net.URI, com.sun.javafx.application.HostServicesDelegate
This class provides HostServices for an Application. This includes methods to get the code base and document base for an Application, and to show a web page in a browser.
Since
JavaFX 2.0

Field Summary

Modifier and TypeField and Description
private final HostServicesDelegate
delegate

Constructor Summary

AccessConstructor and Description
pack-priv
HostServices(Application
the application class
app)

Package scope constructor to create the HostServices object.

Method Summary

Modifier and TypeMethod and Description
public final String

Returns:

the code base URI for this application.
getCodeBase()

Gets the code base URI for this application.

public final String

Returns:

the document base URI for this application.
getDocumentBase()

Gets the document base URI for this application.

public final String

Returns:

the fully resolved URI.
resolveURI(String
the base URI against which to resolve the relative URI
base, String
the relative URI to be resolved
rel)

Resolves the specified relative URI against the base URI and returns the resolved URI.

public final void
showDocument(String
the URI of the web page that will be opened in a browser.
uri)

Opens the specified URI in a new browser window or tab.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

delegateback to summary
private final HostServicesDelegate delegate

Constructor Detail

HostServicesback to summary
pack-priv HostServices(Application app)

Package scope constructor to create the HostServices object.

Parameters
app:Application

the application class

Method Detail

getCodeBaseback to summary
public final String getCodeBase()

Gets the code base URI for this application. This method returns the directory containing the application jar file. If the application is not packaged in a jar file, this method returns the empty string.

Returns:String

the code base URI for this application.

getDocumentBaseback to summary
public final String getDocumentBase()

Gets the document base URI for this application. This method returns the URI of the current directory.

Returns:String

the document base URI for this application.

resolveURIback to summary
public final String resolveURI(String base, String rel)

Resolves the specified relative URI against the base URI and returns the resolved URI.

Example:

    HostServices services = getHostServices();
    String myImage = services.resolveURI(services.getDocumentBase(),
                                         "image.jpg");
    Image image = new Image(myImage);
Parameters
base:String

the base URI against which to resolve the relative URI

rel:String

the relative URI to be resolved

Returns:String

the fully resolved URI.

Exceptions
NullPointerException:
if either the base or the rel strings are null.
IllegalArgumentException:
if there is an error parsing either the base or rel URI strings, or if there is any other error in resolving the URI.
showDocumentback to summary
public final void showDocument(String uri)

Opens the specified URI in a new browser window or tab. The determination of whether it is a new browser window or a tab in an existing browser window will be made by the browser preferences. Note that this will respect the pop-up blocker settings of the default browser; it will not try to circumvent them.

Parameters
uri:String

the URI of the web page that will be opened in a browser.