| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </HEAD> |
| <HTML> |
| <BODY> |
| <H1><CENTER>Property Pages</CENTER></H1> |
| <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 filter 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> |
| <p><samp> <!ELEMENT extension (page*)></samp> |
| <br><br><samp> <!ATTLIST extension</samp> |
| <br><samp> point CDATA #REQUIRED</samp> |
| <br><samp> id CDATA #IMPLIED</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>point</b> - a fully qualified identifier of the target extension point</li><li><b>id</b> - an optional identifier of the extension instance</li><li><b>name</b> - an optional name of the extension instance</li></ul> |
| <p><samp> <!ELEMENT page (filter*)></samp> |
| <br><br><samp> <!ATTLIST page</samp> |
| <br><samp> id CDATA #REQUIRED</samp> |
| <br><samp> name CDATA #REQUIRED</samp> |
| <br><samp> icon CDATA #IMPLIED</samp> |
| <br><samp> objectClass CDATA #REQUIRED</samp> |
| <br><samp> class CDATA #REQUIRED</samp> |
| <br><samp> nameFilter CDATA #IMPLIED</samp> |
| <br><samp> adaptable (true | false) "false"#IMPLIED</samp> |
| <br><samp> ></samp> |
| <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 |
| 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 if objectClass adapts to IResource. Default value is false.</li></ul> |
| <p><samp> <!ELEMENT filter EMPTY></samp> |
| <br><br><samp> <!ATTLIST filter</samp> |
| <br><samp> name CDATA #REQUIRED</samp> |
| <br><samp> value CDATA #REQUIRED</samp> |
| <br><samp> ></samp> |
| <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>The following is an example of the property page definition: |
| <p> |
| <pre> |
| <extension point="org.eclipse.ui.propertyPages"> |
| <page |
| id="com.xyz.projectPage" |
| name="XYZ Java Properties" |
| objectClass="org.eclipse.core.resources.IFile" |
| class="com.xyz.ppages.JavaPropertyPage" |
| nameFilter="*.java"> |
| <filter name="readOnly" value="true"/> |
| </page> |
| </extension> |
| </pre> |
| </p><p> |
| <b><i>API Information: </i></b>The attribute <samp>class</samp> must specify a fully qualified name |
| of the class that implements |
| <samp>org.eclipse.ui.IWorkbenchPropertyPage</samp>.<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> |
| <p> |
| 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<p> |
| </BODY> |
| </HTML> |
