src/main/javadoc/overview.html
author Jaroslav Tulach <jaroslav.tulach@netbeans.org>
Fri, 07 Feb 2014 07:44:34 +0100
changeset 551 7ca2253fa86d
parent 550 06341c474dce
child 568 f0b64a5d6517
permissions -rw-r--r--
Updating copyright headers to mention current year
jaroslav@550
     1
<!--
jaroslav@550
     2
jaroslav@550
     3
    DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
jaroslav@550
     4
jaroslav@551
     5
    Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
jaroslav@550
     6
jaroslav@550
     7
    Oracle and Java are registered trademarks of Oracle and/or its affiliates.
jaroslav@550
     8
    Other names may be trademarks of their respective owners.
jaroslav@550
     9
jaroslav@550
    10
    The contents of this file are subject to the terms of either the GNU
jaroslav@550
    11
    General Public License Version 2 only ("GPL") or the Common
jaroslav@550
    12
    Development and Distribution License("CDDL") (collectively, the
jaroslav@550
    13
    "License"). You may not use this file except in compliance with the
jaroslav@550
    14
    License. You can obtain a copy of the License at
jaroslav@550
    15
    http://www.netbeans.org/cddl-gplv2.html
jaroslav@550
    16
    or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
jaroslav@550
    17
    specific language governing permissions and limitations under the
jaroslav@550
    18
    License.  When distributing the software, include this License Header
jaroslav@550
    19
    Notice in each file and include the License file at
jaroslav@550
    20
    nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
jaroslav@550
    21
    particular file as subject to the "Classpath" exception as provided
jaroslav@550
    22
    by Oracle in the GPL Version 2 section of the License file that
jaroslav@550
    23
    accompanied this code. If applicable, add the following below the
jaroslav@550
    24
    License Header, with the fields enclosed by brackets [] replaced by
jaroslav@550
    25
    your own identifying information:
jaroslav@550
    26
    "Portions Copyrighted [year] [name of copyright owner]"
jaroslav@550
    27
jaroslav@550
    28
    Contributor(s):
jaroslav@550
    29
jaroslav@550
    30
    The Original Software is NetBeans. The Initial Developer of the Original
jaroslav@551
    31
    Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
jaroslav@550
    32
jaroslav@550
    33
    If you wish your version of this file to be governed by only the CDDL
jaroslav@550
    34
    or only the GPL Version 2, indicate your decision by adding
jaroslav@550
    35
    "[Contributor] elects to include this software in this distribution
jaroslav@550
    36
    under the [CDDL or GPL Version 2] license." If you do not indicate a
jaroslav@550
    37
    single choice of license, a recipient has the option to distribute
jaroslav@550
    38
    your version of this file under either the CDDL, the GPL Version 2 or
jaroslav@550
    39
    to extend the choice of license to its licensees as provided above.
jaroslav@550
    40
    However, if you add GPL Version 2 code and therefore, elected the GPL
jaroslav@550
    41
    Version 2 license, then the option applies only if the new code is
jaroslav@550
    42
    made subject to such option by the copyright holder.
jaroslav@550
    43
jaroslav@550
    44
-->
jaroslav@541
    45
<!DOCTYPE html>
jaroslav@541
    46
<html>
jaroslav@541
    47
    <head>
jaroslav@541
    48
        <title>HTML for Java APIs</title>
jaroslav@541
    49
        <meta charset="UTF-8">
jaroslav@541
    50
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
jaroslav@541
    51
    </head>
jaroslav@541
    52
    <body>
jaroslav@541
    53
        <p>
jaroslav@543
    54
         Use Java to write application logic; Use HTML5 to render the UI; 
jaroslav@543
    55
         {@link net.java.html.json.Model Animate an HTML page from Java};
jaroslav@543
    56
         Use {@link net.java.html.json.OnReceive REST} or
jaroslav@543
    57
         <a href="net/java/html/json/doc-files/websockets.html">WebSockets</a>;
jaroslav@543
    58
         interact with <a href="net/java/html/js/package-summary.html">JavaScript</a>;
jaroslav@543
    59
         Get the best of both worlds!
jaroslav@543
    60
         
jaroslav@541
    61
         The goal of these APIs is to use full featured Java runtime 
jaroslav@541
    62
         (e.g. real <a href="http://wiki.apidesign.org/wiki/HotSpot">HotSpot VM</a>), 
jaroslav@541
    63
         but still rely on a very lightweight rendering technology 
jaroslav@541
    64
         (so it can potentially fit 
jaroslav@541
    65
         <a href="http://bck2brwsr.apidesign.org">Bck2Brwsr</a> and definitely
jaroslav@541
    66
         to various types of phones). What can be more lightweight 
jaroslav@541
    67
         (from a browser perspective) than 
jaroslav@541
    68
         <a href="http://wiki.apidesign.org/wiki/HTML">HTML</a>!?
jaroslav@541
    69
         By default we use {@link net.java.html.boot.fx JavaFX's WebView} 
jaroslav@541
    70
         component to display the <a href="http://wiki.apidesign.org/wiki/HTML">HTML</a>. 
jaroslav@541
    71
         We eliminate the need to manipulate the DOM directly, 
jaroslav@541
    72
         there is a special {@link net.java.html.json Java to Knockout.js binding}. 
jaroslav@543
    73
         As a result the <a href="http://wiki.apidesign.org/wiki/Knockout4Java">HTML uses Knockout.js syntax</a>, 
jaroslav@541
    74
         yet the application code can be written in Java.
jaroslav@541
    75
        </p>
jaroslav@541
    76
        
jaroslav@541
    77
        <h3>Interesting Entry Points</h3>
jaroslav@541
    78
        
jaroslav@541
    79
        <p>Learn how to {@link net.java.html.json.Model animate an HTML page from Java}
jaroslav@541
    80
            without referencing single HTML element from the Java code.
jaroslav@541
    81
        </p>
jaroslav@541
    82
        <p>Use {@link net.java.html.json.OnReceive JSON} to communicate
jaroslav@541
    83
            with REST based server API.
jaroslav@541
    84
        </p>
jaroslav@541
    85
        <p>Use <a href="net/java/html/json/doc-files/websockets.html">WebSockets</a>
jaroslav@541
    86
            and JSON.
jaroslav@541
    87
        </p>
jaroslav@541
    88
        <p>Call JavaScript methods from Java and vice versa, via
jaroslav@541
    89
            <a href="net/java/html/js/package-summary.html">JavaScriptBody</a>.
jaroslav@541
    90
        </p>
jaroslav@541
    91
jaroslav@541
    92
        <h3>Getting Started</h3>
jaroslav@541
    93
jaroslav@541
    94
        There are many ways to start developing 
jaroslav@541
    95
        <a href="http://html.java.net">Html for Java</a> application. 
jaroslav@541
    96
        However to be sure one chooses the most recent setup, it is recommended
jaroslav@541
    97
        to switch to good old command line and use a 
jaroslav@541
    98
        <a href="http://wiki.apidesign.org/wiki/Knockout4Java">Maven archetype</a>
jaroslav@541
    99
        associated with every version of this project. Just type:
jaroslav@541
   100
        <pre>      
jaroslav@541
   101
$ mvn archetype:generate \
jaroslav@541
   102
 -DarchetypeGroupId=org.apidesign.html \
jaroslav@541
   103
 -DarchetypeArtifactId=knockout4j-archetype \
jaroslav@541
   104
 -DarchetypeVersion=x.y
jaroslav@541
   105
        </pre>
jaroslav@541
   106
        Answer few questions (for example choose myfirstbrwsrpage as artifactId) and then you can:
jaroslav@541
   107
        <pre>
jaroslav@541
   108
$ cd myfirstbrwsrpage
jaroslav@541
   109
$ mvn process-classes exec:java
jaroslav@541
   110
        </pre>
jaroslav@541
   111
        In a few seconds (or minutes if 
jaroslav@541
   112
        <a href="http://wiki.apidesign.org/wiki/Maven">Maven</a>
jaroslav@541
   113
        decides to download the whole Internet of dependencies) you should 
jaroslav@541
   114
        see a sample Hello World application. It is basically composed from one 
jaroslav@541
   115
        Java and one HTML file:
jaroslav@541
   116
        <pre>
jaroslav@541
   117
$ ls src/main/java/**/DataModel.java
jaroslav@541
   118
$ ls src/main/webapp/pages/index.html
jaroslav@541
   119
        </pre>
jaroslav@541
   120
        Play with them, modify them and enjoy
jaroslav@541
   121
        <a href="http://html.java.net">Html for Java</a>!
jaroslav@541
   122
        
jaroslav@541
   123
        <p>
jaroslav@541
   124
        <img src="net/java/html/json/doc-files/DukeHTML.png" width="640" height="480" alt="Duke and HTML5. Together at last!"/>
jaroslav@541
   125
        </p>
jaroslav@541
   126
    </body>
jaroslav@541
   127
</html>