Lotus: Component View Preferences

THEMES: Lotus\Notes/Domino 8 | Lotus\Composite Appl...
YEAR: 2007
Login Login
User: Anonymous

LABEL: Composite Application | Lotus Notes 8 | Lotus Notes API


Post comment
Component View Preferences16.10.2007 08:29Michel Siekendiek
Component View Preferences

In this blog entry and the one tomorrow I want to describe the different preferences that you can set on component views, pages and the application to modifiy the composite application.

In this entry I explain the different preferences for component views. All of these preferences can be set in the
Composite Application Editor. Some of them in a nice/specialized UI, other ones only in the generic UI for advanced preferences.

Component view preferences

The following preferences can be set on any type of component/component view.
Preference nameDescriptionCAE supportDefault
id.[anything]Id of the feature. See here for more details.
Example: 'com.ibm.cademo.feature'
url.[anything]URL of the feature's update site
Example: 'file:/C:/updatesite/com.ibm.cademo.update'
ver.[anything]Version of the feature. See here for more details.
Example: '1.0.5'
match.[anything]Determines which rules the provisioning process uses when comparing the version number of the feature to determine whether or not the version is acceptable. See here for more details.
Example: 'compatible'
shared.[anything]Specifies if feature should be provisioned to "shared" directorysometrue
com.ibm.rcp.showTitleWhether to show the title of the component view at the top of the rectangle. If multiple components are displayed in one rectangle they all show the title in the tabs regardeless.yestrue
com.ibm.rcp.standaloneIf true it shows the title of the component in one header that fills out the top of the rectangle. In this case however you cannot have minimize, maximize and close buttons.
If false it shows the title in a tab of the rectangle even if there is only one component view in that rectangle.
If this preference is true the title is always shown (overwrites com.ibm.rcp.showTitle).
com.ibm.rcp.moveableWhether users can move the component view. Changes will apply for all users on one client. The changes are overwritten the next time the application is modified via CAE.yestrue
com.ibm.rcp.visibleWhether the component view is visible or hidden when the page is displayedyestrue
com.ibm.rcp.ratioRatio of the component view. This is automatically set by CAE depending on the size of the component.yes0.5
com.ibm.rcp.folderA rectangle in the UI can have a folder name. If so multiple component views can be put in the same rectangle and tabs allow to navigate between them. CAE automatically sets the folder if you have more that one component in a specific location.yesnone
com.ibm.rcp.closeableWhether users can close component views. Only supported in Lotus Expeditor, not in Lotus Notes 8.0 since there is no way to open a closed component view again.nofalse

There are some more additional component view 'attributes' which are not set as generic preferences but there are specialized attributes:
- title (multiple languages): The CAE picks up whatever name you give your component view when adding to the palette (for current locale)
- description (multiple languages)

NSF component view preferences

The following preferences are supported by NSF component views in addition to the generic ones above.
Preference nameDescriptionCAE supportDefault
com.ibm.notes.notesurlThis is the Notes URL pointing to a certain design note in a specific Notes database, e.g. Notes:///85257202006A5D97/FlatCategory?OpenViewsomenone
com.ibm.rcp.viewIdThis is always com.ibm.workplace.noteswc.views.NotesViewDatayesthis value

- 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.