boot-fx/src/main/java/net/java/html/boot/fx/FXBrowsers.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Mon, 16 Dec 2013 16:59:43 +0100
branchnetbeans
changeset 362 92fb71afdc0e
parent 358 80702021b851
child 365 5c93ad8c7a15
permissions -rw-r--r--
Moving implementation classes into org.netbeans.html namespace
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
     5  *
     6  * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
     7  * Other names may be trademarks of their respective owners.
     8  *
     9  * The contents of this file are subject to the terms of either the GNU
    10  * General Public License Version 2 only ("GPL") or the Common
    11  * Development and Distribution License("CDDL") (collectively, the
    12  * "License"). You may not use this file except in compliance with the
    13  * License. You can obtain a copy of the License at
    14  * http://www.netbeans.org/cddl-gplv2.html
    15  * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
    16  * specific language governing permissions and limitations under the
    17  * License.  When distributing the software, include this License Header
    18  * Notice in each file and include the License file at
    19  * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
    20  * particular file as subject to the "Classpath" exception as provided
    21  * by Oracle in the GPL Version 2 section of the License file that
    22  * accompanied this code. If applicable, add the following below the
    23  * License Header, with the fields enclosed by brackets [] replaced by
    24  * your own identifying information:
    25  * "Portions Copyrighted [year] [name of copyright owner]"
    26  *
    27  * Contributor(s):
    28  *
    29  * The Original Software is NetBeans. The Initial Developer of the Original
    30  * Software is Oracle. Portions Copyright 2013-2013 Oracle. All Rights Reserved.
    31  *
    32  * If you wish your version of this file to be governed by only the CDDL
    33  * or only the GPL Version 2, indicate your decision by adding
    34  * "[Contributor] elects to include this software in this distribution
    35  * under the [CDDL or GPL Version 2] license." If you do not indicate a
    36  * single choice of license, a recipient has the option to distribute
    37  * your version of this file under either the CDDL, the GPL Version 2 or
    38  * to extend the choice of license to its licensees as provided above.
    39  * However, if you add GPL Version 2 code and therefore, elected the GPL
    40  * Version 2 license, then the option applies only if the new code is
    41  * made subject to such option by the copyright holder.
    42  */
    43 package net.java.html.boot.fx;
    44 
    45 import java.net.URL;
    46 import javafx.beans.value.ChangeListener;
    47 import javafx.beans.value.ObservableValue;
    48 import javafx.concurrent.Worker;
    49 import javafx.scene.web.WebView;
    50 import net.java.html.boot.BrowserBuilder;
    51 import net.java.html.js.JavaScriptBody;
    52 import org.netbeans.html.boot.fx.AbstractFXPresenter;
    53 
    54 /** Utility methods for working with <em>JavaFX</em> <code>WebView</code>s.
    55  *
    56  * @author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
    57  * @since 0.6
    58  */
    59 public final class FXBrowsers {
    60     private FXBrowsers() {
    61     }
    62     
    63     /** Enables the Java/JavaScript brige (that supports {@link JavaScriptBody} and co.)
    64      * in the provided <code>webView</code>. This method returns 
    65      * immediately. Once the support is active, it calls back specified
    66      * method in <code>onPageLoad</code> class - the class can possibly be
    67      * loaded by a different classloader (to enable replacement of
    68      * methods with {@link JavaScriptBody} annotations with executable
    69      * versions). The method <code>methodName</code> needs to be <code>public</code>
    70      * (in a public class), <code>static</code> and take either no parameters
    71      * or an array of {@link String}s.
    72      * 
    73      * @param webView the instance of Web View to tweak
    74      * @param url the URL of the HTML page to load into the view
    75      * @param onPageLoad callback class with method <code>methodName</code>
    76      * @param methodName the method to call when the page is loaded
    77      * @param args arguments to pass to the <code>methodName</code> method
    78      */
    79     public static void load(
    80         final WebView webView, final URL url, 
    81         Class<?> onPageLoad, String methodName,
    82         String... args
    83     ) {
    84         class Load extends AbstractFXPresenter {
    85             @Override
    86             protected void waitFinished() {
    87                 // don't wait
    88             }
    89 
    90             @Override
    91             protected WebView findView(URL resource) {
    92                 final Worker<Void> w = webView.getEngine().getLoadWorker();
    93                 w.stateProperty().addListener(new ChangeListener<Worker.State>() {
    94                     @Override
    95                     public void changed(ObservableValue<? extends Worker.State> ov, Worker.State t, Worker.State newState) {
    96                         if (newState.equals(Worker.State.SUCCEEDED)) {
    97                             onPageLoad();
    98                         }
    99                         if (newState.equals(Worker.State.FAILED)) {
   100                             throw new IllegalStateException("Failed to load " + url);
   101                         }
   102                     }
   103                 });
   104                 
   105                 return webView;
   106             }
   107         }
   108         BrowserBuilder.newBrowser(new Load()).
   109             loadPage(url.toExternalForm()).
   110             loadClass(onPageLoad).
   111             invoke(methodName, args).
   112             showAndWait();
   113     }
   114 }