From do-not-reply at jboss.org Mon May 3 06:44:15 2010 Content-Type: multipart/mixed; boundary="===============0614130312115713618==" MIME-Version: 1.0 From: do-not-reply at jboss.org To: gatein-commits at lists.jboss.org Subject: [gatein-commits] gatein SVN: r2932 - in portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US: modules and 2 other directories. Date: Mon, 03 May 2010 06:44:15 -0400 Message-ID: <201005031044.o43AiFt5021886@svn01.web.mwc.hst.phx2.redhat.com> --===============0614130312115713618== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: thomas.heute(a)jboss.com Date: 2010-05-03 06:44:14 -0400 (Mon, 03 May 2010) New Revision: 2932 Removed: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.x= ml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/Reference_Guide.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/Introduction.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortalDevelopment.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfigurati= on.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortalDevelopment/Skinning.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Referen= ce_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml Log: JBEPP-276: Reference Guide Minor fixes Portlet Bridge review Removed some WebUI chapters Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/Reference_Guide.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/Reference_Guide.xml 2010-05-03 09:24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/Reference_Guide.xml 2010-05-03 10:44:14 UTC (rev 2932) @@ -14,6 +14,5 @@ - = Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/modules/Introduction.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/Introduction.xml 2010-05-03 09:24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/Introduction.xml 2010-05-03 10:44:14 UTC (rev 2932) @@ -6,7 +6,7 @@ Introduction - &PRODUCT; is the merge of two mature Java projects; JBoss Portal and eXo= Portal. This new community project takes the best of both offerings and in= corporates them into a single portal framework. The aim is to provide an in= tuitive user-friendly portal, and a framework to address the needs of today= 's Web 2.0 applications. + GateIn on which is based &PRODUCT; is the merge of two mature Java proje= cts; JBoss Portal and eXo Portal. This new community project takes the best= of both offerings and incorporates them into a single portal framework. Th= e aim is to provide an intuitive user-friendly portal, and a framework to a= ddress the needs of today's Web 2.0 applications. Deleted: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_R= eference_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactiva= tion.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.= xml 2010-05-03 09:24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.= xml 2010-05-03 10:44:14 UTC (rev 2932) @@ -1,98 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - Deactivation of the Ajax Loading Mask Layer - -
- Purpose - - The loading mask layer is deployed after an ajax-call. Its purpose is t= o block the GUI in order to prevent further user actions until the the ajax= -request has been completed. - - - However, the mask layer may need to be deactivated in instances where t= he portal requires user instructions before previous instructions have been= carried out. - - - How to Deactivate the Ajax-Loading Mask - - - Generate a script to make an asynchronous ajax-call. Use the uicomponent.doAsync() method rather than the uicomponen= t.event() method. - - - For example: - - = -<a href=3D"<%=3Duicomponent.doAsync(action, beanId, = params)%>" alt=3D"">Asynchronous</a> - - - - - The doAsync() method automatically adds the follow= ing new parameter into the parameters list; asyncparam =3D new Par= ameter(AJAX ASYNC,"true"); (AJAX ASYNC =3D=3D "ajax async") - - - This request is asynchronous and the ajax-loading mask will not deplo= yed. - - - Asynchronous Requests Using <literal>uicomponent.event()</liter= al> - - An asynchronous request can still be made using the uicompo= nent.event(). When using this method, however, the async= param must be added manually. - - - - - = - - The GUI will be blocked to ensure a user can only request one action at= a time and while the request seems to be synchronous, all ajax requests ar= e, in fact, always asynchronous. For further information refer to . - -
- = -
- Synchronous issue - - Most web browsers support ajax requests in two modes: Synchro= nous and Asynchronous. This mode is specifi= ed with a boolean bAsync parameter. - - = -var bAsync =3D false; // Synchronous -request.open(instance.method, instance.url, bAsync); - - - However, in order to work with browsers that do not support S= ynchronous requests, bAsync is set to always = be true (Ajax request will always be asynchronous). - - -// Asynchronous request -request.open(instance.method, instance.url, true); - -
- -
- Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConf= iguration.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfigurat= ion.xml 2010-05-03 09:24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfigurat= ion.xml 2010-05-03 10:44:14 UTC (rev 2932) @@ -262,7 +262,6 @@ Porlet instances can be associated with portlet-preferences= that override the ones defined in portlet.xml of the portlet application war. - (TODO: clarify which file in which war). = <?xml version=3D"1.0" encoding=3D"ISO-8859= -1"?> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/modules/PortalDevelopment/Skinning.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-05-03 09:24:25 = UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-05-03 10:44:14 = UTC (rev 2932) @@ -30,7 +30,7 @@ Window Styles - The CSS styles associated with the porlet window decorators. The win= dow decorators contain the control buttons and boarders surrounding each po= rtlet. Individual portlets can have their own window decorator selected, or= be rendered without one. + The CSS styles associated with the porlet window decorators. The win= dow decorators contain the control buttons and borders surrounding each por= tlet. Individual portlets can have their own window decorator selected, or = be rendered without one. @@ -170,7 +170,7 @@ &PRODUCT; automatically discovers web archives that contain a file des= criptor for skins (WEB-INF/gatein-resources.xml). This= file is reponsible for specifying the portal, portlet and window decorator= s to be deployed into the skin service. - The full schema can be found in the lib directory: exo.po= rtal.component.portal.jar/gatein_resources_1_0.xsd. + The full schema can be found at: . = Deleted: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_R= eference_Guide/en-US/modules/PortalDevelopment/UploadComponent.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml 2010-05-03 09= :24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml 2010-05-03 10= :44:14 UTC (rev 2932) @@ -1,155 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - Upload Component - -
- Upload Service - - This service is defined by the class: org.exoplatform.upload.U= ploadService; - - - This can be configured with the following xml code: - - = -<component> - <type>org.exoplatform.upload.UploadService</type> - <init-params> - <value-param> - <name>upload.limit.size</name> - <description>Maximum size of the file to upload in MB</de= scription> - <value>10</value> - </value-param> - </init-params> = - </component> - - - This code allows for a default upload size limit for the service to be = configured. The value unit is in MegaBytes. - - - This limit will be used by default by all applications if no applicatio= n-specific limit is set. Setting a different limit for applications is disc= ussed in a later section. - - - If the value is set at 0 the upload size is unli= mited. - - - How to use the upload component - - - Create an object type org.exoplatform.webui.form.UIFormUploa= dInput. - - - Two constructors are available for this: - - = -public UIFormUploadInput(String name, String bindingExpres= sion) - - - or: - - = -public UIFormUploadInput(String name, String bindingExpres= sion, int limit) - - - This is an example using the second form : - - = -PortletRequestContext pcontext =3D (PortletR= equestContext)WebuiRequestContext.getCurrentInstance(); -PortletPreferences portletPref =3D pcontext.getRequest().getPreferences(); -int limitMB =3D Integer.parseInt(portletPref.getValue("uploadFileSizeLimit= MB", "").trim()); -UIFormUploadInput uiInput =3D new UIFormUploadInput("upload", "upload", li= mitMB); - - - - - To obtain the limit from the xml configuration, th= is piece of code can be added to the either portlet.xml or portlet-preferences.xml : - - = -<preference> - <name>uploadFileSizeLimitMB</name> - <value>30</value> - <read-only>false</read-only> -</preference> - - - Again, a 0 value means an unlimited upload siz= e, and the value unit is set in MegaBytes. - - - - - Use the getUploadDataAsStream() method to get the = uploaded data: - - = -UIFormUploadInput input =3D (UIFormUploadInp= ut)uiForm.getUIInput("upload"); -InputStream inputStream =3D input.getUploadDataAsStream(); -... -jcrData.setValue(inputStream); - - - - - The upload service stores a temporary file on the file system during = the upload process. When the upload is finished, the service must be cleane= d in order to: - - - - - Delete the temporary file and... - - - - - Delete the classes used for the upload. - - - - - Use the removeUpload() method defined in the uploa= d service to purge the file: - - = -UploadService uploadService =3D uiForm.getAp= plicationComponent(UploadService.class) ; -UIFormUploadInput uiChild =3D uiForm.getChild(UIFormUploadInput.class) ; -uploadService.removeUpload(uiChild.getUploadId()) ; - - - Saving the uploaded file - - Ensure the file is saved before t= he service is cleaned. - - - - - -
- -
- Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/modules/PortalDevelopment.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment.xml 2010-05-03 09:24:25 UTC (rev = 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortalDevelopment.xml 2010-05-03 10:44:14 UTC (rev = 2932) @@ -1,6 +1,6 @@ + %BOOK_ENTITIES; ]> @@ -14,8 +14,6 @@ - - = Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuratio= n.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml = 2010-05-03 09:24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml = 2010-05-03 10:44:14 UTC (rev 2932) @@ -305,7 +305,7 @@
Configuration - Just like with any portlet 2.0 event consumer and receiver, you must = define them in the portlet.xml. To see a working example, checkout the Seam= Booking Demo portlet. + Just like with any portlet 2.0 event consumer and receiver, you must = define them in the portlet.xml. To see a working example, checkout the Seam= Booking Demo portlet. You must also define the following init params in your portlet.xml. @@ -358,7 +358,7 @@ Public Render Parameters (or PRPs) are one of the most powerful and s= imple Portlet 2.0 features. Several portlets (JSF or not) can share the sam= e render parameters. This feature can be use to present a cohesive UI to th= e user across all portlets on the page (i.e. using an employee ID to displa= y relative data). - The bridge maps a render parameter to a backing bean using settings i= n your faces-config.xml and portlet.xml. A clear and working example can be= found in the Seam Booking Demo portlet. + The bridge maps a render parameter to a backing bean using settings i= n your faces-config.xml and portlet.xml. A clear and working example can be= found in the Seam Booking Demo portlet. You must define the following init params in your portlet.xml. Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstart= ed.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 --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml= 2010-05-03 09:24:25 UTC (rev 2931) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Refere= nce_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml= 2010-05-03 10:44:14 UTC (rev 2932) @@ -48,7 +48,7 @@ The JBoss Portlet Bridge currently supports JBoss Portal, GateIn, JSF 1= .2, JBoss Seam, and JBoss Richfaces. There are configurations that apply to= supporting each framework. See section for instructions. - The JBoss Portlet Bridge project is also actively developing extensions= , and to differentiate from just another "project" that has boring ol' "ext= ensions" we coined the term "Bridgelets" - because what would a project wit= h Java and JSF be without having "*let" on the end of it? Not very cool in = my opinion ;) With that said, in this current release we decided to bring a= ll of our bridgelets into the impl code base since they are critical in mos= t JSF portlet applications. Now it only takes a single line of configuratio= n to utilize these features. + The JBoss Portlet Bridge project is also actively developing extensions= called "Bridgelets". In this current release we decided to bring all of ou= r bridgelets into the impl code base since they are critical in most JSF po= rtlet applications. Now it only takes a single line of configuration to uti= lize these features.
Seam Bridgelets @@ -73,57 +73,6 @@ <param-value>true</param-value> </context-param> - - - - - Don't forget that the bridge is still in Beta and so are any extensi= ons. If you would like to contribute to any part of this project, we encour= age you to be active on the user forum and bring iss= ues/enhancements to attention. - -
= @@ -132,18 +81,11 @@
Before you start - Current version and compatibilty information can be easily located on t= he JB= PB wiki. Ensure you are using compatible versions of all integrated= frameworks before you begin. - + The embedded version in the &PRODUCT; is made to be compatible with the= JSF implementation, portal and application server that compose the product= . You will find the binaries embedded in jboss-epp-5.0/portletbrid= ge + - JBoss Portal and GateIn provides it's latest distribution included in J= Boss Application Server. All of the guesswork has been eliminated so that y= ou can unzip and run the Portal with a few clicks. Get the latest here (ensure you choos= e the Portal + JBoss AS link) + You can run a provided archetype and deploy t= he generated war in a few easy steps. This will also give you an empty proj= ect to play around with or start from scratch. - - Next, all that's left is to download the JBoss Portlet Bridge distribution and= cofigure your portlet to use the bridge. Or, you can run a provided archet= ype and deploy the generated war in a few easy st= eps. This will also give you an empty project to play around with or start = from scratch. - -
=
@@ -177,10 +119,10 @@ mvn archetype:generate -DarchetypeGroupId=3Dorg.jboss.portletbridge.archetypes -DarchetypeArtifactId=3D1.2-basic - -DarchetypeVersion=3D2.0.0.CR1 + -DarchetypeVersion=3D2.0.0.FINAL -DgroupId=3Dorg.whatever.project -DartifactId=3Dmyprojectname - -DarchetypeRepository=3Dhttp://repository.jboss.org/maven2/ + -DarchetypeRepository=3Dhttps://repository.jboss.org/nexus/content/grou= ps/public/ @@ -193,10 +135,10 @@ mvn archetype:generate -DarchetypeGroupId=3Dorg.jboss.portletbridge.archetypes -DarchetypeArtifactId=3Drichfaces-basic - -DarchetypeVersion=3D2.0.0.CR1 + -DarchetypeVersion=3D2.0.0.FINAL -DgroupId=3Dorg.whatever.project -DartifactId=3Dmyprojectname - -DarchetypeRepository=3Dhttp://repository.jboss.org/maven2/ + -DarchetypeRepository=3Dhttps://repository.jboss.org/nexus/content/grou= ps/public/ @@ -209,10 +151,10 @@ mvn archetype:generate -DarchetypeGroupId=3Dorg.jboss.portletbridge.archetypes -DarchetypeArtifactId=3Dseam-basic - -DarchetypeVersion=3D2.0.0.CR1 + -DarchetypeVersion=3D2.0.0.FINAL -DgroupId=3Dorg.whatever.project -DartifactId=3Dseamproject - -DarchetypeRepository=3Dhttp://repository.jboss.org/maven2/ + -DarchetypeRepository=3Dhttps://repository.jboss.org/nexus/content/grou= ps/public/ --===============0614130312115713618==--