Preference Pages

Identifier: org.eclipse.ui.preferencePages

Description: The workbench provides one common dialog box for preferences. The purpose of this extension point is to allow plug-ins to add pages to the preference dialog box. When preference dialog box is opened (initiated from the menu bar), pages contributed in this way will be added to the dialog box.

The preference dialog box provides for hierarchical grouping of the pages. For this reason, a page can optionally specify a category attribute. This attribute represents a path composed of parent page IDs separated by '/'. If this attribute is omitted or if any of the parent nodes in the path cannot be found, the page will be added at the root level.

Configuration Markup:

   <!ELEMENT extension (page*)>

   <!ATTLIST extension
     point CDATA #REQUIRED
     id    CDATA #IMPLIED
     name  CDATA #IMPLIED
   >

   <!ELEMENT page EMPTY>

   <!ATTLIST page
     id       CDATA #REQUIRED
     name     CDATA #REQUIRED
     class    CDATA #REQUIRED
     category CDATA #IMPLIED
   >

Examples: The following is an example for the preference extension point:

   <extension 
       point="org.eclipse.ui.preferencePages"> 
      <page 
         id="com.xyz.prefpage1" 
         name="XYZ" 
         class="com.xyz.prefpages.PrefPage1"> 
      </page> 
      <page 
         id="com.xyz.prefpage2" 
         name="Keyboard Settings" 
         class="com.xyz.prefpages.PrefPage2" 
         category="com.xyz.prefpage1"> 
      </page> 
   </extension> 

API Information: The value of the attribute class must represent a fully qualified name of the class that implements org.eclipse.ui.IWorkbenchPreferencePage.

Supplied Implementation: The workbench adds several pages for setting the preferences of the platform. Pages registered through this extension will be added after them according to their category information.

Copyright (c) 2002 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html