json/src/main/java/net/java/html/json/Function.java
author Jaroslav Tulach <jaroslav.tulach@netbeans.org>
Mon, 16 Dec 2013 17:39:56 +0100
changeset 365 5c93ad8c7a15
parent 358 80702021b851
child 549 11198031c76a
permissions -rw-r--r--
The work on this project started in 2013
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013-2013 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-2013 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;
    44 
    45 import java.lang.annotation.ElementType;
    46 import java.lang.annotation.Retention;
    47 import java.lang.annotation.RetentionPolicy;
    48 import java.lang.annotation.Target;
    49 
    50 /** Methods in class annotated by {@link Model} can be 
    51  * annotated by this annotation to signal that they should be available
    52  * as functions to users of the model classes. The method
    53  * should be non-private, static and return <code>void</code>.
    54  * It may take up to two arguments. One argument can be the type of
    55  * the associated model class, the other argument can be of any type,
    56  * but has to be named <code>data</code> - this one represents the
    57  * actual data the function was invoked on. Example:
    58  * <pre>
    59  * 
    60  * {@link Model @Model}(className="Names", properties={
    61  *   {@link Property @Property}(name = "selectedName", type=String.class),
    62  *   {@link Property @Property}(name = "names", type=String.class, array = true)
    63  * })
    64  * static class NamesModel {
    65  *   {@link Function @Function} static void <b>nameSelected</b>(Names myModel, String data) {
    66  *     myModel.setSelectedName(data);
    67  *   }
    68  * 
    69  *   static void initialize() {
    70  *     Names pageModel = new Names("---", "Jarda", "Pepa", "Honza", "Jirka", "Tomáš");
    71  *     pageModel.applyBindings();
    72  *   }
    73  * }
    74  * 
    75  * // associated <a href="http://knockoutjs.com/">Knockout</a> HTML page:
    76  * 
    77  * Selected name: &lt;span data-bind="text: selectedName">&lt;/span&gt;
    78  * &lt;ul data-bind="foreach: names"&gt;
    79  *   &lt;li data-bind="text: $data, click: <b>$root.nameSelected</b>">&lt;/li&gt;
    80  * &lt;/ul&gt;
    81  * </pre>
    82  * The above example would render:
    83  * <hr>
    84  * Selected name: <span>---</span>
    85  * <ul>
    86  *   <li>Jarda</li>
    87  *   <li>Pepa</li>
    88  *   <li>Honza</li>
    89  *   <li>Jirka</li>
    90  *   <li>Tomáš</li>
    91  * </ul>
    92  * <hr>
    93  * and after clicking on one of the names the <code>---</code> would be replaced
    94  * by selected name.
    95  * 
    96  * @author Jaroslav Tulach <jtulach@netbeans.org>
    97  */
    98 @Target(ElementType.METHOD)
    99 @Retention(RetentionPolicy.SOURCE)
   100 public @interface Function {
   101 }