/*******************************************************************************
* Copyright (c) 2002, 2009 QNX Software Systems 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
*
* Contributors:
* QNX Software Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.ui.wizards;
import org.eclipse.cdt.core.model.ICProject;
import org.eclipse.cdt.core.model.IPathEntry;
import org.eclipse.jface.wizard.IWizardPage;
/**
* A path container page allows the user to create a new or edit an
* existing patch container entry.
* <p>
* Clients should implement this interface and include the name of their
* class in an extension contributed to the cdt.ui's path container page
* extension point (named <code>org.eclipse.cdt.ui.pathContainerPage
* </code>).
* </p>
* <p>
* Clients implementing this interface may subclass from
* <code>org.eclipse.jface.wizard.WizardPage</code>.
* </p>
*
* @deprecated - use IPathEntryContainerPage
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
@Deprecated
public interface ICPathContainerPage extends IWizardPage {
/**
* Method <code>initialize()</code> is called before <code>ICPathContainerPage.setSelection</code>
* to give additional information about the context the path container entry is configured in. This information
* only reflects the underlying dialogs current selection state. The user still can make changes after the
* the classpath container pages has been closed or decide to cancel the operation.
* @param project The project the new or modified entry is added to. The project does not have to exist.
* Project can be <code>null</code>.
* @param currentEntries The class path entries currently selected to be set as the projects classpath. This can also
* include the entry to be edited.
*/
public void initialize(ICProject project, IPathEntry[] currentEntries);
/**
* Called when the classpath container wizard is closed by selecting
* the finish button. Implementers typically override this method to
* store the page result (new/changed path entry returned in
* getSelection) into its model.
*
* @return if the operation was succesful. Only when returned
* <code>true</code>, the wizard will close.
*/
public boolean finish();
/**
* @return the classpath entries created on the page.
*/
public IPathEntry[] getContainerEntries();
/**
* Sets the path container entry to be edited or <code>null</code>
* if a new entry should be created.
*
* @param containerEntry the classpath entry to edit or <code>null</code>.
* If unequals <code>null</code> then the classpath entry must be of
* kind <code>IClasspathEntry.CPE_CONTAINER</code>
*/
public void setSelection(IPathEntry containerEntry);
}