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.
<!ELEMENT extension (page*)>
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT page (filter* , keywordReference* , enabledWhen?)>
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.
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
Deprecated in Eclipse 3.3. Use adapt sub element of the enabledWhen element insteadNOTE: The adaptable attribute will attempt adapt an object to
org.eclipse.core.resources.IResourcebefore referencing the types registered in
Platform#getAdaptorManager. The enabledWhen element has no special case tests for
Platform#getAdaptorManagerto look up adaptable types. These can be registered using the
Set this attribute to "multi" to indicate that the property page supports multiple selected objects. Property pages supporting this mode must implement the interface org.eclipse.ui.IWorkbenchPropertyPageMulti. For multi-select pages "enabledWhen" condition will be provided with a Container filled with selected items (even if the selection contains only one item). On such pages "enabledWhen" expression should use "iterate" to access the selection's elements.
Set this attribute to "single" to indicate that the property page supports only single selection.
Default: singleSince 3.7.
<!ELEMENT filter EMPTY>
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>
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.
<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>
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