During the API review process (bug 246133) the reviewers decided that in order to include html4j to NetBeans Platform, we need to stop using org.apidesign namespace and switch to NetBeans one. Repackaging all SPI packages into org.netbeans.html.smthng.spi.
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
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]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
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.
43 package net.java.html.boot.script;
45 import java.io.Closeable;
46 import java.util.concurrent.Executor;
47 import javax.script.ScriptEngine;
48 import net.java.html.boot.BrowserBuilder;
49 import net.java.html.js.JavaScriptBody;
50 import org.netbeans.html.boot.spi.Fn;
51 import org.netbeans.html.boot.spi.Fn.Presenter;
53 /** Implementations of {@link Presenter}s that delegate
54 * to Java {@link ScriptEngine scripting} API. Initialize your presenter
59 * {@link Runnable} <em>run</em> = ...; // your own init code
60 * {@link Presenter Fn.Presenter} <b>p</b> = Scripts.{@link Scripts#createPresenter()};
61 * BrowserBuilder.{@link BrowserBuilder#newBrowser(java.lang.Object...) newBrowser(<b>p</b>)}.
62 * {@link BrowserBuilder#loadFinished(java.lang.Runnable) loadFinished(run)}.
63 * {@link BrowserBuilder#showAndWait()};
66 * and your runnable can make extensive use of {@link JavaScriptBody} directly or
67 * indirectly via APIs using {@link JavaScriptBody such annotation} themselves.
69 * Alternatively one can manipulate the presenter manually, which is
70 * especially useful when writing tests:
72 * {@code @Test} public void runInASimulatedBrowser() throws Exception {
73 * {@link Presenter Fn.Presenter} <b>p</b> = Scripts.{@link Scripts#createPresenter()};
74 * try ({@link Closeable} c = {@link Fn#activate(org.netbeans.html.boot.spi.Fn.Presenter) Fn.activate}(<b>p</b>)) {
75 * // your code operating in context of <b>p</b>
79 * The previous code snippet requires Java 7 language syntax, as it relies
80 * on try-with-resources language syntactic sugar feature. The same block
81 * of code can be used on older versions of Java, but it is slightly more
84 * @author Jaroslav Tulach
86 public final class Scripts {
90 /** Simple implementation of {@link Presenter} that delegates
91 * to Java {@link ScriptEngine scripting} API. The presenter runs headless
92 * without appropriate simulation of browser APIs. Its primary usefulness
93 * is inside testing environments. The presenter implements {@link Executor}
94 * interface, but invokes all runnables passed to {@link Executor#execute(java.lang.Runnable)}
97 * @return new instance of a presenter that is using its own
98 * {@link ScriptEngine} for <code>text/javascript</code> mimetype
100 public static Presenter createPresenter() {
101 return new ScriptPresenter(null);
104 /** Implementation of {@link Presenter} that delegates
105 * to Java {@link ScriptEngine scripting} API and can control execution
106 * thread. The presenter runs headless
107 * without appropriate simulation of browser APIs. Its primary usefulness
108 * is inside testing environments. The presenter implements {@link Executor}
109 * interface, and passes all runnables from {@link Executor#execute(java.lang.Runnable)}
110 * to here in provided <code>exc</code> instance.
112 * @param exc the executor to re-schedule all asynchronous requests to
113 * @return new instance of a presenter that is using its own
114 * {@link ScriptEngine} for <code>text/javascript</code> mimetype
116 public static Presenter createPresenter(Executor exc) {
117 return new ScriptPresenter(exc);