You can administer rich client properties for a portlet on a page. The set of properties to be edited is the same for all portlets.
Follow these steps to edit rich client properties.
- Log in to WebSphere® Portal as an administrator.
- Click Administration in the Portal toolbar.
- In the navigation tree, click Portal User Interface, then Manage Pages.
- Navigate through the pages or search for the target page until it appears in the list of pages.
- Click the Edit Page Layout icon (the pencil) on the line listing the target page.
- Click the Rich Client tab.
- Scroll through or search until the desired portlet shows in the list. This section provides a list of the portlets on the current page. The Portlet Title shown is for the portlet (that is, the concrete portlet) and is the same for all placements of that portlet on all pages. Each portlet can have a unique description called the Portlet Instance Description.
- Enable the box before the portlet title.
- Clicking a Configure icon (wrench) takes you to a page to modify the properties associated with the selected portlet and that are applicable to a client view.
Clicking an Edit icon (pencil) takes you to a similar page to edit portlet properties but the changes are stored as portlet instance data for this page instead of portlet settings for the portlet. These icons do not put the Rich Client Layout Administration Portlet into the respective modes; they represent the logical operation of the Rich Client Layout Administration Portlet relative to the data for the target portlet.
- Click OK to save the changes.
- Click Done to exit editing page layout.
Rich client parameters for the target portlet are changed and stored, ready for the client software to access them.
The following table list the view attributes you can edit.
This portlet page also adds the Instance description field provided in the previous list of portlets presented in the portlet's first page
The properties in this section represent characteristics of an Eclipse view. The values are not arbitrary but must reflect the actual characteristics of the corresponding entity on the client.
This is an optional field that can be used to distinguish between multiple instances of the same portlet on one page. It is metadata used for administration using the Rich Client Layout Administration Portlet and does not display on the client.Extension type
Indicates how the Topology Handler on the client will process the portlet's parameters. This field is not editable but its value controls how Rich Client Layout Administration Portlet processes certain form fields. The only recognized values are:
The portlet represents a view described by only its Eclipse view ID. This is the correct value for a portlet that represents an SWT (Standard Widget Toolkit) view on the client.Local portlet
The portlet represents a standard (JSR 168 compliant) portlet running locally in the portlet container on the client. The view configured here is actually an instance of the portlet viewer on the client that connects to the local portlet through a URL (context root). The administrator can specify the browser type used to display the local portlet. WSRP portlet
The portlet represents an instance of the portlet viewer on the client and that viewer connects to a remote portlet on a server. The connection is made using parameters set by the WSRP admin proxy portlet. Dynamic extension
The portlet represents a dynamic extension where the XML stream defining the extension is supplied by an admin proxy portlet rather than being constructed by the Topology Handler. The Rich Client Workbench Custom Eclipse Extension and Rich Client Workbench Native Application portlets are examples of this.
The extension type is used by the Rich Client Layout Administration Portlet to control the presentation of the SWT view ID and local portlet context root as described later. This lets you see an accurate representation of how the parameters are processed by Topology Handler on the client.
The radio buttons let you select between two mutually exclusive types of view. For each type, the applicable set of properties is listed below the selection line.
This portlet represents an SWT view on the rich client
This portlet runs locally on the rich client
Represents an SWT view which is the basic or lowest level interface normally used by an Eclipse application.
Table 1. Extension types
- Eclipse view ID - The unique identifier of the Eclipse view extension represented by this portlet.
- Variations are based on the value of extension type. When Rich Client Layout Administration Portlet detects extension type is normal (lower case), normal editing is allowed. When the extension type has been set by another portlet to read only (upper case), no change is allowed. The following table illustrates the variations:
|Extension Type||View Selection Radio Button||View ID in user interface||View ID Parameter Action|
|SIMPLE VIEW||Not shown||Display only||No change|
|simple view||Selected||Editable||Add or change|
|LOCAL PORTLET||Not shown||Not shown||Delete if present|
|local portlet||Selectable||Not shown||Delete if present|
|wsrp portlet||Not shown||Not shown||Delete if present|
|dynamic extension||Not shown||Not shown||Delete if present|
|Present but invalid||Not shown||Display||No change|
|Not present||Selectable||Editable||Change or add|Table 3. Portlet parameters
Represents a JSR 168 compliant portlet running in the portlet container included in the Expeditor client. If you are using only standard portlet APIs, this portlet can be exactly the same as runs on a Portal server. Whether or not the portlet is the same, it is developed for the server then packaged in a bundle for the client using the Expeditor WAB tool.
Table 2. Extension types
- Portlet context root - Additional information required for the client portlet viewer to connect to the portlet running in the client portlet container. A portlet running on the Portal Server does not have a context root because on the server a URL points to a page and all portlets on the page are aggregated by the server.
- Variations are based on the value of extension type. When RCLAP detects the extension type is normal (lower case), normal editing is allowed. If another portlet has set the extension type to read only (upper case), no change is allowed. The following table illustrates the variations:
|Extension Type||Portlet Selection Radio Button||Context Root in user interface||Content Root Parameter|
|SIMPLE VIEW||Not shown||Not shown||No change|
|simple view||Selectable||Not shown||No change|
|LOCAL PORTLET||Not shown||Read only||No change|
|local portlet||Selected||Editable||Change or add|
|wsrp portlet||Not shown||Not shown||No change|
|dynamic extension||Not shown||Not shown||No change|
|Present but invalid||Not shown||Display only||No change|
|Not present||Selectable||Editable||Change or add|
|Normal view||Specifies that the view is placed normally by the Topology Handler using the following parameters:|
|Folder ID ||The unique ID of the eclipse tabbed folder to which this view should be added when it is added to the perspective layout.|
|Visible when perspective is shown||If selected, the view is visible when the application is first started on the client. If not, a placeholder is created for it. When the view is opened, the view appears in the placeholder position.|
|Show the view title bar||If selected, the resulting view is displayed normally with the title bar. If this is not selected, the view displays without the title bar.|
|Allow this view to be moved within the perspective||If selected, the view can be closed or moved.|
|Add this view as standalone||If selected, this view as standalone.|
|Fast view||If selected, the view is added to the layout as a fast view. Fast views are added to the fast view bar in the client.|
|Ratio||The portion of the layout area this component should occupy based on the component it is attached to within the layout. This is the Eclipse based sizing of perspective layouts. If this is not specified the default ratio constant supplied by Eclipse is used. Ratio is a decimal number in the range of .05 to .95.|
For example, if you want to set up four portlets in a column and each with an equal height, how do you compute the ratio? Note that the ratio parameter you set in a portlet is not the real ratio of itself, but the ratio of its previously placed neighbor.
For the first portlet, as it lies on the top of all portlets, it does not need a ratio. For the second one, it should have a ratio, but the ratio is set for the first one, which may take 1/4 space of the whole column, so the ratio is 0.25. For the third one, it should have a ratio for the second one, which may take 1/3 of the remainder space, so the ratio is 0.33. For the last one, it should have a ratio for the third one. As this status, there are only 2 portlets left, each may take half of the remainder space, so the ratio should be 0.5.
|Allow this view to be closed from its title bar ||If selected, the client user can close the view from the title bar. If not selected, the close function is not present on the title bar. If there is no title bar the close function is not available.|
The following table lists the attributes for a view. Under PAA they must be stored in settings and/or instance data exactly as recognized by the client Topology Handler. Note that this table includes both the Rich Client Properties and Layout Properties as described above.
Table 4. PAA (Topology Handler) Portlet Data Parameters
|PAA (Topology Handler) Portlet Data Parameter||GUI Line Label||Additional Information|
|com.ibm.rcp.instanceDescription||Instance Description||Not used on client|
|com.ibm.rcp.extensionType||Extension type||Enumerated. Valid values are:
- simple view
- local portlet
- wsrp portlet
- dynamic extension
| com.ibm.rcp.viewId||Eclipse view id||As entered, except see com.ibm.rcp.extensionType|
|com.ibm.rcp.viewId||portlet runs locally||Client uses com.ibm.rcp.portletviewer.portletview|
|com.ibm.rcp.portletcontainer.contextRoot ||Portlet context root ||Portlet viewer not Topology Handler. |
|com.ibm.rcp.visible||Visible when perspective is shown||Boolean|
|com.ibm.rcp.showTitle||Show the view title bar||Boolean|
|com.ibm.rcp.moveable||Allow this view to be moved within the perspective||Boolean|
|com.ibm.rcp.standalone||Add this view as standalone||Boolean|
|com.ibm.rcp.closeable||Allow this view to be closed||Boolean|
Parent topic: Using the Rich Client Layout Administration Portlet: XPD622