ko4j/src/main/java/org/netbeans/html/ko4j/KO4J.java
author Jaroslav Tulach <jtulach@netbeans.org>
Tue, 26 Aug 2014 18:13:30 +0200
changeset 838 bdc3d696dd4a
parent 790 30f20d9c0986
child 886 88d62267a0b5
permissions -rw-r--r--
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.
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013-2014 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-2014 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.netbeans.html.boot.spi.Fn;
    47 import org.netbeans.html.context.spi.Contexts;
    48 import org.netbeans.html.context.spi.Contexts.Provider;
    49 import org.netbeans.html.json.spi.Technology;
    50 import org.netbeans.html.json.spi.Transfer;
    51 import org.netbeans.html.json.spi.WSTransfer;
    52 import org.openide.util.lookup.ServiceProvider;
    53 
    54 /** Support for <a href="http://knockoutjs.com">knockout.js</a>
    55  * and its Java binding via {@link Model model classes}.
    56  * Registers {@link Provider}, so {@link java.util.ServiceLoader} can find it.
    57  *
    58  * @author Jaroslav Tulach
    59  * @since 0.7
    60  */
    61 @ServiceProvider(service = Provider.class)
    62 public final class KO4J implements Provider {
    63     private final Fn.Presenter presenter;
    64     private FXContext c;
    65     
    66     public KO4J() {
    67         this(null);
    68     }
    69     
    70     public KO4J(Fn.Presenter presenter) {
    71         this.presenter = presenter;
    72     }
    73     
    74     private FXContext getKO() {
    75         if (c == null) {
    76             c = new FXContext(presenter == null ? Fn.activePresenter() : presenter);
    77         }
    78         return c;
    79     }
    80     
    81     /** Return instance of the knockout.js for Java technology.
    82      * @return non-null instance
    83      */
    84     public Technology knockout() {
    85         return getKO();
    86     }
    87     
    88     /** Browser based implementation of transfer interface. Uses
    89      * browser method to convert string to JSON.
    90      * 
    91      * @return non-null instance
    92      */
    93     public Transfer transfer() {
    94         return getKO();
    95     }
    96     
    97     /** Returns browser based implementation of websocket transfer.
    98      * If available (for example JavaFX WebView on JDK7 does not have
    99      * this implementation).
   100      * 
   101      * @return an instance or <code>null</code>, if there is no
   102      *   <code>WebSocket</code> object in the browser
   103      */
   104     public WSTransfer<?> websockets() {
   105         return getKO().areWebSocketsSupported() ? getKO() : null;
   106     }
   107 
   108     /** Registers technologies at position 100:
   109      * <ul>
   110      *   <li>{@link #knockout()}</li>
   111      *   <li>{@link #transfer()}</li>
   112      *   <li>{@link #websockets()()} - if browser supports web sockets</li>
   113      * </ul>
   114      * @param context the context to register to
   115      * @param requestor the class requesting the registration
   116      */
   117     @Override
   118     public void fillContext(Contexts.Builder context, Class<?> requestor) {
   119         context.register(Technology.class, knockout(), 100);
   120         context.register(Transfer.class, transfer(), 100);
   121         context.register(WSTransfer.class, websockets(), 100);
   122     }
   123     
   124 }