ko4j/src/main/java/org/netbeans/html/ko4j/KO4J.java
author Jaroslav Tulach <jaroslav.tulach@netbeans.org>
Thu, 09 Jan 2014 20:39:23 +0100
branchUniversalKO
changeset 446 6dce58c06f58
parent 444 03eeeb863fa1
child 533 d4f44b4b4602
permissions -rw-r--r--
ko4j registers implementation of Transfer and WSTransfer based on XHR and WebSocket from a browser. The Java implementations of these interfaces has been moved to ko-ws-tyrus module. JavaScript arrays passed as parameters to Java callback methods need to be wrapped.
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013-2013 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 org.netbeans.html.ko4j;
    44 
    45 import net.java.html.json.Model;
    46 import org.apidesign.html.boot.spi.Fn;
    47 import org.apidesign.html.context.spi.Contexts;
    48 import org.apidesign.html.json.spi.Technology;
    49 import org.apidesign.html.json.spi.Transfer;
    50 import org.apidesign.html.json.spi.WSTransfer;
    51 import org.openide.util.lookup.ServiceProvider;
    52 
    53 /** Support for <a href="http://knockoutjs.com">knockout.js</a>
    54  * and its Java binding via {@link Model model classes}.
    55  * Registers {@link ContextProvider}, so {@link ServiceLoader} can find it.
    56  *
    57  * @author Jaroslav Tulach <jtulach@netbeans.org>
    58  * @since 0.7
    59  */
    60 @ServiceProvider(service = Contexts.Provider.class)
    61 public final class KO4J implements Contexts.Provider {
    62     private final Fn.Presenter presenter;
    63     private FXContext c;
    64     
    65     public KO4J() {
    66         this(null);
    67     }
    68     
    69     public KO4J(Fn.Presenter presenter) {
    70         this.presenter = presenter;
    71     }
    72     
    73     private FXContext getKO() {
    74         if (c == null) {
    75             c = new FXContext(presenter == null ? Fn.activePresenter() : presenter);
    76         }
    77         return c;
    78     }
    79     
    80     /** Return instance of the knockout.js for Java technology.
    81      * @return non-null instance
    82      */
    83     public Technology knockout() {
    84         return getKO();
    85     }
    86     
    87     /** Browser based implementation of transfer interface. Uses
    88      * browser method to convert string to JSON.
    89      * 
    90      * @return non-null instance
    91      */
    92     public Transfer transfer() {
    93         return getKO();
    94     }
    95     
    96     /** Returns browser based implementation of websocket transfer.
    97      * If available (for example JavaFX WebView on JDK7 does not have
    98      * this implementation).
    99      * 
   100      * @return an instance or <code>null</code>, if there is no
   101      *   <code>WebSocket</code> object in the browser
   102      */
   103     public WSTransfer<?> websockets() {
   104         return getKO().areWebSocketsSupported() ? getKO() : null;
   105     }
   106 
   107     /** Registers technologies at position 100:
   108      * <ul>
   109      *   <li>{@link #knockout()}</li>
   110      *   <li>{@link #transfer()}</li>
   111      *   <li>{@link #websockets()()} - if browser supports web sockets</li>
   112      * </ul>
   113      * @param context the context to register to
   114      * @param requestor the class requesting the registration
   115      */
   116     @Override
   117     public void fillContext(Contexts.Builder context, Class<?> requestor) {
   118         if (FXContext.isJavaScriptEnabled()) {
   119             context.register(Technology.class, knockout(), 100);
   120             context.register(Transfer.class, transfer(), 100);
   121             if (c.areWebSocketsSupported()) {
   122                 context.register(WSTransfer.class, websockets(), 100);
   123             }
   124         }
   125     }
   126     
   127 }