Author: buildbot
Date: Thu Feb 6 21:10:58 2014
New Revision: 896681
Log:
Staging update by buildbot for deltaspike
Modified:
websites/staging/deltaspike/trunk/content/ (props changed)
websites/staging/deltaspike/trunk/content/jsf.html
Propchange: websites/staging/deltaspike/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Feb 6 21:10:58 2014
@@ -1 +1 @@
-1564696
+1565437
Modified: websites/staging/deltaspike/trunk/content/jsf.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/jsf.html (original)
+++ websites/staging/deltaspike/trunk/content/jsf.html Thu Feb 6 21:10:58 2014
@@ -80,8 +80,27 @@
</div>
<div class="toc">
<ul>
-<li><a href="#type-safe-view-configs">Type-safe View-Configs</a><ul>
+<li><a href="#multi-window-handling">Multi-Window Handling</a><ul>
<li><a href="#intro">Intro</a></li>
+<li><a href="#available-modes">Available modes</a><ul>
+<li><a href="#clientwindow">CLIENTWINDOW</a></li>
+<li><a href="#lazy">LAZY</a></li>
+<li><a href="#none">NONE</a></li>
+<li><a href="#delegated">DELEGATED</a></li>
+<li><a href="#custom">CUSTOM</a></li>
+</ul>
+</li>
+<li><a href="#configuration">Configuration</a><ul>
+<li><a href="#dswindowid">ds:windowId</a></li>
+<li><a href="#switch-mode">Switch Mode</a></li>
+<li><a href="#provide-a-custom-clientwindow">Provide a custom
ClientWindow</a></li>
+</ul>
+</li>
+<li><a href="#based-scopes">Based Scopes</a></li>
+</ul>
+</li>
+<li><a href="#type-safe-view-configs">Type-safe View-Configs</a><ul>
+<li><a href="#intro_1">Intro</a></li>
<li><a href="#motivation">Motivation</a></li>
<li><a href="#basic-api-usages">Basic API usages</a><ul>
<li><a href="#file-view-and-folder-folder-paths">File (@View) and Folder
(@Folder) paths</a><ul>
@@ -134,8 +153,59 @@
</ul>
</div>
<hr />
-<h1 id="type-safe-view-configs">Type-safe View-Configs</h1>
+<h1 id="multi-window-handling">Multi-Window Handling</h1>
<h2 id="intro">Intro</h2>
+<h2 id="available-modes">Available modes</h2>
+<h3 id="clientwindow">CLIENTWINDOW</h3>
+<h3 id="lazy">LAZY</h3>
+<h3 id="none">NONE</h3>
+<h3 id="delegated">DELEGATED</h3>
+<h3 id="custom">CUSTOM</h3>
+<h2 id="configuration">Configuration</h2>
+<h3 id="dswindowid">ds:windowId</h3>
+<p>The component <code>ds:windowId</code>
(<code>xmlns:ds="http://deltaspike.apache.org/jsf";</code>) is required to
enable the full control of the DeltaSpike window handling.
+It will import and render the required script parts for both <code>LAZY</code>
and <code>CLIENTWINDOW</code> mode.
+The best way, to apply it for all views, is to add this component to all of
your templates.</p>
+<h3 id="switch-mode">Switch Mode</h3>
+<p>To switch the mode, you can just provide a DefaultClientWindowConfig or
ClientWindowConfig:</p>
+<div class="codehilite"><pre><span class="nd">@Specializes</span>
+<span class="kd">public</span> <span class="kd">class</span> <span
class="nc">MyClientWindowConfig</span> <span class="kd">extends</span> <span
class="n">DefaultClientWindowConfig</span>
+<span class="o">{</span>
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span
class="n">ClientWindowRenderMode</span> <span
class="nf">getClientWindowRenderMode</span><span class="o">(</span><span
class="n">FacesContext</span> <span class="n">facesContext</span><span
class="o">)</span>
+ <span class="o">{</span>
+ <span class="c1">//...</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</pre></div>
+
+
+<h3 id="provide-a-custom-clientwindow">Provide a custom ClientWindow</h3>
+<p>If you would like to provide an custom ClientWindow implementation, you can
just do it e.g. via CDI alternatives:</p>
+<div class="codehilite"><pre><span class="nd">@ApplicationScoped</span>
+<span class="kd">public</span> <span class="kd">class</span> <span
class="nc">MyClientWindow</span> <span class="kd">implements</span> <span
class="n">ClientWindow</span>
+<span class="o">{</span>
+ <span class="c1">//...</span>
+<span class="o">}</span>
+</pre></div>
+
+
+<p>Don't forget to set the ClientWindowRenderMode to 'CUSTOM' via the
ClientWindowConfig:</p>
+<div class="codehilite"><pre><span class="nd">@Specializes</span>
+<span class="kd">public</span> <span class="kd">class</span> <span
class="nc">MyClientWindowConfig</span> <span class="kd">extends</span> <span
class="n">DefaultClientWindowConfig</span>
+<span class="o">{</span>
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span
class="n">ClientWindowRenderMode</span> <span
class="nf">getClientWindowRenderMode</span><span class="o">(</span><span
class="n">FacesContext</span> <span class="n">facesContext</span><span
class="o">)</span>
+ <span class="o">{</span>
+ <span class="k">return</span> <span
class="n">ClientWindowRenderMode</span><span class="o">.</span><span
class="na">LAZY</span><span class="o">;</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</pre></div>
+
+
+<h2 id="based-scopes">Based Scopes</h2>
+<h1 id="type-safe-view-configs">Type-safe View-Configs</h1>
+<h2 id="intro_1">Intro</h2>
<p>Type-safe view-configs are static configs which can be used in combination
with every view-technology which is based on Java.
Currently DeltaSpike itself provides an integration for JSF, however, the
basic concepts are independent of it.
(Since DeltaSpike provides the default integration only for JSF, the whole
documentation for view-configs is located here.)</p>
