Product branding is specified in the Eclipse product extension point.
The following code is the code example for default branding used by the Lotus® Expeditor Client:
<property name="appName" value="DefaultPlatform" />
<property name="aboutText" value="%productAboutText" />
<property name="windowImages" value="icons/16.gif,images/32.gif" />
<property name="aboutImage" value="icons/productAbout.bmp" />
<property name="preferenceCustomization" value= "platform:/plugin/
To deploy your own branding, you must create a new branding plug-in and feature and deploy them as part of the initial installation by updating the provisioning manifest. The new branding feature must use the global install-handler to modify the product attribute in the rcplauncher.properties file.
Use the preceding snippet as an example for providing your branding. Replace com.ibm.rcp.platform.personality.branding
in the snippet with the name of your branding plug-in.
Specifying the Window title
The title bar appears at the top of the client platform and typically contains the name of the workbench and a small graphic.
To modify the product title bar, you specify the name attribute of the product extension in the plugin.xml file of your branding plug-in.
Code example of the product extension in the plugin.xml file:
Provide the actual value of the product name in the plugin.properties file of your branding plug-in.
Code example from plugin.properties:
product.description.0 = Sopwith Llama's Leading
Customer Service Application
product.name.0 = Sopwith Llama Smorgashboard
Provide a plugin_locale
.properties file in the plug-in if you need to provide content for multiple languages. Repeat each of the keys from plugin.properties that need to be different for the locale.
Specifying the Window image
On Microsoft® Windows® systems, a small image is associated with the product and is displayed in the title bar, next to the product title. You can modify this image to be consistent with your branding.
Standard Widget Tools (SWT) allows a set of images to be associated with a shell with the expectation that all the images in the set have the same appearance but are rendered at different sizes. These images are provided to the SWT shell, which is then able to select the most appropriate one for each specific use. For example, the smaller image (16 X 16) is used for the title and task bars while the larger image (32 X 32) is used in the Alt-Tab application switcher.
<property name="windowImages" value="platform:/plugin/com.ibm.rcp.samples.personality.branding.images/icons/16.gif,platform:/plugin/com.ibm.rcp.samples.personality.branding.images/icons/32.gif"/>
While the sample provides its window images in the same plug-in, it is possible for the images to be provided in a separate plug-in. If so, use a URL, such as platform:/plugin/pluginidwithoutversion/dir/filename
, for the image. For example, if there was a separate com.ibm.rcp.samples.personality.branding.images plug-in, then the windowImages property might appear like:
Specifying the About dialog image
To specify branding of the About dialog, you must specify the image shown in the About dialog box.
The image shown in the About dialog must be a file with a .bmp extension. A full-sized product image (no larger than 500 x 330 pixels) is shown without the "aboutText" text. A half-sized product image (no larger than 250 x 330 pixels) is shown with the "aboutText" text beside it.
<property name="aboutImage" value="icons/productAbout.bmp" />
You can have different About dialog images for each locale that the product supports. When a user opens the About dialog, the system detects the locale of the machine and then selects the About dialog image from the appropriate language directory.
A locale-specific image must reside in the nl/dir/localedirectory of either the plug-in supplying the images or a fragment associated with that plug-in. For example, in the com.ibm.rcp.samples.personality.branding plug-in, if there is a French-specific About image, then the productAbout.bmp file from the nl/icons/fr directory is used.
If the system does not find an About dialog image for your locale, then the system selects the default image from the com.myco.example_version_number
Specifying the About dialog text
Specify the text that is displayed next to the image in the About dialog using the aboutText property.
<property name="aboutText" value="About Sopwith Llama Smorgashboard" />
Specifying the splash screen
When a user launches the workbench, a splash screen image is displayed. You can replace the splash screen image with your own image. The splash screen must have the file extension .bmp. There are no constraints regarding the size of the image, but for reference, the standard Eclipse splash screen image is 500 x 300 pixels.
You can have a different splash screen for each locale that the product supports. When the application starts, the launcher determines the locale of the machine and then selects the splash screen image from the appropriate language directory in the plugins
directory. For example, a splash screen for the French locale resides in the nl/fr
To use your own splash screen, include the splash image in your branding plug-in. In your branding feature, use the global install handler to set the osgi.splashPath Java system property, osgi.splashPath=
. The syntax must be URL syntax. For example: osgi.splashPath=platform:/base/../shared/eclipse/plugins/com.ibm.rcp.samples.personality.branding
Specifying your own help home page
Help Contents for the product can be accessed by clicking Help
-> Help Contents
. To change the default help home page to one for your own product, provide the new help page as a fragment to org.eclipse.help.base
. You must use a different name from what is currently used (for example, help_home.html and rcp_help_home.html are already used). The default help fragment provided by the Lotus Expeditor Client is com.ibm.rcp.platform.personality.branding.help. It is recommended that you use this fragment as an example to create your own help fragment. Changing the one provided by the Lotus Expeditor Client and using it is not recommended.
The product branding plug-in contains the help page preference in the product plugin_customization.ini, such as:
(The branding sample does not supply a different help home page.)
Parent topic: Specifying platform branding: XPD622