jtulach@0
|
1 |
/**
|
jaroslav@358
|
2 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
jtulach@0
|
3 |
*
|
jaroslav@551
|
4 |
* Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
|
jtulach@0
|
5 |
*
|
jaroslav@358
|
6 |
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
|
jaroslav@358
|
7 |
* Other names may be trademarks of their respective owners.
|
jtulach@0
|
8 |
*
|
jaroslav@358
|
9 |
* The contents of this file are subject to the terms of either the GNU
|
jaroslav@358
|
10 |
* General Public License Version 2 only ("GPL") or the Common
|
jaroslav@358
|
11 |
* Development and Distribution License("CDDL") (collectively, the
|
jaroslav@358
|
12 |
* "License"). You may not use this file except in compliance with the
|
jaroslav@358
|
13 |
* License. You can obtain a copy of the License at
|
jaroslav@358
|
14 |
* http://www.netbeans.org/cddl-gplv2.html
|
jaroslav@358
|
15 |
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
|
jaroslav@358
|
16 |
* specific language governing permissions and limitations under the
|
jaroslav@358
|
17 |
* License. When distributing the software, include this License Header
|
jaroslav@358
|
18 |
* Notice in each file and include the License file at
|
jaroslav@358
|
19 |
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
|
jaroslav@358
|
20 |
* particular file as subject to the "Classpath" exception as provided
|
jaroslav@358
|
21 |
* by Oracle in the GPL Version 2 section of the License file that
|
jaroslav@358
|
22 |
* accompanied this code. If applicable, add the following below the
|
jaroslav@358
|
23 |
* License Header, with the fields enclosed by brackets [] replaced by
|
jaroslav@358
|
24 |
* your own identifying information:
|
jaroslav@358
|
25 |
* "Portions Copyrighted [year] [name of copyright owner]"
|
jaroslav@358
|
26 |
*
|
jaroslav@358
|
27 |
* Contributor(s):
|
jaroslav@358
|
28 |
*
|
jaroslav@358
|
29 |
* The Original Software is NetBeans. The Initial Developer of the Original
|
jaroslav@551
|
30 |
* Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
|
jaroslav@358
|
31 |
*
|
jaroslav@358
|
32 |
* If you wish your version of this file to be governed by only the CDDL
|
jaroslav@358
|
33 |
* or only the GPL Version 2, indicate your decision by adding
|
jaroslav@358
|
34 |
* "[Contributor] elects to include this software in this distribution
|
jaroslav@358
|
35 |
* under the [CDDL or GPL Version 2] license." If you do not indicate a
|
jaroslav@358
|
36 |
* single choice of license, a recipient has the option to distribute
|
jaroslav@358
|
37 |
* your version of this file under either the CDDL, the GPL Version 2 or
|
jaroslav@358
|
38 |
* to extend the choice of license to its licensees as provided above.
|
jaroslav@358
|
39 |
* However, if you add GPL Version 2 code and therefore, elected the GPL
|
jaroslav@358
|
40 |
* Version 2 license, then the option applies only if the new code is
|
jaroslav@358
|
41 |
* made subject to such option by the copyright holder.
|
jtulach@0
|
42 |
*/
|
jtulach@0
|
43 |
package net.java.html.json;
|
jtulach@0
|
44 |
|
jtulach@0
|
45 |
import java.lang.annotation.ElementType;
|
jtulach@0
|
46 |
import java.lang.annotation.Retention;
|
jtulach@0
|
47 |
import java.lang.annotation.RetentionPolicy;
|
jtulach@0
|
48 |
import java.lang.annotation.Target;
|
jtulach@0
|
49 |
|
jaroslav@629
|
50 |
/** Marks a method that is going to be notified when a
|
jaroslav@629
|
51 |
* property defined by {@link Model} has been changed. This is
|
jaroslav@629
|
52 |
* especially useful when one wants to react to changes in the
|
jaroslav@629
|
53 |
* model caused by the rendered view. In case of
|
jaroslav@629
|
54 |
* <a href="http://knockoutjs.com">knockout.js</a> technology
|
jaroslav@629
|
55 |
* one could for example react to selection of a name from a combo
|
jaroslav@629
|
56 |
* box:
|
jaroslav@629
|
57 |
* <pre>
|
jaroslav@629
|
58 |
*
|
jaroslav@629
|
59 |
* <!-- associates the selected value with property <em>name</em> -->
|
jaroslav@629
|
60 |
*
|
jaroslav@629
|
61 |
* <select data-bind="value: name">
|
jaroslav@629
|
62 |
* <option>Jiří</option>
|
jaroslav@629
|
63 |
* <option>Jarda</option>
|
jaroslav@629
|
64 |
* <option>Petr</option>
|
jaroslav@629
|
65 |
* <option>Tomáš</option>
|
jaroslav@629
|
66 |
* </select>
|
jaroslav@629
|
67 |
*
|
jaroslav@629
|
68 |
* // Java code snippet reacting to change of the <em>name</em> property:
|
jaroslav@629
|
69 |
*
|
jaroslav@629
|
70 |
* {@link OnPropertyChange @OnPropertyChange}("name")
|
jaroslav@629
|
71 |
* <b>static void</b> propertyChanged(AModel inst, {@link String} propertyName) {
|
jaroslav@629
|
72 |
* // schedule some operation
|
jaroslav@629
|
73 |
* // on the model
|
jaroslav@629
|
74 |
* }
|
jaroslav@629
|
75 |
* </pre>
|
jaroslav@629
|
76 |
* The method's first argument should be the instance of the
|
jtulach@1023
|
77 |
* associated {@link Model model class}. The method shall be non-private
|
jtulach@1023
|
78 |
* and unless {@link Model#instance() instance mode} is on also static.
|
jaroslav@629
|
79 |
* There can be an optional second {@link String} argument which will be set
|
jaroslav@629
|
80 |
* to the name of the changed property. The second argument is only useful when
|
jaroslav@629
|
81 |
* a single method reacts to changes in multiple properties.
|
jaroslav@629
|
82 |
* <p>
|
jaroslav@629
|
83 |
* An online example using this technique is
|
jaroslav@629
|
84 |
* <a target="_blank" href="http://dew.apidesign.org/dew/#7138581">available here</a> -
|
jaroslav@629
|
85 |
* it observes selection in a combo box and in case it changes
|
jaroslav@629
|
86 |
* the example sends a network
|
jaroslav@629
|
87 |
* request and {@link net.java.html.json.OnReceive asynchronously updates}
|
jaroslav@629
|
88 |
* list of code snippets.
|
jtulach@0
|
89 |
*
|
jtulach@655
|
90 |
* @author Jaroslav Tulach
|
jtulach@0
|
91 |
*/
|
jtulach@0
|
92 |
@Retention(RetentionPolicy.SOURCE)
|
jtulach@0
|
93 |
@Target(ElementType.METHOD)
|
jtulach@0
|
94 |
public @interface OnPropertyChange {
|
jtulach@0
|
95 |
/** Name(s) of the properties. One wishes to observe.
|
jtulach@0
|
96 |
*
|
jtulach@0
|
97 |
* @return valid java identifier
|
jtulach@0
|
98 |
*/
|
jtulach@0
|
99 |
String[] value();
|
jtulach@0
|
100 |
}
|