From portal-commits at lists.jboss.org Fri Apr 27 18:52:49 2007 Content-Type: multipart/mixed; boundary="===============0082184189554143998==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r7118 - in docs/trunk/referenceGuide/en: images/ajax and 1 other directories. Date: Fri, 27 Apr 2007 18:52:49 -0400 Message-ID: --===============0082184189554143998== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: julien(a)jboss.com Date: 2007-04-27 18:52:48 -0400 (Fri, 27 Apr 2007) New Revision: 7118 Added: docs/trunk/referenceGuide/en/images/ajax/ docs/trunk/referenceGuide/en/images/ajax/partial-refresh-admin.png docs/trunk/referenceGuide/en/images/ajax/partial-refresh.png Modified: docs/trunk/referenceGuide/en/modules/ajax.xml Log: completing ajax chapter Added: docs/trunk/referenceGuide/en/images/ajax/partial-refresh-admin.png =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 (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/ajax/partial-refre= sh-admin.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: docs/trunk/referenceGuide/en/images/ajax/partial-refresh.png =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 (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/ajax/partial-refre= sh.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: docs/trunk/referenceGuide/en/modules/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 --- docs/trunk/referenceGuide/en/modules/ajax.xml 2007-04-27 15:24:04 UTC (= rev 7117) +++ docs/trunk/referenceGuide/en/modules/ajax.xml 2007-04-27 22:52:48 UTC (= rev 7118) @@ -1,5 +1,5 @@ - + Julien @@ -102,10 +102,136 @@ Ajaxified pages - todo + 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 refreshing + Partial refreshing 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 objects. 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. + + - - Ajaxified portlets - todo - \ No newline at end of file --===============0082184189554143998==--