Ajax

From portal-commits at lists.jboss.org Thu Oct 18 19:30:00 2007 Content-Type: multipart/mixed; boundary="===============3391568824628764965==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r8707 - in modules/test/trunk/docs/user-guide/en: modules and 1 other directory. Date: Thu, 18 Oct 2007 19:30:00 -0400 Message-ID: --===============3391568824628764965== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: julien(a)jboss.com Date: 2007-10-18 19:29:59 -0400 (Thu, 18 Oct 2007) New Revision: 8707 Added: modules/test/trunk/docs/user-guide/en/modules/introduction.xml Removed: modules/test/trunk/docs/user-guide/en/ajax.xml Modified: modules/test/trunk/docs/user-guide/en/master.xml Log: setup base info in docbook Deleted: modules/test/trunk/docs/user-guide/en/ajax.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/test/trunk/docs/user-guide/en/ajax.xml 2007-10-18 23:22:29 UTC = (rev 8706) +++ modules/test/trunk/docs/user-guide/en/ajax.xml 2007-10-18 23:29:59 UTC = (rev 8707) @@ -1,273 +0,0 @@ - - - - - Julien - Viet - julien.viet(a)jboss.com - - - Ajax - This section covers the ajax features provided by the portal. - - Introduction - Todo - - - Ajaxified markup - - Ajaxified layouts - Part of the Ajax capabilities are implemented in the layout= framework which provide the structure for - generating portal pages. The good news is that the existing layou= t only requires a few modifications in - order to be ajaxified. - We will use as example an simplified version of the layout = JSP provided in JBoss Portal 2.6 and outline - what are the required changes that makes it an ajaxified layout: - - - - - - - - - - - - - -

- - - - -

- - - - - -]]> - - ]]> = should be already present as it exists since 2.4 but is even more - necessary as it will inject in the page the reference to= the ajax stylesheet. - ]]> should be added before any other region - in the markup of the layout. - ]]> should be added after any other region - in the markup of the layout. - - - - - Ajaxified renderers - At runtime the portal combines the layout and the renderers= in order create the markup returned to the - web browser. The most used render set is the divRenderer. Rendere= rs only need a modification in the deployment - descriptor to indicate that they support ajax. Here is the declar= ation of the default divRenderer now in 2.6: - - - true - org.jboss.portal.theme.impl.render.div.DivRegionRen= derer - - org.jboss.portal.theme.impl.render.div.DivWindowRen= derer - - org.jboss.portal.theme.impl.render.div.DivPortletR= enderer - - org.jboss.portal.theme.impl.render.div.DivDecor= ationRenderer - - - -]]> - You should notice the true]]> which indicates that the render set - supports ajaxification. - - - - Ajaxified pages - The ajaxification of the portal pages can be configured in a f= ine grained manner. Thanks to the portal - object properties it is possible to control which pages support ajax= and which page do not support ajax. The - administrator must pay attention to the fact that property values ar= e inherited in the object hierarchy. - - Drag and Drop - That feature is only effective in dashboards as it requires= the offer personalization of the page - layout per user. By default the feature is enabled thanks to a pr= operty set on the dashboard object. - It is possible to turn off that property if the administrator doe= s not want to expose that feature - to its user. - In the file jboss-portal.sar/conf/data/default-ob= ject.xml is declared and configured the - creation of the dashboard portal: - - - keep - - dashboard - - ... - - theme.dyna.dnd_enabled - true - - ... - - ... - - -]]> - The property theme.dyna.dnd_enabled is= set to the value true - which means that the dashboard object will provide the drag and d= rop feature. - - - - Partial refresh - 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 re= drawing the full page, the portal is able - to detect which portlets needs to be refreshed and will update on= ly these portlets. - - - - - - The portal providing partial refresh - - - - Portal objects configuration - Like with the drag and drop feature, partial page refres= h is controlled via properties on portal objects. - The name of the property is theme.dyna.partial_re= fresh_enabled and its values can - be true or false.= When this property is set on an object - it is automatically inherited by the sub hierarchy located = under that object. By default the drag - and drop feature is positionned on the dashboard object and= not on the rest of the portal objects. - - - - keep - - dashboard - - ... - - theme.dyna.partial_refresh_enabled - true - - ... - - ... - - -]]> - - The partial page refresh feature is compatible with the Por= tal API. The Portal API allows programmatic - update of the state of portlets at runtime. For instance it= is possible to modify the window state or - the mode of several portlets on a given page. When such eve= nt occurs, the portal detects the changes - which occured and will update the portlet fragments in the = page. - - It is possible to change that behavior at runtime using = the property editor of the management portlet. - If you want to enable partial refreshing on the default portal= you should set the property to true - directly on the portal and all the pages in that portal will a= utomatically inherit those properties. - - - - - - The default portal configured for partial page ref= resh - - - - - Portlet configuration - - By default any portlet will support partial refreshing. Whe= n does the portal performs partial page - refreshing ? By default it is enabled for action and render= links with the following exceptions. In those - situations, the portal will prefer to perform a full page r= efresh: - - - Form GET are not handled, however it should not= be an issue as this situation is discouraged - by the Portlet specification. It however taken in acc= ount, just in case of. Here is an example - of a Java Server Page that would do one: - " method=3D"get"> - ... - -]]> - - - Form uploads are not handled. - - Having an interaction that deals with the MAXIMIZED window state. - When a window is entering a maximized state or leaving a= maximized window state, the portal will - perform a full page refresh. - - - It can happen that a portlet does not want to support pa= rtial refreshing, in those situations - the jboss-portlet.xml can be used to cont= rol that behavior. Since 2.6 an ajax - section has been added in order to configure ajax features rel= ated to the portlet. - - MyPortletNoAjax - - false - - -]]> - The usage of the partial-refresh se= t to the value false means that - 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. - - - Limitations - Partial refreshing of portlets has limitations both on t= he server side (portal) and on the client side (browser). - - Application scoped session attributes - When partial refresh is activated, the state of a pag= e can potentially become inconsistent. for - example, if some objects are shared in the application scop= e 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 avoi= d that, partial refresh can be desactivated - for certain portlets by adding <portlet-refresh>false= <portlet-refresh> in the jboss-portlet.xml file. - - - Non ajax interactions - 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 pag= e. 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 happe= n with programmatic submission of forms. - - " action=3D"<%=3D renderResponse.createActionUR= L() %>" method=3D"post"> - ... - - ... - -]]> - - - - - \ No newline at end of file Modified: modules/test/trunk/docs/user-guide/en/master.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/test/trunk/docs/user-guide/en/master.xml 2007-10-18 23:22:29 UT= C (rev 8706) +++ modules/test/trunk/docs/user-guide/en/master.xml 2007-10-18 23:29:59 UT= C (rev 8707) @@ -1,21 +1,20 @@ + ]> - Change Title in master.xml - Change SubTitle in master.xml - Change Release Info in master.xml - Change Release Info Date in master.xml + JBoss Unit + User Guide + Release 1.0 - Thomas - Heute - theute(a)jboss.org + Julien + Viet + julien(a)jboss.org - &sample; + &introduction; = Copied: modules/test/trunk/docs/user-guide/en/modules/introduction.xml (fro= m rev 8705, modules/test/trunk/docs/user-guide/en/modules/sample.xml) =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/test/trunk/docs/user-guide/en/modules/introduction.xml = (rev 0) +++ modules/test/trunk/docs/user-guide/en/modules/introduction.xml 2007-10-= 18 23:29:59 UTC (rev 8707) @@ -0,0 +1,58 @@ + + + + + Julien + Viet + julien(a)jboss.org + + + My title + This section covers the ajax features provided by the portal. + + Introduction + Todo + + + Ajaxified markup + + Ajaxified layouts + Part of the Ajax capabilities are implemented in the layout= framework which provide the structure for + generating portal pages. The good news is that the existing layou= t only requires a few modifications in + order to be ajaxified. + We will use as example an simplified version of the layout = JSP provided in JBoss Portal 2.6 and outline + what are the required changes that makes it an ajaxified layout: + + + + + + + + + + +]]> + + ]]> = should be already present as it exists since 2.4 but is even more + necessary as it will inject in the page the reference to= the ajax stylesheet. + ]]> should be added before any other region + in the markup of the layout. + ]]> should be added after any other region + in the markup of the layout. + + + + + + + + The portal providing partial refresh + + + + + --===============3391568824628764965==--