KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > ui > wizards > IClasspathContainerPage


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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.jdt.ui.wizards;
12
13 import org.eclipse.jface.wizard.IWizardPage;
14
15 import org.eclipse.jdt.core.IClasspathEntry;
16
17 /**
18  * A classpath container page allows the user to create a new or edit an
19  * existing classpath container entry.
20  * <p>
21  * Clients should implement this interface and include the name of their
22  * class in an extension contributed to the jdt.ui's classpath container page
23  * extension point (named <code>org.eclipse.jdt.ui.classpathContainerPage
24  * </code>).
25  * </p>
26  * <p>
27  * Clients implementing this interface may subclass from
28  * <code>org.eclipse.jface.wizard.WizardPage</code>.
29  * </p>
30  * Clients implementing this interface may also implement
31  * <code>IClasspathContainerPageExtension</code> to get additional context
32  * before this page is opened.
33  *
34  * @since 2.0
35  */
36 public interface IClasspathContainerPage extends IWizardPage {
37     
38     /**
39      * Called when the classpath container wizard is closed by selecting
40      * the finish button. Implementers typically override this method to
41      * store the page result (new/changed classpath entry returned in
42      * getSelection) into its model.
43      *
44      * @return if the operation was successful. Only when returned
45      * <code>true</code>, the wizard will close.
46      */
47     public boolean finish();
48     
49     /**
50      * Returns the edited or created classpath container entry. This method
51      * may return <code>null</code> if no classpath container entry exists.
52      * The returned classpath entry is of kind <code>IClasspathEntry.CPE_CONTAINER
53      * </code>.
54      *
55      * @return the classpath entry edited or created on the page.
56      */
57     public IClasspathEntry getSelection();
58     
59     /**
60      * Sets the classpath container entry to be edited or <code>null</code>
61      * if a new entry should be created.
62      *
63      * @param containerEntry the classpath entry to edit or <code>null</code>.
64      * If not <code>null</code> then the classpath entry must be of
65      * kind <code>IClasspathEntry.CPE_CONTAINER</code>
66      */
67     public void setSelection(IClasspathEntry containerEntry);
68         
69 }
70
Popular Tags