This topic describes the application page and composite application level properties. The Composite Application Editor allows for setting the page level preferences and the application/root page level preferences.
Page preferences
The following preferences can be set on any (normal) page.
Preference name | Description | CAE support | Default |
com.ibm.portal.PageIcon | URL pointing to an icon that is displayed in the tab for the page. For NSF based applications image resources from the database with the CA XML can be used. | yes | none |
com.ibm.rcp.application | GUID of the application. Read only. | no | none |
com.ibm.rcp.hidden | Whether the page is displayed in the out of the box navigator. | yes | false |
com.ibm.rcp.launcher | Whether this page should appear in the menu of frequently-used applications in the launcher after the application has been opened once. | yes | false |
com.ibm.rcp.autoStart | Whether this page should be opened automatically when the application is opened. This preference only works if com.ibm.rcp.launcher=true. | yes | false |
com.ibm.rcp.type | Type of navigation element. This can be TYPE_PERSPECTIVE or TYPE_LABEL.
In CAE when you create new page and deselect the "This page may contain components" checkbox, you are creating a label. | no | none |
com.ibm.rcp.activities | The list of Eclipse activities to be associated with the page. The value for this attribute should be in the format of a semi-colon delimited list, such as: activities=com.ibm.myactivity; com.ibm.mail.activity | yes | none |
com.ibm.rcp.defaultFolder | Id of the default Eclipse folder. When an Eclipse view is opened in this perspective dynamically, it will open in this folder. These views can only be opened programmatically via Eclipse APIs and the views don't have to part of the composite application definition. | no | none |
There are some more additional page 'attributes' which are not set as generic preferences but there are specialized attributes:
- title (multiple languages)
- description (multiple languages)
- objectid which is the Eclipse perspective id
Root page preferences
There is one special type of page, the root page. The root page is used to set application wide preferences.
Preference name | Description | CAE support | Default |
com.ibm.rcp.useNavigator | Whether to display the out of the box navigator on all pages (including hidden pages). Hidden pages are not displayed in the navigator.
If true all pages of the application are opened in the same tab.
If set to 'false' on a hidden page the out of the box navigator will not be displayed (the hidden page is still opened in the same tab as the other application pages). | no | true |
com.ibm.rcp.navigationModel | If com.ibm.rcp.useNavigator=true this preference is checked for the 'custom' value. If this preference is 'custom', the built in navigator is not displayed. It basically overwrites com.ibm.rcp.Navigator.
If the value for com.ibm.rcp.navigationModel = 'custom' then it is up to the application to provide the navigation mechanism; all application pages that are opened are displayed under the same tab. | no | no |
Notes:
- All preference names are case sensitive.
- You can access them in the Java code via the TopologyManager. See here
for the API documentation in Expeditor 6.1.