From portal-commits at lists.jboss.org Fri Jul 13 05:27:16 2007 Content-Type: multipart/mixed; boundary="===============5303388183382424697==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r7748 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules. Date: Fri, 13 Jul 2007 05:27:15 -0400 Message-ID: --===============5303388183382424697== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: thomas.heute(a)jboss.com Date: 2007-07-13 05:27:15 -0400 (Fri, 13 Jul 2007) New Revision: 7748 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migratio= n.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalap= i.xml Log: Doc fixes: JBPORTAL-1547 JBPORTAL-1548 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/m= igration.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/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migrati= on.xml 2007-07-13 08:26:45 UTC (rev 7747) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migrati= on.xml 2007-07-13 09:27:15 UTC (rev 7748) @@ -53,7 +53,7 @@ are visable. If you use default theme like "renaissance" that = is present in 2.6, you shouldn't need to do anything. To update your custom= themes please refer to those bundled with portal as an example. - If you stay with old theme files you may find JBP 2.6 unusa= ble by not even be able to log in. + If you stay with old theme files you may find JBP 2.6 unusa= ble to the point that you may not even be able to log in Database Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/p= ortalapi.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/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portala= pi.xml 2007-07-13 08:26:45 UTC (rev 7747) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portala= pi.xml 2007-07-13 09:27:15 UTC (rev 7748) @@ -20,10 +20,10 @@ that no changes should be required when code is written against th= e API provided by the JBoss Portal 2.x versions and used in a later version of JBoss Portal 2.x. = - The Portal API package prefix is org.jboss.portal.= api and all the classes - part of the API are prefixed with that package except for two of t= hem which are the org.jboss.portal.Mode - and org.jboss.portal.WindowState classes, the= main reason being that twose two classes were defined - very early before the official Portal API framework was created. + The Portal API package prefix is org.jboss.portal.= api. All of the classes that are part + of this API are prefixed with this package name except for the org.jboss.portal.Mode + and org.jboss.portal.WindowState classes. The= se two classes were defined before the official + Portal API framework was created and so the names have been mainta= ined for backward compatibility. The Portlet API defines two classes that represents a portio= n of the visual state of a Portlet which are javax.portlet.PortletMode and j= avax.portlet.WindowState. Likewise the Portal API defines similar classes named org.jboss.p= ortal.Mode and @@ -104,8 +104,8 @@ The org.jboss.portal.api.PortalRuntimeContext gives access to state or operations - associated at runtime with the current user of the portal. It allows= to retrieve the user id when the method - String getUserId() returns a non null string. I= t also gives access to the + associated at runtime with the current user of the portal. The String getUserId() retrieve + the user id and can return null if no user is associated with the co= ntext. It also gives access to the PortalSession instance associated with the curr= ent user. Finally it gives access to the NavigationalStateContext associated with the cu= rrent user. @@ -210,8 +210,8 @@ The org.jboss.portal.api.event.PortalEventContext interface defines the context in which - an event is created and propagated. It allows to retrieve the PortalRuntimeContext in - order to obtain the portal context. Note that this method may ret= urn null if no context is available. + an event is created and propagated. It allows retrieval of the PortalRuntimeContext which + can in turn be used to obtain the portal context. @@ -292,9 +292,9 @@ interface semantic allows only traditional event delivering. T= he PortalNodeEventListener interface is designed to match the bubbling effect during an e= vent delivery. The PortalNodeEvent onEvent(PortalNodeEventCon= text context, PortalNodeEvent event) - declare a PortalNodeEvent as return type.= In normal circumstances it will return the - null value, however if the method call returns an event then t= his event should be considered by the portal - as behavior replacing the current one. + method declares a PortalNodeEvent as retu= rn type. Commonly the method returns null; + however, a returned PortalNodeEvent replaces the event in the = listeners subsequently called during + the event bubbling process. --===============5303388183382424697==--