javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/Knockout.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Mon, 18 Mar 2013 17:17:00 +0100
branchfx
changeset 851 c285a78302af
parent 532 b5150a06c5d1
child 852 671fc517fe17
permissions -rw-r--r--
Knockout bindings for primitive types supported in WebView
jaroslav@492
     1
/**
jaroslav@492
     2
 * Back 2 Browser Bytecode Translator
jaroslav@492
     3
 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
jaroslav@492
     4
 *
jaroslav@492
     5
 * This program is free software: you can redistribute it and/or modify
jaroslav@492
     6
 * it under the terms of the GNU General Public License as published by
jaroslav@492
     7
 * the Free Software Foundation, version 2 of the License.
jaroslav@492
     8
 *
jaroslav@492
     9
 * This program is distributed in the hope that it will be useful,
jaroslav@492
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
jaroslav@492
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
jaroslav@492
    12
 * GNU General Public License for more details.
jaroslav@492
    13
 *
jaroslav@492
    14
 * You should have received a copy of the GNU General Public License
jaroslav@492
    15
 * along with this program. Look for COPYING file in the top folder.
jaroslav@492
    16
 * If not, see http://opensource.org/licenses/GPL-2.0.
jaroslav@492
    17
 */
jaroslav@492
    18
package org.apidesign.bck2brwsr.htmlpage;
jaroslav@492
    19
jaroslav@851
    20
import java.io.BufferedReader;
jaroslav@851
    21
import java.io.IOException;
jaroslav@851
    22
import java.io.InputStreamReader;
jaroslav@530
    23
import java.lang.reflect.Method;
jaroslav@851
    24
import java.util.logging.Level;
jaroslav@851
    25
import java.util.logging.Logger;
jaroslav@851
    26
import javafx.scene.web.WebEngine;
jaroslav@851
    27
import netscape.javascript.JSObject;
jaroslav@492
    28
import org.apidesign.bck2brwsr.core.ExtraJavaScript;
jaroslav@492
    29
import org.apidesign.bck2brwsr.core.JavaScriptBody;
jaroslav@492
    30
jaroslav@492
    31
/** Provides binding between models and 
jaroslav@492
    32
 *
jaroslav@492
    33
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@492
    34
 */
jaroslav@505
    35
@ExtraJavaScript(resource = "/org/apidesign/bck2brwsr/htmlpage/knockout-2.2.1.js")
jaroslav@499
    36
public class Knockout {
jaroslav@851
    37
    private static final Logger LOG = Logger.getLogger(Knockout.class.getName());
jaroslav@499
    38
    /** used by tests */
jaroslav@499
    39
    static Knockout next;
jaroslav@499
    40
    
jaroslav@851
    41
    static {
jaroslav@851
    42
        BufferedReader r = new BufferedReader(new InputStreamReader(Knockout.class.getResourceAsStream("knockout-2.2.1.js")));
jaroslav@851
    43
        StringBuilder sb = new StringBuilder();
jaroslav@851
    44
        for (;;) {
jaroslav@851
    45
            try {
jaroslav@851
    46
                String l = r.readLine();
jaroslav@851
    47
                if (l == null) {
jaroslav@851
    48
                    break;
jaroslav@851
    49
                }
jaroslav@851
    50
                sb.append(l).append('\n');
jaroslav@851
    51
            } catch (IOException ex) {
jaroslav@851
    52
                throw new IllegalStateException(ex);
jaroslav@851
    53
            }
jaroslav@851
    54
        }
jaroslav@851
    55
        web().executeScript(sb.toString());
jaroslav@851
    56
        Object ko = web().executeScript("ko");
jaroslav@851
    57
        assert ko != null : "Knockout library successfully defined 'ko'";
jaroslav@851
    58
    }
jaroslav@851
    59
    
jaroslav@851
    60
    
jaroslav@851
    61
    private final Object bindings;
jaroslav@851
    62
    
jaroslav@851
    63
    Knockout(Object bindings) {
jaroslav@851
    64
        this.bindings = bindings;
jaroslav@492
    65
    }
jaroslav@492
    66
    
jaroslav@496
    67
    public static <M> Knockout applyBindings(
jaroslav@492
    68
        Class<M> modelClass, M model, String[] propsGettersAndSetters
jaroslav@492
    69
    ) {
jaroslav@851
    70
        Object bindings = next;
jaroslav@499
    71
        next = null;
jaroslav@499
    72
        if (bindings == null) {
jaroslav@851
    73
            bindings = web().executeScript("new Object()");
jaroslav@499
    74
        }
jaroslav@530
    75
        for (int i = 0; i < propsGettersAndSetters.length; i += 4) {
jaroslav@530
    76
            try {
jaroslav@530
    77
                Method getter = modelClass.getMethod(propsGettersAndSetters[i + 3]);
jaroslav@530
    78
                bind(bindings, model, propsGettersAndSetters[i],
jaroslav@530
    79
                    propsGettersAndSetters[i + 1],
jaroslav@530
    80
                    propsGettersAndSetters[i + 2],
jaroslav@530
    81
                    getter.getReturnType().isPrimitive()
jaroslav@530
    82
                );
jaroslav@530
    83
            } catch (NoSuchMethodException ex) {
jaroslav@532
    84
                throw new IllegalStateException(ex.getMessage());
jaroslav@530
    85
            }
jaroslav@492
    86
        }
jaroslav@492
    87
        applyBindings(bindings);
jaroslav@851
    88
        return new Knockout(bindings);
jaroslav@496
    89
    }
jaroslav@496
    90
jaroslav@496
    91
    @JavaScriptBody(args = { "prop" }, body =
jaroslav@496
    92
        "this[prop].valueHasMutated();"
jaroslav@496
    93
    )
jaroslav@496
    94
    public void valueHasMutated(String prop) {
jaroslav@851
    95
        LOG.log(Level.INFO, "property mutated: {0}", prop);
jaroslav@851
    96
        JSObject koProp = (JSObject) ((JSObject)bindings).getMember(prop);
jaroslav@851
    97
        koProp.call("valueHasMutated");
jaroslav@492
    98
    }
jaroslav@492
    99
    
jaroslav@530
   100
jaroslav@530
   101
    @JavaScriptBody(args = { "id", "ev" }, body = "ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));")
jaroslav@530
   102
    public static void triggerEvent(String id, String ev) {
jaroslav@530
   103
    }
jaroslav@530
   104
    
jaroslav@530
   105
    @JavaScriptBody(args = { "bindings", "model", "prop", "getter", "setter", "primitive" }, body =
jaroslav@492
   106
          "var bnd = {\n"
jaroslav@492
   107
        + "  read: function() {\n"
jaroslav@492
   108
        + "    var v = model[getter]();\n"
jaroslav@492
   109
        + "    return v;\n"
jaroslav@492
   110
        + "  },\n"
jaroslav@492
   111
        + "  owner: bindings\n"
jaroslav@492
   112
        + "};\n"
jaroslav@492
   113
        + "if (setter != null) {\n"
jaroslav@492
   114
        + "  bnd.write = function(val) {\n"
jaroslav@530
   115
        + "    model[setter](primitive ? new Number(val) : val);\n"
jaroslav@492
   116
        + "  };\n"
jaroslav@492
   117
        + "}\n"
jaroslav@492
   118
        + "bindings[prop] = ko.computed(bnd);"
jaroslav@492
   119
    )
jaroslav@492
   120
    private static void bind(
jaroslav@530
   121
        Object bindings, Object model, String prop, String getter, String setter, boolean primitive
jaroslav@492
   122
    ) {
jaroslav@851
   123
        WebEngine e = web();
jaroslav@851
   124
        JSObject bnd = (JSObject) e.executeScript("var x = {}; x.bnd = "
jaroslav@851
   125
        + "new Function('ko', 'bindings', 'model', 'prop', 'getter', 'setter', 'primitive', '"
jaroslav@851
   126
        + "var bnd = {"
jaroslav@851
   127
        + "  read: function() {"
jaroslav@851
   128
        + "    try {"
jaroslav@851
   129
        + "      return model[getter]();"
jaroslav@851
   130
        + "    } catch (e) {"
jaroslav@851
   131
        + "      alert(\"Cannot call \" + getter + \" on \" + model + \" error: \" + e);"
jaroslav@851
   132
        + "    }"
jaroslav@851
   133
        + "  },"
jaroslav@851
   134
        + "  owner: bindings"
jaroslav@851
   135
        + "};"
jaroslav@851
   136
        + "if (setter != null) {"
jaroslav@851
   137
        + "  bnd.write = function(val) {"
jaroslav@851
   138
        + "    model[setter](primitive ? new Number(val) : val);"
jaroslav@851
   139
        + "  };"
jaroslav@851
   140
        + "};"
jaroslav@851
   141
        + "bindings[prop] = ko.computed(bnd);'"
jaroslav@851
   142
        + "); x;");
jaroslav@851
   143
        
jaroslav@851
   144
        Object ko = e.executeScript("ko");
jaroslav@851
   145
        bnd.call("bnd", ko, bindings, model, prop, strip(getter), strip(setter), primitive);
jaroslav@851
   146
        LOG.log(Level.INFO, "binding defined for {0}: {1}", new Object[]{prop, ((JSObject)bindings).getMember(prop)});
jaroslav@851
   147
    }
jaroslav@851
   148
    
jaroslav@851
   149
    private static String strip(String mangled) {
jaroslav@851
   150
        if (mangled == null) {
jaroslav@851
   151
            return null;
jaroslav@851
   152
        }
jaroslav@851
   153
        int under = mangled.indexOf("__");
jaroslav@851
   154
        return mangled.substring(0, under);
jaroslav@492
   155
    }
jaroslav@492
   156
    
jaroslav@492
   157
    @JavaScriptBody(args = { "bindings" }, body = "ko.applyBindings(bindings);")
jaroslav@851
   158
    private static void applyBindings(Object bindings) {
jaroslav@851
   159
        JSObject ko = (JSObject) web().executeScript("ko");
jaroslav@851
   160
        ko.call("applyBindings", bindings);
jaroslav@851
   161
    }
jaroslav@851
   162
    
jaroslav@851
   163
    private static WebEngine web() {
jaroslav@851
   164
        return (WebEngine) System.getProperties().get("webEngine");
jaroslav@851
   165
    }
jaroslav@851
   166
    
jaroslav@492
   167
}