The Portlet Adapter builder allows you to enable a model to be used as a portlet, to set a portlet title and description, and to expose profile values for customization when the model is used as a portlet.
Use this builder to add enable custom edit (personalize), edit defaults (shared settings) or configure mode options for business users or administrators to allow configuration and customization of the portlet when placed on a portal page.
About public render parameters
The Java™ Portlet Standard specifications define parameters called render parameters that portlets can set during an action or event. On each successive render or re-render action of that portlet, the name and value pair related to a render parameter is sent as a parameter in the render request. This capability is similar to the way in which a browser sends a form input as a request parameter to an action request. The purpose of render parameters is to save information that is used on a page for repeated render requests without the application having to store the information in the session.
The Java Portlet Standard 2.0 (JSR 286) specification lets an application publish its support for publicly consuming or setting a named render parameter. One portlet can send a named render parameter to another portlet that declares the same support for the same named public render parameter. Similarly, a portlet can receive from another portlet a named public render parameter. Such a parameter is set only during an action or event and is obtained in the same way as any other request parameter. The difference is that the render parameters can be shared among portlets, including those from different WARs. The requirement is that the render parameters must be defined with common naming. The named public render parameters are stored in the portlet deployment descriptor (portlet.xml
This builder has inputs that support public named render parameters and creates a helper LJO to facilitate the use of the public render parameters in the portlet.
Support for navigation state stored in JSR-168/JSR-286 render parameters
You can store the navigation state using JSR-168/JSR-286 render parameters.
This is currently disabled by default, but can be enabled by setting one of the following:
- enable globally for the project, update override.properties and set: bowstreet.navigationState.useRenderParameters = true
- enable individually for a single portlet, add a new Initialization Parameter to the Portlet Adapter builder in the Advanced section: bowstreet.navigationState.useRenderParameters value=true The bowstreet.navigationState.useRenderParameters property supports the following values:
- true = use render parameters for all models
- portlet = use render parameters for the top-level portlet model only (other model containers will not use render parameters)
Parent topic: Builder help
About using the builder call editor
Configuring the Portlet Adapter builder call
Introduction to portlets
Portlet Customizer builder
Localizing portlet titles