Objects that the Portlet Adapter builder creates  |
This topic describes the objects that the Portlet Adapter builder creates. |
This topic describes the objects that the Portlet Adapter builder creates.
Linked Java object (LJO)
A helper LJO is added to the Web application to provide utility convenience methods to supply information about the portlet render request attributes. It has the following name.
You can call the helper LJO from an action list by using the following format.
portletHelper.method_call
You can use the following methods in the LJO.
isPortletActionRequest()
Returns true if the portlet request is in the action phase.
isPortletRenderRequest()
Returns true if the portlet request is in the render phase.
setRenderParameter(name,value)
Set a render parameter with the specified name and value. This may be used to set a JSR 286 public render parameter in the action phase of one portlet, to be used by other JSR 286 portlets as an incoming request parameter during their render phase. Both sets of portlets must declare the public render parameters to be shared, using the same name and namespace in the portlet deployment descriptor. For Web Experience Factory portlets, the supported public render parameters may be declared in the "Public Render Parameters" section of the Portlet Adapter builder inputs.
getNamespace()
Return the unique namespace for that portlet from the JSR 168 or JSR 286 portlet container, by the portlet API. This can be used to prefix or suffix JavaScript™ with a value unique to that portlet instance if desired and to use as a unique portlet instance value for any other related purpose.
Note: For JSR 286 portlets, getNamespace() returns the unique namespace id in both action and render phases. However, the JSR 168 portlet API returns only a unique namespace value if you call it during a render request. If you call this convenience method from a JSR 168 render request or a legacy style portlet, it returns null.
Parent topic: Portlet Adapter builder
|
|
|
|
| Version 2 |
October 25, 2011 |
10:22:14 PM |
by Michael Burati  |
|
|