| <!doctype html public "-//w3c//dtd html 4.0//en"> | |
| <html> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | |
| <title>Eclipse Workbench Extension Point: Preference Pages</title> | |
| </head> | |
| <body link="#0000FF" vlink="#800080"> | |
| <center> | |
| <h1> | |
| Preference Pages</h1></center> | |
| <b><i>Identifier: </i></b>org.eclipse.ui.preferencePages | |
| <p><b><i>Description: </i></b>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 the preference dialog box | |
| is opened (initiated from the menu bar), pages contributed in this way | |
| will be added to the dialog box. | |
| <p>The preference dialog box provides for hierarchical grouping of the | |
| pages. For this reason, a page can optionally specify a <tt>category</tt> | |
| 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. | |
| <p><b><i>Configuration Markup:</i></b> | |
| <p><tt> <!ELEMENT page EMPTY></tt> | |
| <br><tt> <!ATTLIST page</tt> | |
| <br><tt> id | |
| CDATA #REQUIRED</tt> | |
| <br><tt> name | |
| CDATA #REQUIRED</tt> | |
| <br><tt> class | |
| CDATA #REQUIRED</tt> | |
| <br><tt> category | |
| CDATA #IMPLIED</tt> | |
| <br><tt> ></tt> | |
| <ul> | |
| <li> | |
| <b>id</b> - a unique name that will be used to identify this page.</li> | |
| <li> | |
| <b>name</b> - a translatable name that will be used in the UI for this | |
| page.</li> | |
| <li> | |
| <b>category</b> - a path indicating the location of the page in the preference | |
| tree. The path may either be a parent node ID or a sequence of IDs separated | |
| by '/', representing the full path from the root node.</li> | |
| <li> | |
| <b>class</b> - a name of the fully qualified class that implements <tt>org.eclipse.ui.IWorkbenchPreferencePage</tt>.</li> | |
| </ul> | |
| <b><i>Examples:</i></b> | |
| <p>The following is an example for the preference pages extension point: | |
| <p><tt> <extension</tt> | |
| <br><tt> point="org.eclipse.ui.preferencePages"></tt> | |
| <br><tt> <page</tt> | |
| <br><tt> id="com.xyz.prefpage1"</tt> | |
| <br><tt> name="XYZ"</tt> | |
| <br><tt> class="com.xyz.prefpages.PrefPage1"></tt> | |
| <br><tt> </page></tt> | |
| <br><tt> <page</tt> | |
| <br><tt> id="com.xyz.prefpage2"</tt> | |
| <br><tt> name="Keyboard | |
| Settings"</tt> | |
| <br><tt> class="com.xyz.prefpages.PrefPage2"</tt> | |
| <br><tt> category="com.xyz.prefpage1"></tt> | |
| <br><tt> </page></tt> | |
| <br><tt> </extension></tt> | |
| <p><b><i>API Information</i>: </b>The value of the attribute <tt>class</tt> | |
| must represent a fully qualified name of the class that implements <tt>org.eclipse.ui.IWorkbenchPreferencePage</tt>. | |
| <p><i><b>Supplied Implementation:</b> </i>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. | |
| <p><a href="hglegal2002.htm"><img SRC="ngibmcpy2002.gif" ALT="Copyright IBM Corporation and others 2000, 2002." BORDER=0></a> | |
| </body> | |
| </html> |