4:38 a.m.
Author: julien(a)jboss.com
Date: 2007-06-19 05:38:39 -0400 (Tue, 19 Jun 2007)
New Revision: 7464
Modified:
docs/trunk/referenceGuide/en/modules/ajax.xml
docs/trunk/referenceGuide/en/modules/urls.xml
Log:
added limitation section
Modified: docs/trunk/referenceGuide/en/modules/ajax.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/ajax.xml 2007-06-19 04:27:10 UTC (rev 7463)
+++ docs/trunk/referenceGuide/en/modules/ajax.xml 2007-06-19 09:38:39 UTC (rev 7464)
@@ -143,8 +143,8 @@
</para>
</sect2>
<sect2>
- <title>Partial refreshing</title>
- <para>Partial refreshing is a very powerful feature which allows the
portal to optimize the refreshing
+ <title>Partial refresh</title>
+ <para>Partial refresh is a very powerful feature which allows the portal
to optimize the refreshing
of portlets on a page. When one portlet is invoked, instead of redrawing the
full page, the portal is able
to detect which portlets needs to be refreshed and will update only these
portlets.</para>
<mediaobject>
@@ -155,14 +155,6 @@
<para>The portal providing partial refresh</para>
</caption>
</mediaobject>
- <warning>
- <title>Application scope session attributes</title>
- <para>When partial refresh is activated, the state of a page can
potentially become inconsistent. for
- example, if some objects are shared in the application scope of the session
between portlets. When one
- portlet update a session object, the other portlet won't be refreshed and
will still display content based
- on the previous value of the object in the session. To avoid that, partial
refresh can be desactivated
- for certain portlets by adding
<portlet-refresh>false<portlet-refresh> in the
jboss-portlet.xml file.</para>
- </warning>
<sect3>
<title>Portal objects configuration</title>
<para>Like with the drag and drop feature, partial page refresh is
controlled via properties on portal objects.
@@ -247,6 +239,35 @@
the portlet will not be subject of a partial page refresh when it is invoked.
However the portlet
markup can still be subject to a partial rendering.</para>
</sect3>
+ <sect3>
+ <title>Limitations</title>
+ <para>Partial refreshing of portlets has limitations both on the server
side (portal) and on the client side (browser).</para>
+ <sect4>
+ <title>Application scoped session attributes</title>
+ <para>When partial refresh is activated, the state of a page can
potentially become inconsistent. for
+ example, if some objects are shared in the application scope of the
session between portlets. When one
+ portlet update a session object, the other portlet won't be refreshed
and will still display content based
+ on the previous value of the object in the session. To avoid that, partial
refresh can be desactivated
+ for certain portlets by adding
<portlet-refresh>false<portlet-refresh> in the
jboss-portlet.xml file.</para>
+ </sect4>
+ <sect4>
+ <title>Non ajax interactions</title>
+ <para>The solution developped by JBoss Portal on the client side is
built on top of DOM events emitted
+ by the web browser when the user interracts with the page. If an
interaction is done without an
+ emission of an event then JBoss Portal will not be able to transform it
into a partial refresh and
+ it will result instead of a full refresh. This can happen with
programmatic submission of forms.
+ </para>
+ <programlisting><![CDATA[
+<form id="<%= formId %>" action="<%=
renderResponse.createActionURL() %>" method="post">
+ ...
+ <select onclick="document.getElementById('<%= formId
%>').submit()">
+ ...
+ </select>
+ ...
+</form>
+]]></programlisting>
+ </sect4>
+ </sect3>
</sect2>
</sect1>
</chapter>
\ No newline at end of file
Modified: docs/trunk/referenceGuide/en/modules/urls.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/urls.xml 2007-06-19 04:27:10 UTC (rev 7463)
+++ docs/trunk/referenceGuide/en/modules/urls.xml 2007-06-19 09:38:39 UTC (rev 7464)
@@ -65,4 +65,19 @@
will be rendered independant of the portal. </listitem>
</itemizedlist>
</sect1>
+ <sect1>
+ <title>Advanced portal URLs</title>
+ <para>JBoss Portal can consume and produce URLs in a very flexible manner.
Consuming means
+ that an URL is accepted by the portal, translated into some action and send a
response to the
+ browser. Producing means to create an URL when the portal needs one. This part is
an advanced
+ topic explaining the internal mechanisms developped in JBoss Portal to produce and
consumer URLs.
+ It should be readen with care as it exposes internals of JBoss Portal that may
change in later releases
+ of the product.</para>
+ <para>JBoss Portal is based on the Command Design Pattern which allow to
encapsulate actions into
+ a class.</para>
+ <sect2>
+ <title>URL consumption</title>
+ <para></para>
+ </sect2>
+ </sect1>
</chapter>