Property Pages

org.eclipse.rse.ui.propertyPages

This extension point is modelled after the eclipse workbench extension point org.eclipse.ui.propertyPages. However, because we know we are targeting remote resources, it is simplified a bit. Specifically, there is no need to specify the object class, as we assume these actions apply to remote resources, which often share a common object class. On the other hand, we need additional filtering capabilities to scope which remote resources these pages are to apply to.

To this end, there is a rich set of filtering attributes to enable fine-grained scoping by a number of criteria. These scoping attributes are the same as those for our org.eclipse.rse.ui.popupMenus extension point.

While not fully documented here, this extension point supports the <filter> element from the org.eclipse.ui.popupMenus extension point. See its documentation in the help for information on this element. For example:

   <filter name=
"subsystemFactoryCategory"
 value=
"files"
/>

This element is for conditionally deciding whether to show the property page, very much like the attributes of the <page> element do; in fact there is some overlap.
The names supported for the <filter> element are:

"name". Will test the value for an exact match on an object's name, or beginning-of-name match if ends with an asterisk.
"type". Will test the value for an exact match on an object's type.
"offline".Will test the value against "true" if the user is working in "offline" mode or "false" if not. Currently only supported for iSeries connections.
"connected". Will test the value against "true" if the connection containing the selected object is active or "false" if not.
"hasChildren". Will test the value against "true" if this object's adapter reports that it has children or "false" if it doesn't have children.
"systemType". Will test the value for an exact match on the system type of this object's parent SystemConnection object. You can specify multiple values if you comma-separate them.
"subsystemFactoryId". Will test the value for an exact match on the ID of the subsystem factory that created this object's subsystem. Returns false for SystemConnection objects. You can specify multiple values if you comma-separate them.
"subsystemFactoryCategory". Will test the value for an exact match on the category of the subsystem factory that created this object's subsystem. You can specify multiple values if you comma-separate them.

<!ELEMENT extension (page+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

(no description available)

<!ELEMENT page EMPTY>

<!ATTLIST page

id CDATA #REQUIRED

name CDATA #REQUIRED

class CDATA #REQUIRED

icon CDATA #IMPLIED

subsystemconfigurationid CDATA #IMPLIED

subsystemconfigurationCategory CDATA #IMPLIED

systemTypes CDATA #IMPLIED

namefilter CDATA #IMPLIED

typecategoryfilter CDATA #IMPLIED

typefilter CDATA #IMPLIED

subtypefilter CDATA #IMPLIED

subsubtypefilter CDATA #IMPLIED>

Identifies an individual property page contribution.

id - a unique ID that will be used to identify this page.
name - a translatable name that will be used in the UI for this page.
class - a fully qualified name of the class that implements org.eclipse.ui.IWorkbenchPropertyPage. Or better yet, extends one of the supplied base classes, described in the API Information section.
icon - A relative path to an icon that will be used in the UI in addition to the page name. Optional.
subsystemconfigurationid - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a subsystem configuration id, such that this property page will only appear for remote resources returned from subsystems of the given subsystem configuration. This ID can be scalar, or it can be generic to match on multiple subsystem configuration IDs.
subsystemconfigurationCategory - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a subsystem configuration category, such that this property page will only appear for remote resources returned from subsystems owned by subsystem configurations declared defined with the specified category.
This category can be scalar, or it can be generic to match on multiple subsystem configuration categories. The categories of the Predefined subsystem configurations that display remote resources in the Remote Systems view are:
- files. For subsystems that list hierarchical file system resources, such as folders and files.
- nativefiles. For subsystems that list non-hierarchical file system resources, such as in the iSeries QSYS file system.
- commands. For subsystems that list remote commands.
- jobs. For subsystems that list remote jobs.
systemTypes - One of the optional filters to scope the remote resources for which the popup menu actions are to appear. Specify as many of these optional filters like this as needed to explicitly scope all the actions defined in this objectContribution element.
This filter specifies a single system type, or semicolon-separated list of system types, or asterisk for all system types (the default). Will scope these actions to only remote objects from systems of this type or types.
namefilter - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a simple or generic resource name. Only resources whose name matches this filter will show the property page defined within this page element.
typecategoryfilter - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a type category. Normally the subsystemconfigurationid is sufficient, but some subsystems display multiple types of resources, and these are categorized by a type name that can be used to scope property pages.
typefilter - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a resource type, either simple or generic. The resource types depends on the subsystem.
subtypefilter - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a simple or generic resource subtype to match. Not all subsystems support subtypes for their resources.
subsubtypefilter - One of the optional filters to scope the remote resources for which the property page is to appear. Specify as many of these optional filters like this as needed to explicitly scope this property page element.
This filter specifies a simple or generic resource sub-subtype to match.

The following is a simple example of a property page for files or folders in any remote system type:

Example One

<extension point=
"org.eclipse.rse.ui.propertyPages"
>
      <page 
            class=
"com.acme.myPropertyPage1"

            id=
"com.acme.mypropertypage1"

            name=
"Remote Folder and File Info"

            typecategoryfilter=
"files"
>
      </page>
</extension>

The following refines the first example so it only applies to files, versus folders, and only for local files:

Example Two

<extension point=
"org.eclipse.rse.ui.propertyPages"
>
      <page 
            class=
"com.acme.myPropertyPage2"

            id=
"com.acme.mypropertypage2"

            name=
"Remote File Info"

            typecategoryfilter=
"files"

            typefilter=
"file"

            subsystemconfigurationid=
"local.files"
>
      </page>
</extension>

The following refines the second example so it only applies to local Java files:

Example Three

<extension point=
"org.eclipse.rse.ui.propertyPages"
>
      <page 
            class=
"com.acme.myPropertyPage3"

            id=
"com.acme.mypropertypage3"

            name=
"Remote Java File Info"

            typecategoryfilter=
"files"

            typefilter=
"file"

            subsystemconfigurationid=
"local.files"

            namefilter=
"*.java"
>
      </page>
</extension>

Remember, you can repeat the page elements as needed, to define multiple property pages within the same extension configuration.

Your actions must all implement the interface org.eclipse.ui.IWorkbenchPropertyPage. Typically, you will subclass one of the supplied base classes for this extension point:

org.eclipse.rse.ui.propertypages.SystemAbstractPropertyPageExtensionAction, in plugin org.eclipse.rse.ui. Base class offering generic support for any remote resource property page, for any system type.
org.eclipse.rse.files.ui.propertypages.SystemAbstractRemoteFilePropertyPageExtensionAction, in plugin org.eclipse.rse.files.ui. Specialized base class offering specific support for any remote file or folder property page, for any system type.

There is no supplied implementation for this extension point.

Copyright (c) 2002, 2006 IBM Corporation. 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 Contributors: IBM Corporation - initial API and implementation

Property Pages

Identifier:

Description:

Configuration Markup:

Examples:

Example One

Example Two

Example Three

API Information:

Supplied Implementation: