Inserting Click-to-Action encodeProperty

Rational® tools enable you to add a Click-to-Action menu to a JSP file to publish an output property.

This capability is not supported for JSR 168 or JSR 286 API portlets. However, if you target a WebSphere® Portal V6.1 server, you can use the newClient-Side tagging support capability for all portlet types.

The WebSphere Portal cooperative runtime environment supports multiple ways to trigger the publishing of an output property. It can be implicit, by programmatically providing the output property to the declared location while processing a portlet action, using wires, for example. Or it can be explicit, using a pop-up menu from a portlet JSP page. This second approach, Click-to-Action, is a feature specific to the IBM® portlet API. To enable this feature, the <encodeProperty> tag is inserted to the JSP page.

To insert a Click-to-Action Output Property (encodeProperty), perform the following steps:

1. Open a JSP file in the Design page in the Page Designer.

2. Select the

   Portlet drawer in the Palette view.

3. Drag and drop the

   Click-to-Action Output Property object from the Palette view onto the page. Alternatively select

   Insert | Portlet | Click-to-Action Output Property from the menu. The

   Insert Click-to-Action Output Property dialog opens.

4. Provide values for the applicable fields. To configure the portlet, specify the output property data type by providing the

   Data type URI. Because a JSP page can be used by any portlet within the same project, also specify the

   Source portlet that the current JSP page belongs to. Click Next.

5. In the Click-to-Action Tag Attributes page, update the encodeProperty attributes. Refer to Editing Click-to-Action encodeProperty for a description of how to update attributes of the inserted Output Property (encodeProperty). The value is not required at this time, but must be specified before the portlet is deployed.

6. Click OK. The inserted output property is displayed in the JSP page in the Design page as an output property icon ().

Inserting the

Click-to-Action Output Property object performs the following tasks:

1. Enabling cooperative sources if necessary.

2. Inserts a <c2a:encodeProperty> tag and the taglib directive in the JSP file. The <c2a:encodeProperty> tag contains the specified type and the namespace property values. In addition to this, specify the Value property. You can also specify any other applicable properties. For details about updating these properties, refer to Editing Click-to-Action encodeProperty.

   • Value: Required.

   • Broadcast: Optional. The default setting is false.

   • Generate markup: Optional. The default is false.

 

Related concepts

Developing cooperative portlets

 

Related reference

Web Services Description Language (WSDL) 1.1

WebSphere Portal Information Center

---