<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:svg="http://www.w3.org/2000/svg">
<fo:layout-master-set>
  <fo:simple-page-master master-name="one">
    <fo:region-body margin-top="25pt" margin-bottom="25pt" margin-left="50pt" margin-right="50pt" />
  </fo:simple-page-master>
</fo:layout-master-set>
<fo:page-sequence master-reference="one">
<fo:flow flow-name="xsl-region-body">
      <fo:block>This is used to show how foreign objects are placed in a line area.</fo:block>
      <fo:block>
        Some block text to separate instream objects.
      </fo:block>
      <fo:block>
        Some text before
<fo:instream-foreign-object>
<svg:svg width="20" height="20">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
</svg:svg>
</fo:instream-foreign-object>
        and some after the svg element.
      </fo:block>
      <fo:block>
        A text line below the instream object.
      </fo:block>
      <fo:block>
<fo:instream-foreign-object>
<svg:svg width="250" height="50">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
    <svg:text style="font-family:Helvetica;fill:blue" x="10" y="30">SVG placed in a block</svg:text>
</svg:svg>
</fo:instream-foreign-object>
      </fo:block>
      <fo:block>
        A text line below the block.
      </fo:block>
      <fo:block>
        A text line with an instream foreign object that is before the line break.
<fo:instream-foreign-object>
<svg:svg width="50" height="50">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
     <svg:rect style="fill:none;stroke:black" x="0" y="0" width="49" height="49"/>
</svg:svg>
</fo:instream-foreign-object>
With some text on the next line. With a bit more text to go over the to the next line.
      </fo:block>
      <fo:block>
        A text line with an instream foreign object that is after the line break.
With some text on the next line. With a bit
<fo:instream-foreign-object>
<svg:svg width="50" height="50">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
     <svg:rect style="fill:none;stroke:black" x="0" y="0" width="49" height="49"/>
</svg:svg>
</fo:instream-foreign-object>
more text to go over the to the next line.
      </fo:block>
      <fo:block>
        A text line with an instream foreign object that is over the line break.
With some text
<fo:instream-foreign-object>
<svg:svg width="50" height="50">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
     <svg:rect style="fill:none;stroke:black" x="0" y="0" width="49" height="49"/>
</svg:svg>
</fo:instream-foreign-object>
on the next line. With a bit more text to go over the to the next line to
see it handles it properly.
      </fo:block>
      <fo:block>
          The next block has an instream object wider than the area.
      </fo:block>
      <fo:block>
<fo:instream-foreign-object>
<svg:svg width="550" height="50">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
     <svg:rect style="fill:none;stroke:black" x="0" y="0" width="549" height="49"/>
    <svg:text x="10" y="30">SVG placed in a really wide block</svg:text>
</svg:svg>
</fo:instream-foreign-object>
      </fo:block>
      <fo:block>
          This block has an instream object wider than the area after this text
<fo:instream-foreign-object>
<svg:svg width="550" height="50">
  <svg:g style="fill:red; stroke:#000000">
     <svg:rect x="0" y="0" width="15" height="15"/>
     <svg:rect x="5" y="5" width="15" height="15"/>
  </svg:g>
     <svg:rect style="fill:none;stroke:black" x="0" y="0" width="549" height="49"/>
    <svg:text style="font-family:Helvetica" x="10" y="30">SVG placed in a really wide block</svg:text>
</svg:svg>
</fo:instream-foreign-object>
      </fo:block>
    </fo:flow>
  </fo:page-sequence>
</fo:root>
ure/dnd'>feature/dnd</option>
<option value='feature/elements'>feature/elements</option>
<option value='feature/eventbus'>feature/eventbus</option>
<option value='feature/karaf-feature-file'>feature/karaf-feature-file</option>
<option value='feature/nullrepresentation'>feature/nullrepresentation</option>
<option value='feature/standard-gwt'>feature/standard-gwt</option>
<option value='feature/standard-sass'>feature/standard-sass</option>
<option value='feature/vaadin8'>feature/vaadin8</option>
<option value='feature/vaadin8-book'>feature/vaadin8-book</option>
<option value='feature/vaadin8-book-vol2'>feature/vaadin8-book-vol2</option>
<option value='feature/vaadin8-sass-valo-only'>feature/vaadin8-sass-valo-only</option>
<option value='fileToFilesReplacement'>fileToFilesReplacement</option>
<option value='fix11576'>fix11576</option>
<option value='fix_event_router_prototype'>fix_event_router_prototype</option>
<option value='grid'>grid</option>
<option value='grid_dnd_autoscroller'>grid_dnd_autoscroller</option>
<option value='grid_dragger'>grid_dragger</option>
<option value='issue/8307_select_using_collection'>issue/8307_select_using_collection</option>
<option value='master'>master</option>
<option value='mobile_drag_image_offset'>mobile_drag_image_offset</option>
<option value='pr/11306'>pr/11306</option>
<option value='remote-run/flow-atmosphere-test'>remote-run/flow-atmosphere-test</option>
<option value='snapshot/7.5'>snapshot/7.5</option>
<option value='snapshot/7.6'>snapshot/7.6</option>
<option value='tmattsso-patch-1'>tmattsso-patch-1</option>
<option value='update-minor-deps'>update-minor-deps</option>
<option value='vaadin-icons-3.0.1'>vaadin-icons-3.0.1</option>
<option value='wip-date-time-datatype'>wip-date-time-datatype</option>
<option value='wip-java-10-compat'>wip-java-10-compat</option>
</select> <input type='submit' value='switch'/></form></td></tr>
<tr><td class='sub'>Vaadin 6, 7, 8 is a Java framework for modern Java web applications: https://github.com/vaadin/framework</td><td class='sub right'>www-data</td></tr></table>
<table class='tabs'><tr><td>
<a href='/vaadin-framework.git/about/?h=JS-RPC-docs-link-syntax'>about</a><a href='/vaadin-framework.git/?h=JS-RPC-docs-link-syntax'>summary</a><a href='/vaadin-framework.git/refs/?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>refs</a><a href='/vaadin-framework.git/log/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax'>log</a><a class='active' href='/vaadin-framework.git/tree/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>tree</a><a href='/vaadin-framework.git/commit/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>commit</a><a href='/vaadin-framework.git/diff/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>diff</a><a href='/vaadin-framework.git/stats/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax'>stats</a></td><td class='form'><form class='right' method='get' action='/vaadin-framework.git/log/documentation/clientsideapp/clientsideapp-overview.asciidoc'>
<input type='hidden' name='h' value='JS-RPC-docs-link-syntax'/><input type='hidden' name='id' value='080fcba26ad6571e191c816ae535449ab8f9d657'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/vaadin-framework.git/tree/?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>root</a>/<a href='/vaadin-framework.git/tree/documentation?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>documentation</a>/<a href='/vaadin-framework.git/tree/documentation/clientsideapp?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>clientsideapp</a>/<a href='/vaadin-framework.git/tree/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>clientsideapp-overview.asciidoc</a></div><div class='content'>blob: aa20571d8de53b47c5f29145918d40c6a75eef71 (<a href='/vaadin-framework.git/plain/documentation/clientsideapp/clientsideapp-overview.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=080fcba26ad6571e191c816ae535449ab8f9d657'>plain</a>)
<table summary='blob content' class='blob'>
<tr><td class='linenumbers'><pre><a id='n1' href='#n1'>1</a>
<a id='n2' href='#n2'>2</a>
<a id='n3' href='#n3'>3</a>
<a id='n4' href='#n4'>4</a>
<a id='n5' href='#n5'>5</a>
<a id='n6' href='#n6'>6</a>
<a id='n7' href='#n7'>7</a>
<a id='n8' href='#n8'>8</a>
<a id='n9' href='#n9'>9</a>
<a id='n10' href='#n10'>10</a>
<a id='n11' href='#n11'>11</a>
<a id='n12' href='#n12'>12</a>
<a id='n13' href='#n13'>13</a>
<a id='n14' href='#n14'>14</a>
<a id='n15' href='#n15'>15</a>
<a id='n16' href='#n16'>16</a>
<a id='n17' href='#n17'>17</a>
<a id='n18' href='#n18'>18</a>
<a id='n19' href='#n19'>19</a>
<a id='n20' href='#n20'>20</a>
<a id='n21' href='#n21'>21</a>
<a id='n22' href='#n22'>22</a>
<a id='n23' href='#n23'>23</a>
<a id='n24' href='#n24'>24</a>
<a id='n25' href='#n25'>25</a>
<a id='n26' href='#n26'>26</a>
<a id='n27' href='#n27'>27</a>
<a id='n28' href='#n28'>28</a>
<a id='n29' href='#n29'>29</a>
<a id='n30' href='#n30'>30</a>
<a id='n31' href='#n31'>31</a>
<a id='n32' href='#n32'>32</a>
<a id='n33' href='#n33'>33</a>
<a id='n34' href='#n34'>34</a>
<a id='n35' href='#n35'>35</a>
<a id='n36' href='#n36'>36</a>
<a id='n37' href='#n37'>37</a>
<a id='n38' href='#n38'>38</a>
<a id='n39' href='#n39'>39</a>
<a id='n40' href='#n40'>40</a>
<a id='n41' href='#n41'>41</a>
<a id='n42' href='#n42'>42</a>
<a id='n43' href='#n43'>43</a>
<a id='n44' href='#n44'>44</a>
<a id='n45' href='#n45'>45</a>
<a id='n46' href='#n46'>46</a>
<a id='n47' href='#n47'>47</a>
<a id='n48' href='#n48'>48</a>
<a id='n49' href='#n49'>49</a>
<a id='n50' href='#n50'>50</a>
<a id='n51' href='#n51'>51</a>
<a id='n52' href='#n52'>52</a>
<a id='n53' href='#n53'>53</a>
<a id='n54' href='#n54'>54</a>
<a id='n55' href='#n55'>55</a>
<a id='n56' href='#n56'>56</a>
<a id='n57' href='#n57'>57</a>
<a id='n58' href='#n58'>58</a>
<a id='n59' href='#n59'>59</a>
<a id='n60' href='#n60'>60</a>
<a id='n61' href='#n61'>61</a>
<a id='n62' href='#n62'>62</a>
<a id='n63' href='#n63'>63</a>
<a id='n64' href='#n64'>64</a>
<a id='n65' href='#n65'>65</a>
<a id='n66' href='#n66'>66</a>
<a id='n67' href='#n67'>67</a>
<a id='n68' href='#n68'>68</a>
<a id='n69' href='#n69'>69</a>
<a id='n70' href='#n70'>70</a>
<a id='n71' href='#n71'>71</a>
<a id='n72' href='#n72'>72</a>
<a id='n73' href='#n73'>73</a>
<a id='n74' href='#n74'>74</a>
<a id='n75' href='#n75'>75</a>
<a id='n76' href='#n76'>76</a>
<a id='n77' href='#n77'>77</a>
<a id='n78' href='#n78'>78</a>
<a id='n79' href='#n79'>79</a>
<a id='n80' href='#n80'>80</a>
<a id='n81' href='#n81'>81</a>
<a id='n82' href='#n82'>82</a>
<a id='n83' href='#n83'>83</a>
<a id='n84' href='#n84'>84</a>
</pre></td>
<td class='lines'><pre><code><style>pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span>---
title: Overview
order: 1
layout: page
---

[[clientsideapp.overview]]
= Overview

Vaadin allows developing client-side modules that run in the browser.
Client-side modules can use all the GWT widgets and some Vaadin-specific
widgets, as well as the same themes as server-side Vaadin applications.
Client-side applications run in the browser, even with no further server
communications. When paired with a server-side service to gain access to data
storage and server-side business logic, client-side applications can be
considered &quot;fat clients&quot;, in comparison to the &quot;thin client&quot; approach of the
server-side Vaadin applications. The services can use the same back-end services
as server-side Vaadin applications. Fat clients are useful for a range of
purposes when you have a need for highly responsive UI logic, such as for games
or for serving a huge number of clients with possibly stateless server-side
code.

[[figure.clientsideapp.overview.architecture]]
.Client-Side Application Architecture
image::img/clientsideapp-architecture-hi.png[]

A client-side application is defined as a __module__, which has an
__entry-point__ class. Its [methodname]#onModuleLoad()# method is executed when
the JavaScript of the compiled module is loaded in the browser.

Consider the following client-side application:


----
public class HelloWorld implements EntryPoint {
    @Override
    public void onModuleLoad() {
        RootPanel.get().add(new Label(&quot;Hello, world!&quot;));
    }
}
----

The user interface of a client-side application is built under a HTML __root
element__, which can be accessed by [methodname]#RootPanel.get()#. The purpose
and use of the entry-point is documented in more detail in
&lt;&lt;dummy/../../../framework/clientsideapp/clientsideapp-entrypoint#clientsideapp.entrypoint,&quot;Client-Side
Module Entry-Point&quot;&gt;&gt;. The user interface is built from __widgets__
hierarchically, just like with server-side Vaadin UIs. The built-in widgets and
their relationships are catalogued in
&lt;&lt;dummy/../../../framework/clientsidewidgets/clientsidewidgets-overview.asciidoc#clientsidewidgets.overview,&quot;Client-Side
Widgets&quot;&gt;&gt;. You can also use many of the widgets in Vaadin add-ons that have
them, or make your own.

A client-side module is defined in a __module descriptor__, as described in
&lt;&lt;dummy/../../../framework/clientside/clientside-module#clientside.module,&quot;Client-Side
Module Descriptor&quot;&gt;&gt;. A module is compiled from Java to JavaScript using the
Vaadin Compiler, of which use was described in
&lt;&lt;dummy/../../../framework/clientside/clientside-compiling#clientside.compiling,&quot;Compiling
a Client-Side Module&quot;&gt;&gt;. The
&lt;&lt;dummy/../../../framework/clientsideapp/clientsideapp-compiling#clientsideapp.compiling,&quot;Compiling
and Running a Client-Side Application&quot;&gt;&gt; in this chapter gives further
information about compiling client-side applications. The resulting JavaScript
can be loaded to any web page, as described in
&lt;&lt;dummy/../../../framework/clientsideapp/clientsideapp-loading#clientsideapp.loading,&quot;Loading
a Client-Side Application&quot;&gt;&gt;.

// TODO What is this? What&#39;s an &quot;UI Binder&quot;?
The client-side user interface can be built declaratively using the included
__UI Binder__.
// , as described in &lt;&lt;clientsideapp.uibinder&gt;&gt;.

The servlet for processing RPC calls from the client-side can be generated
automatically using the included compiler.

Even with regular server-side Vaadin applications, it may be useful to provide
an off-line mode if the connection is closed. An off-line mode can persist data
in a local store in the browser, thereby avoiding the need for server-side
storage, and transmit the data to the server when the connection is again
available. Such a pattern is commonly used with Vaadin TouchKit.

////
TODO It may be necessary to have such a section at some point.
Use of a client-side application to provide an off-line mode is described in &lt;&lt;clientsideapp.offline&gt;&gt;.
////
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.zx2c4.com/cgit/about/'>cgit v1.2.3</a> (<a href='https://git-scm.com/'>git 2.39.1</a>) at 2025-08-11 16:14:32 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>
