/*
* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package javafx.application;
import java.net.
URI;
import netscape.javascript.
JSObject;
import 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,
* show a web page in a browser, and communicate with the enclosing web page
* using JavaScript if the Application is running in
* a browser.
* @since JavaFX 2.0
*/
public final class
HostServices {
private final
HostServicesDelegate delegate;
/**
* Package scope constructor to create the HostServices object.
*
* @param app the application class
*/
HostServices(
Application app) {
delegate =
HostServicesDelegate.
getInstance(
app);
}
/**
* Gets the code base URI for this application.
* If the application was launched via a JNLP file, this method returns
* the codebase parameter specified in the JNLP file.
* If the application was launched in standalone mode, 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.
*
* @return the code base URI for this application.
*/
public final
String getCodeBase() {
return
delegate.
getCodeBase();
}
/**
* Gets the document base URI for this application.
* If the application is embedded in a browser, this method returns the
* URI of the web page containing the application.
* If the application was launched in webstart mode, this method returns
* the the codebase parameter specified in the JNLP file (the document
* base and the code base are the same in this mode).
* If the application was launched in standalone mode, this method returns
* the URI of the current directory.
*
* @return the document base URI for this application.
*/
public final
String getDocumentBase() {
return
delegate.
getDocumentBase();
}
/**
* Resolves the specified relative URI against the base URI and returns
* the resolved URI.
*
* <p>Example:</p>
* <ul>
* <pre>
* HostServices services = getHostServices();
* String myImage = services.resolveURI(services.getDocumentBase(),
* "image.jpg");
* Image image = new Image(myImage);
* </pre>
* </ul>
*
* @param base the base URI against which to resolve the relative URI
*
* @param rel the relative URI to be resolved
*
* @throws NullPointerException if either the <code>base</code> or the
* <code>rel</code> strings are null.
* @throws IllegalArgumentException if there is an error parsing either
* the <code>base</code> or <code>rel</code> URI strings, or if there is
* any other error in resolving the URI.
*
* @return the fully resolved URI.
*/
public final
String resolveURI(
String base,
String rel) {
URI uri =
URI.
create(
base).
resolve(
rel);
return
uri.
toString();
}
/**
* 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.
*
* @param uri the URI of the web page that will be opened in a browser.
*/
public final void
showDocument(
String uri) {
delegate.
showDocument(
uri);
}
/**
* Returns the JavaScript handle of the enclosing DOM window of the web
* page containing this application.
* This handle is used to access the web page by calling from Java into
* JavaScript.
* If the application is not embedded into a web page, this method
* return null.
*
* <p>Example:</p>
* <ul>
* <pre>
* JSObject jsWin = getHostServices().getWebContext();
* if (jsWin != null) {
* jsWin.eval("var b = document.body;" +
* "var newdiv = document.createElement('div');" +
* "newdiv.innerHTML = '<br>Hello from JavaScript!';" +
* "b.appendChild(newdiv);");
* }
* </pre>
* </ul>
*
* @return handle of the enclosing DOM window of the web page containing
* this application
*/
public final
JSObject getWebContext() {
return
delegate.
getWebContext();
}
}