hg/html~html4j: json/src/main/java/net/java/html/json/OnPropertyChange.java@4f906bde3a2e

     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 net.java.html.json;

    45 import java.lang.annotation.ElementType;

    46 import java.lang.annotation.Retention;

    47 import java.lang.annotation.RetentionPolicy;

    48 import java.lang.annotation.Target;

    50 /** Marks a method that is going to be notified when a

    51  * property defined by {@link Model} has been changed. This is

    52  * especially useful when one wants to react to changes in the

    53  * model caused by the rendered view. In case of

    54  * <a href="http://knockoutjs.com">knockout.js</a> technology

    55  * one could for example react to selection of a name from a combo

    56  * box:

    57  * <pre>

    58  *

    59  * &lt;!-- associates the selected value with property <em>name</em> --&gt;

    60  *

    61  * &lt;select data-bind="value: name"&gt;

    62  *   &lt;option&gt;Jiří&lt;/option&gt;

    63  *   &lt;option&gt;Jarda&lt;/option&gt;

    64  *   &lt;option&gt;Petr&lt;/option&gt;

    65  *   &lt;option&gt;Tomáš&lt;/option&gt;

    66  * &lt;/select&gt;

    67  *

    68  * // Java code snippet reacting to change of the <em>name</em> property:

    69  *

    70  * {@link OnPropertyChange @OnPropertyChange}("name")

    71  * <b>static void</b> propertyChanged(AModel inst, {@link String} propertyName) {

    72  *   // schedule some operation

    73  *   // on the model

    74  * }

    75  * </pre>

    76  * The method's first argument should be the instance of the

    77  * associated {@link Model model class}. The method shall be non-private

    78  * and unless {@link Model#instance() instance mode} is on also static.

    79  * There can be an optional second {@link String} argument which will be set

    80  * to the name of the changed property. The second argument is only useful when

    81  * a single method reacts to changes in multiple properties.

    82  * <p>

    83  * An online example using this technique is

    84  * <a target="_blank" href="http://dew.apidesign.org/dew/#7138581">available here</a> -

    85  * it observes selection in a combo box and in case it changes

    86  * the example sends a network

    87  * request and {@link net.java.html.json.OnReceive asynchronously updates}

    88  * list of code snippets.

    89  *

    90  * @author Jaroslav Tulach

    91  */

    92 @Retention(RetentionPolicy.SOURCE)

    93 @Target(ElementType.METHOD)

    94 public @interface OnPropertyChange {

    95     /** Name(s) of the properties. One wishes to observe.

    96      *

    97      * @return valid java identifier

    98      */

    99     String[] value();

   100 }

author	Jaroslav Tulach <jtulach@netbeans.org>
	Wed, 09 Dec 2015 21:39:13 +0100
changeset 1023	4f906bde3a2e
parent 655	7211ec5f3172
permissions	-rw-r--r--