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

>


<!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

selectionFilter (single|multi)

>

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



<!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.



<!ELEMENT keywordReference EMPTY>

<!ATTLIST keywordReference

id IDREF #IMPLIED

>

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



<!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 or org.eclipse.ui.IWorkbenchPropertyPageMulti.

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, 2010 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