Remote Systems View Preferences Page Action
Identifier:
com.ibm.etools.systems.core.remoteSystemsViewPreferencesAction
Since:
WSWB 3.0, or WSSD/WSAD/WDSC 5.1.2
Description:
This extension point is for contributing an action to the Remote Systems view pulldown menu, to the Preferences cascading menu. This action will launch the Preferences dialog, scoped to the particular page you specify. This will automatically show any child pages as well. This point is easy to extend, no coding required. Just name the preference page by its id from the preferencePages extension that defined the page. Also, if it is not a root page, then you must also name the root page (such as when using Windows->Preference) by its id from its preferencePages extension.
This would be used by anyone who extends the Remote System Explorer, and offers preference pages for their users, and wants a shortcut to those preference pages for convenience.
Configuration Markup:
<!ELEMENT extension (action+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT action EMPTY>
<!ATTLIST action
id CDATA #REQUIRED
label CDATA #REQUIRED
preferencePageId CDATA #REQUIRED
preferencePageCategory CDATA #IMPLIED
icon CDATA #IMPLIED
tooltip CDATA #IMPLIED
helpContextId CDATA #IMPLIED>
- id - A unique identifier for this extension.
- label - The display name for the action, shown in the menu. Include any mnenomnic if desired.
- preferencePageId - This matches the "id" attribute on the preferencePages extension, for the preference page you wish to show in the Preference Dialog for this action. If the preference page is a root (no "category" attribute in its preferencePages extension), this is all you need. Else, you also need to specify the preferencePageCategory attribute.
Note this page will be shown as the root in the Preferences dialog, but it can be expanded to see its child nodes.
- preferencePageCategory - This is required if the preference page you wish to show is not a root page, which means if it has a "category" attribute in its preferencePage extension definition. If so, here you give the "id" value of the preference page's root page... not its immediate parent! Be careful. We need to know the id of the root page so we know which root to recursively search the children of to find the page you specified in the preferencePageId attribute.
- icon - A relative path to an icon that will be displayed in the menu, with the label. Optional
- tooltip - A description of the action, for display on the status line, although it doesn't seem to work just yet. Optional
- helpContextId - The id of help to be shown when F1 is pressed while this action is selected. Optional
Examples:
API Information:
Since no coding is required, there is no API information.
Supplied Implementation:
This extension point is used by the com.ibm.etools.systems.core.ui.actions.SystemCascadingPreferencesAction
class, which in turn creates a com.ibm.etools.systems.core.ui.actions.SystemShowPreferencesPageAction
object for each extension of this point. These are used to populate the Preferences cascading menu of the Remote Systems view pulldown, but could be used elsewhere too, if desired.
(C) Copyright IBM Corp. 2002, 2004 All Rights Reserved.