Lotus® Expeditor enables developers to extend its platform for customization. These customizations are possible by through plug-in extensions.
For example, you can add a menu item to one of the Lotus Expeditor global menus using the org.eclipse.ui.actionSets
extension point. You can also write code that performs a task and enables users to trigger that task from a corresponding menu item in the user interface by associating the task with the menu item. See Creating a top-level menu
for steps to contribute menu items.
Plug-in templates in Lotus Expeditor Toolkit
Plug-in templates provided with Lotus Expeditor Toolkit can help automate the steps for contributing a menu item, contributing a side shelf, and so on.
The following templates are available with the Client Services Project Wizard and Plug-in Project wizards (only for RCP):
- Menu template
- Side shelf template
These templates can be accessed using the following procedure in the Client Services Project wizard:
- Select File > New > Project. The new project wizard displays.
- Expand the Client Services folder and select Client Services Project.
- Navigate through the different pages (Client Services Project page, Client Services Content page, Target definition page) in the wizard by providing the required details until you reach the Templates selection page.
Menu Item templates let the users contribute menus to the menu bar as well as standard menu items. This template also generates a simple handler for handling the menu actions.
Multiple menu items can be created within a single project.
the following table contains descriptions of the options and their default values of the Menu Wizard page.
Table 1. Menu Wizard Panel
|Title ||Title for the menu item. Defines how the menu will appear when deployed. ||My Menu |
|Name ||ID for the menu item. This is the programmatic name used for the classes generated to create the menu item. It should not contain no spaces. ||mymenu|
|Description ||Description for the menu item.|| My Menu|
|Location||Defines where the new menu item will be inserted. Place holders are provided to indicate the insertion points.||/ (root)|
The Menu template generates the following artifacts in the project:
Table 2. Artifacts generated by the Menu template
|plugin.xml ||The following extensions are added with the values specified in the menu settings in menu wizard:
|Handler class||A handler class for handling menu actions. The default action is to display the “Hello User” dialog.|
Side shelf template
The Side Shelf template can be used to generate a fully functional side shelf component. It lets users contribute a side shelf component to RCP Applications, such as Notes®. The side shelf component will have a view and three drop down menus if that option is selected.
Refer to the following table for descriptions of the options and their default values in the Side Shelf Wizard.
Table 3. Side Shelf Wizard Panel
|Shelf ID ||This is the programmatic name used for the classes generated to create the side shelf component. It should contain no spaces. ||MySideShelf |
|Shelf Title ||This is the title that appears on the side shelf when deployed. ||My Side Shelf |
|Drop Down Menu ||A side shelf component has the option of adding menu items to its drop down title bar menu. Enable this option to generate code that creates three sample menus. You can change those or add more to add your own options. ||No |
|Display region||Contributed side shelf components appear in a region of the side shelf. You cannot give exact control, but you can select top, middle, or bottom to give some direction. ||bottom|
The Side Shelf template generates following artifacts in the project:
Table 4. Artifacts generated by Side Shelf template
|plugin.xml ||Adds a Side Bar extension (com.ibm.rcp.ui.shelfViews and other supporting extensions, such as org.eclipse.ui.views).|
|View class||A view class and associated actions .|
Parent topic: Extending the capabilities of your application: XPD622