json/src/main/java/org/netbeans/html/json/spi/PropertyBinding.java
author Jaroslav Tulach <jtulach@netbeans.org>
Tue, 26 Aug 2014 18:13:30 +0200
changeset 838 bdc3d696dd4a
parent 790 json/src/main/java/org/apidesign/html/json/spi/PropertyBinding.java@30f20d9c0986
child 870 77bff7390451
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.json.spi;
    44 
    45 import net.java.html.BrwsrCtx;
    46 import org.netbeans.html.json.impl.Bindings;
    47 import org.netbeans.html.json.impl.JSON;
    48 import org.netbeans.html.json.impl.PropertyBindingAccessor;
    49 import org.netbeans.html.json.impl.RcvrJSON;
    50 
    51 /** Describes a property when one is asked to 
    52  * bind it 
    53  *
    54  * @author Jaroslav Tulach
    55  */
    56 public abstract class PropertyBinding {
    57     PropertyBinding() {
    58     }
    59 
    60     static {
    61         new PropertyBindingAccessor() {
    62             @Override
    63             protected JSONCall newCall(BrwsrCtx ctx, RcvrJSON callback, String urlBefore, String urlAfter, String method, Object data) {
    64                 return new JSONCall(ctx, callback, urlBefore, urlAfter, method, data);
    65             }
    66 
    67             @Override
    68             protected Bindings bindings(Proto proto, boolean initialize) {
    69                 return initialize ? proto.initBindings() : proto.getBindings();
    70             }
    71 
    72             @Override
    73             protected void notifyChange(Proto proto, int propIndex) {
    74                 proto.onChange(propIndex);
    75             }
    76 
    77             @Override
    78             protected Proto findProto(Proto.Type<?> type, Object object) {
    79                 return type.protoFor(object);
    80             }
    81 
    82             @Override
    83             protected <Model> Model cloneTo(Proto.Type<Model> type, Model model, BrwsrCtx c) {
    84                 return type.cloneTo(model, c);
    85             }
    86 
    87             @Override
    88             protected Object read(Proto.Type<?> from, BrwsrCtx c, Object data) {
    89                 return from.read(c, data);
    90             }
    91 
    92             @Override
    93             protected <M> PropertyBinding newBinding(
    94                 Proto.Type<M> access, Bindings<?> bindings, String name,
    95                 int index, M model, boolean readOnly
    96             ) {
    97                 return new Impl(bindings, name, index, model, access, readOnly);
    98             }
    99         };
   100     }
   101 
   102     /** Name of the property this binding represents.
   103      * @return name of the property
   104      */
   105     public abstract String getPropertyName();
   106 
   107     /** Changes value of the property. Can be called only on dedicated
   108      * thread. See {@link Technology#runSafe(java.lang.Runnable)}.
   109      * 
   110      * @param v new value of the property
   111      */
   112     public abstract void setValue(Object v);
   113     
   114     /** Obtains current value of the property this binding represents.
   115      * Can be called only on dedicated
   116      * thread. See {@link Technology#runSafe(java.lang.Runnable)}.
   117      * 
   118      * @return the value or <code>null</code>
   119      */
   120     public abstract Object getValue();
   121     
   122     /** Is this property read only? Or can one call {@link #setValue(java.lang.Object)}?
   123      * 
   124      * @return true, if this property is read only
   125      */
   126     public abstract boolean isReadOnly();
   127     
   128     private static final class Impl<M> extends PropertyBinding {
   129         public final String name;
   130         public final boolean readOnly;
   131         private final M model;
   132         private final Proto.Type<M> access;
   133         private final Bindings<?> bindings;
   134         private final int index;
   135 
   136         public Impl(Bindings<?> bindings, String name, int index, M model, Proto.Type<M> access, boolean readOnly) {
   137             this.bindings = bindings;
   138             this.name = name;
   139             this.index = index;
   140             this.model = model;
   141             this.access = access;
   142             this.readOnly = readOnly;
   143         }
   144 
   145         @Override
   146         public void setValue(Object v) {
   147             access.setValue(model, index, v);
   148         }
   149 
   150         @Override
   151         public Object getValue() {
   152             Object v = access.getValue(model, index);
   153             Object r = JSON.find(v, bindings);
   154             return r == null ? v : r;
   155         }
   156 
   157         @Override
   158         public boolean isReadOnly() {
   159             return readOnly;
   160         }
   161 
   162         @Override
   163         public String getPropertyName() {
   164             return name;
   165         }
   166     } // end of PBData
   167     
   168 }