Bookmark Provider

com.ibm.rcp.ui.bookmarkprovider

Lotus Expeditor 6.1

The Bookmark Provider extension point allows a plugin to register as a provider of bookmarks. Bookmarks are items that are dynamically displayed in the launcher and are allowed to be moved around, created and deleted in the launcher by the end user. If more than one bookmark provider has been defined then a ranking and/or provider name filter will be used to return a preferred bookmark provider. More than one bookmark provider can be defined in a given installation. For example, plugin A can define a bookmark provider and plugin B can define a bookmark provider.

<!ELEMENT extension (provider)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT provider EMPTY>

<!ATTLIST provider

id CDATA #REQUIRED

class CDATA #REQUIRED

name CDATA #IMPLIED

ranking CDATA #IMPLIED>

id - Unique identifier for this bookmark provider.
class - Class that implements IBookmarkProvider.
name - The name of the bookmark service provider. This will be used together with ranking to determine a preferred bookmark provider at runtime. If the runtime code looking for a bookmark provider doesn't care about the provider name then only ranking will used.
ranking - Similar to OSGi's SERVICE_RANKING. A non negative integer. The default is 0. The higher the rank (up to Integer.MAX_VALUE) the more likely the bookmark provider will be chosen. If there is more than one bookmark provider with the same rank (and that rank is the highest) it is undefined which bookmark provider will be chosen since it will depend on the order the plugin.xml files are processed.

<extension point=
"com.ibm.rcp.ui.bookmarkProvider"

     id=
"com.xyz.launcher.bookmark.test"

     name=
"A bookmark provider test"
>
     <provider
          class=
"com.xyz.launcher.bookmark.tests.TestBookmarkProvider"

          id=
"com.xyz.launcher.bookmark.testprovider"

          name=
"My test bookmark provider"

          ranking=
"16"
/>
</extension>

The value of the class attribute must be the fully qualified name of a class that implements com.ibm.rcp.ui.bookmark.IBookmarkProvider.

Bookmark Provider

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information: