# Property Pages

###### Identifier:

org.eclipse.ui.propertyPages

###### Description:

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.

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.

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.

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.

###### Configuration Markup:

<!ELEMENT extension (page*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance

<!ELEMENT page (filter* , keywordReference* , enabledWhen?)>

<!ATTLIST page

id CDATA #REQUIRED

name CDATA #REQUIRED

icon CDATA #IMPLIED

objectClass CDATA #IMPLIED

class CDATA #REQUIRED

nameFilter CDATA #IMPLIED

adaptable (true | false)

category IDREF #IMPLIED>

The page is the specification of the implementation and appearance of the page.

- id - a unique name that will be used to identify this page
- name - a translatable name that will be used in the UI for this page
- icon - a relative path to an icon that will be used in the UI in addition to the page name
- Deprecated objectClass - a fully qualified name of the class for which the page is registered. This class does not need to implement `IAdaptable`. Objects that are not an instance of `IAdaptable` will be wrappered in an `IAdaptable` before being sent to the property page's instance (an `org.eclipse.ui.IWorkbenchPropertyPage`).

  Deprecated in Eclipse 3.3. Use the instanceOf or adapt element of the enabledWhen element instead. If duplicate page definitions were previously used to register the page for multiple objectClass types, these should be combined into one page definition using multiple instanceOf elements combined inside an or element

- class - a fully qualified name of the class that implements `org.eclipse.ui.IWorkbenchPropertyPage`.
- nameFilter - an optional attribute that allows registration conditional on wild card match applied to the target object name.
- Deprecated adaptable - 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.

  Deprecated in Eclipse 3.3. Use adapt sub element of the enabledWhen element instead

  NOTE: The adaptable attribute will attempt adapt an object to `org.eclipse.core.resources.IResource` before referencing the types registered in `Platform#getAdaptorManager`. The enabledWhen element has no special case tests for `org.eclipse.core.resources.IResource` and uses `Platform#getAdaptorManager` to look up adaptable types. These can be registered using the `org.eclipse.core.runtime.adaptors` extension point.
- category - A path indicating the location of the page in the properties 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.

<!ELEMENT filter EMPTY>

<!ATTLIST filter

name CDATA #REQUIRED

value CDATA #REQUIRED>

This element is used to evaluate the attribute state of each object in the current selection. A match only if each object in the selection has the specified attribute state. Each object in the selection must implement, or adapt to, `org.eclipse.ui.IActionFilter`.

- name - the name of an object attribute.
- value - 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.

<!ELEMENT keywordReference EMPTY>

<!ATTLIST keywordReference

id IDREF #IMPLIED>

A reference by a property page to a keyword. See the keywords extension point.

- id - The id of the keyword being referred to.

<!ELEMENT enabledWhen (not | and | or | instanceof | test | systemTest | equals | count | with | resolve | adapt | iterate | reference)>

The enabled when element specifies the conditions under which this property page will be added to the properties dialog.

###### Examples:

The following is an example of the property page definition:

       <extension point="org.eclipse.ui.propertyPages">
            <page
                id="com.xyz.projectPage"
                name="XYZ Java Properties"
                class="com.xyz.ppages.JavaPropertyPage"
                nameFilter="*.java">
                <enabledWhen>
                 <instanceof
                      value="org.eclipse.core.resources.IFile">
                 </instanceof>
              </enabledWhen>
                <filter name="readOnly" value="true"/>
            </page>
        </extension>

###### API Information:

The attribute `class` must specify a fully qualified name of the class that implements `org.eclipse.ui.IWorkbenchPropertyPage`.

###### Supplied Implementation:

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.

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