KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > dialogs > IWorkingSetPage


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui.dialogs;
12
13 import org.eclipse.jface.wizard.IWizardPage;
14 import org.eclipse.ui.IWorkingSet;
15
16 /**
17  * A working set page allows the user to edit an existing
18  * working set and create a new working set.
19  * <p>
20  * Clients should implement this interface and include the
21  * name of their class in an extension contributed to the
22  * workbench's working set extension point
23  * (named <code>"org.eclipse.ui.workingSets"</code>) if they
24  * want to provide a special wizard page for a particular
25  * working set element type.
26  * </p>
27  * <p>
28  * Clients implementing this interface may subclass from
29  * org.eclipse.jface.wizard.WizardPage.
30  * </p>
31  *
32  * @since 2.0
33  */
34 public interface IWorkingSetPage extends IWizardPage {
35     /**
36      * Called when the working set wizard is closed by selecting
37      * the finish button.
38      * Implementers may store the page result (new/changed working
39      * set returned in getSelection) here.
40      */
41     public void finish();
42
43     /**
44      * Returns the working set edited or created on the page
45      * after the wizard has closed.
46      * Returns the working set that was initially set using
47      * <code>setSelection</code>if the wizard has not been
48      * closed yet.
49      * Implementors should return the object set in setSelection
50      * instead of making a copy and returning the changed copy.
51      *
52      * @return the working set edited or created on the page.
53      */
54     public IWorkingSet getSelection();
55
56     /**
57      * Sets the working set edited on the page.
58      * Implementors should not make a copy of this working set.
59      * The passed object can be edited as is and should be
60      * returned in getSelection().
61      *
62      * @param workingSet the working set edited on the page.
63      */
64     public void setSelection(IWorkingSet workingSet);
65 }
66
Popular Tags