javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/OnReceive.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Fri, 26 Apr 2013 13:48:36 +0200
branchmodel
changeset 1023 ad9a37489365
parent 964 df60ba2aeb87
child 1787 ea12a3bb4b33
permissions -rw-r--r--
Deprecating the javaquery.api's knockout annotation in favour of net.java.html.json ones. Providing default context for the browser.
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 2 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. Look for COPYING file in the top folder.
    16  * If not, see http://opensource.org/licenses/GPL-2.0.
    17  */
    18 package org.apidesign.bck2brwsr.htmlpage.api;
    19 
    20 import java.lang.annotation.ElementType;
    21 import java.lang.annotation.Retention;
    22 import java.lang.annotation.RetentionPolicy;
    23 import java.lang.annotation.Target;
    24 
    25 /** 
    26  * @deprecated Replaced by new {@link net.java.html.json.OnReceive net.java.html.json} API.
    27  * @author Jaroslav Tulach <jtulach@netbeans.org>
    28  * @since 0.6
    29  */
    30 @Retention(RetentionPolicy.SOURCE)
    31 @Target(ElementType.METHOD)
    32 @Deprecated
    33 public @interface OnReceive {
    34     /** The URL to connect to. Can contain variable names surrounded by '{' and '}'.
    35      * Those parameters will then become variables of the associated method.
    36      * 
    37      * @return the (possibly parametrized) url to connect to
    38      */
    39     String url();
    40     
    41     /** Support for <a href="http://en.wikipedia.org/wiki/JSONP">JSONP</a> requires
    42      * a callback from the server generated page to a function defined in the
    43      * system. The name of such function is usually specified as a property
    44      * (of possibly different names). By defining the <code>jsonp</code> attribute
    45      * one turns on the <a href="http://en.wikipedia.org/wiki/JSONP">JSONP</a> 
    46      * transmission and specifies the name of the property. The property should
    47      * also be used in the {@link #url()} attribute on appropriate place.
    48      * 
    49      * @return name of a property to carry the name of <a href="http://en.wikipedia.org/wiki/JSONP">JSONP</a>
    50      *    callback function.
    51      */
    52     String jsonp() default "";
    53 }