| <!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: Property Pages</title> | |
| </head> | |
| <body link="#0000FF" vlink="#800080"> | |
| <center> | |
| <h1> | |
| Property Pages</h1></center> | |
| <b><i>Identifier: </i></b>org.eclipse.ui.propertyPages | |
| <p><b><i>Description</i>: </b>This extension point is used to add additional | |
| property page for objects of a given type. Once defined, these property | |
| pages will appear in the Properties Dialog for objects of that type. | |
| <p>A property page is a user friendly way to interact with the properties | |
| of an object. Unlike the Properties view, which restricts the space | |
| available for editing an object property, a property page may benefit from | |
| the freedom to define larger, more complex controls with labels, icons, | |
| etc. Properties which logically go together may also be clustered | |
| in a page, rather than scattered in the property sheet. However, in most | |
| applications it will be appropriate to expose some properties of an object | |
| via the property sheet and some via the property pages. | |
| <p>Property pages are shown in a dialog box that is normally visible when the | |
| "Properties" menu item is selected on a pop-up menu for an object. In addition | |
| to the object class, the name filter can optionally be supplied to register | |
| property pages only for specific object types. | |
| <p>If these filtering mechanisms are inadequate a property page | |
| may use the <tt>filter</tt> mechanism. In this case the attributes | |
| of the target object are described in a series of key value pairs. | |
| The attributes which apply to the selection are type specific and beyond | |
| the domain of the workbench itself, so the workbench will delegate filtering | |
| at this level to the actual selection. | |
| <p><b><i>Configuration Markup:</i></b> | |
| <p><tt> <!ELEMENT page (filter)*></tt> | |
| <br><tt> <!ATTLIST page</tt> | |
| <br><tt> id | |
| CDATA #REQUIRED</tt> | |
| <br><tt> name | |
| CDATA #REQUIRED</tt> | |
| <br><tt> icon | |
| CDATA #IMPLIED</tt> | |
| <br><tt> objectClass CDATA | |
| #REQUIRED</tt> | |
| <br><tt> class | |
| CDATA #REQUIRED</tt> | |
| <br><tt> nameFilter CDATA | |
| #IMPLIED</tt> | |
| <br><tt> adaptable (true|false) | |
| #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>icon</b> - a relative path to an icon that will be used in the UI in | |
| addition to the page name.</li> | |
| <li> | |
| <b>objectClass</b> - a fully qualified name of the class for which the | |
| page is registered.</li> | |
| <li> | |
| <b>class</b> - a fully qualified name of the class that implements <tt>org.eclipse.ui.IWorkbenchPropertyPage</tt>.</li> | |
| <li> | |
| <b>nameFilter</b> - an optional attribute that allows registration conditional | |
| on a wild card match applied to the target object name.</li> | |
| <li> | |
| <b>adaptable</b> - a flag that indicates if types that adapt to IResource should | |
| use this property page. This flag is used only if objectClass adapts to | |
| IResource. Default value is false.</li> | |
| </ul> | |
| <tt> <!ELEMENT filter EMPTY></tt> | |
| <br><tt> <!ATTLIST filter</tt> | |
| <br><tt> name | |
| CDATA #REQUIRED</tt> | |
| <br><tt> value | |
| CDATA #REQUIRED</tt> | |
| <br><tt> ></tt> | |
| <ul> | |
| <li> | |
| <b>name</b> - the name of an object attribute.</li> | |
| <li> | |
| <b>value</b> - the value of an object attribute. In combination with | |
| the name attribute, the name value pair is used to define the target object | |
| for a property page.</li> | |
| </ul> | |
| <b><i>Examples:</i></b> | |
| <p>The following is an example of a property page extension: | |
| <p><tt> <extension point="org.eclipse.ui.propertyPages"></tt> | |
| <br><tt> <page</tt> | |
| <br><tt> id="com.xyz.projectPage"</tt> | |
| <br><tt> name="XYZ Java | |
| Properties"</tt> | |
| <br><tt> objectClass="org.eclipse.core.resources.IFile"</tt> | |
| <br><tt> class="com.xyz.ppages.JavaPropertyPage"</tt> | |
| <br><tt> nameFilter="*.java"></tt> | |
| <br><tt> <filter name="readOnly" value="true"/></tt> | |
| <br><tt> </page></tt> | |
| <br><tt> </extension></tt> | |
| <p><b><i>API Information</i></b>: The attribute <tt>class</tt> must specify | |
| a fully qualified name of a class that implements <tt>org.eclipse.ui.IWorkbenchPropertyPage</tt>. | |
| <p><b><i>Supplied Implementation</i>: </b>Some objects provided by the | |
| workbench may have property pages registered. Plug-ins are allowed to add | |
| more property pages for these objects. Property pages are not limited to | |
| workbench resources: all objects showing up in the workbench (even domain | |
| specific objects created by the plug-ins) may have property pages and other | |
| plug-ins are allowed to register property pages for them. | |
| <p><a href="hglegal2002.htm"><img SRC="ngibmcpy2002.gif" ALT="Copyright IBM Corporation and others 2000, 2002." BORDER=0></a> | |
| </body> | |
| </html> |