| <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> | |
| <html> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | |
| <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> | |
| <title>Eclipse Workbench Extension Point: Working Sets</title> | |
| </head> | |
| <body link="#0000FF" vlink="#800080"> | |
| <center> | |
| <h1> | |
| Working Sets</h1></center> | |
| <b><i>Identifier: </i></b>org.eclipse.ui.workingSets | |
| <p><b><i>Description: </i></b> | |
| This extension point is used to define a working set wizard page. Working sets | |
| contain a number of elements of type IAdaptable and can be used to group | |
| elements for presentation to the user or for operations on a set of elements. A | |
| working set wizard page is used to create and edit working sets that contain elements | |
| of a specific type.<p>The workbench provides menu items to select a working set | |
| for the current page and to clear the currently set working set from the page. | |
| To select a working set the user is presented with a list of working sets that | |
| exist in the workbench. From that list a working set can be selected and edited | |
| using one of the wizard pages defined using this extension point. An existing | |
| working set is always edited with the wizard page that was used to create it or | |
| with the default resource based working set page if the original page is not | |
| available.<p>A new working set can be defined by the user from the same working | |
| set selection dialog. When a new working set is defined, the plugin provided | |
| wizard page is preceded by a page listing all available working set types. This | |
| list is made up of the <code>name</code> attribute values of each working set | |
| extension. <p>The working set selection dialog may also be opened | |
| programmatically.<p> The resource | |
| navigator uses the active page working set to filter elements from the navigator | |
| view. Only parents and children of working set elements are shown in the view, | |
| in addition to the working set elements themselves. | |
| <p><b><i>Since:</i></b> Release 2.0 | |
| <p><b><i>Configuration Markup:</i></b> | |
| <p><tt> <!ELEMENT workingSet EMPTY></tt> | |
| <br><tt> <!ATTLIST workingSet</tt> | |
| <br><tt> id CDATA #REQUIRED</tt> | |
| <br><tt> name | |
| CDATA #REQUIRED</tt> | |
| <br><tt> pageClass CDATA #REQUIRED</tt> | |
| <br><tt> ></tt> | |
| <ul> | |
| <li> | |
| <b>id -</b> a unique name that can be used to identify this working set dialog.</li> | |
| <li> | |
| <b>name</b> - the name of the element type that the working set dialog displays and edits. | |
| This should be a descriptive name like "Resource" or "Java | |
| Element".</li> | |
| <li> | |
| <b>pageClass</b> - the fully qualified name of a Java class implementing | |
| org.eclipse.ui.dialogs.IWorkingSetPage.</li> | |
| </ul> | |
| <b><i>Examples:</i></b> | |
| <p>Following is an example of the how the resource working set dialog extension | |
| is defined to display and edit generic IResource elements.: | |
| <p><code> <extension point="org.eclipse.ui.workingSets"><br> | |
| <workingSet<br> | |
| id="org.eclipse.ui.resourceWorkingSetPage"<br> | |
| | |
| name="Resource"<br> | |
| pageClass="org.eclipse.ui.internal.dialogs.ResourceWorkingSetPage"><br> | |
| </workingSet><br> | |
| </extension></code><p><b><i>API Information</i>: </b>The value of the | |
| <code>pageClass</code> attribute must represent a class that implements the <tt>org.eclipse.ui.dialogs.IWorkingSetPage</tt> | |
| interface. | |
| <p><b><i>Supplied Implementation: </i></b>The workbench provides a working set | |
| wizard page for creating and editing resource based working sets. | |
| <p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2001. All Rights Reserved." BORDER=0 height=12 width=195></a> | |
| </body> | |
| </html> |