org.eclipse.cdt.ui.wizards
Interface ICPathContainerPage

All Superinterfaces:
org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.wizard.IWizardPage

Deprecated. - use IPathEntryContainerPage

public interface ICPathContainerPage
extends org.eclipse.jface.wizard.IWizardPage

A path container page allows the user to create a new or edit an existing patch container entry.

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 org.eclipse.cdt.ui.pathContainerPage ).

Clients implementing this interface may subclass from org.eclipse.jface.wizard.WizardPage.


Method Summary
 boolean finish()
          Deprecated. Called when the classpath container wizard is closed by selecting the finish button.
 org.eclipse.cdt.core.model.IPathEntry[] getContainerEntries()
          Deprecated.  
 void initialize(org.eclipse.cdt.core.model.ICProject project, org.eclipse.cdt.core.model.IPathEntry[] currentEntries)
          Deprecated. Method initialize() is called before ICPathContainerPage.setSelection to give additional information about the context the path container entry is configured in.
 void setSelection(org.eclipse.cdt.core.model.IPathEntry containerEntry)
          Deprecated. Sets the path container entry to be edited or null if a new entry should be created.
 
Methods inherited from interface org.eclipse.jface.wizard.IWizardPage
canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
 

Method Detail

initialize

void initialize(org.eclipse.cdt.core.model.ICProject project,
                org.eclipse.cdt.core.model.IPathEntry[] currentEntries)
Deprecated. 
Method initialize() is called before ICPathContainerPage.setSelection 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.

Parameters:
project - The project the new or modified entry is added to. The project does not have to exist. Project can be null.
currentEntries - The class path entries currently selected to be set as the projects classpath. This can also include the entry to be edited.

finish

boolean finish()
Deprecated. 
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.

Returns:
if the operation was succesful. Only when returned true, the wizard will close.

getContainerEntries

org.eclipse.cdt.core.model.IPathEntry[] getContainerEntries()
Deprecated. 
Returns:
the classpath entries created on the page.

setSelection

void setSelection(org.eclipse.cdt.core.model.IPathEntry containerEntry)
Deprecated. 
Sets the path container entry to be edited or null if a new entry should be created.

Parameters:
containerEntry - the classpath entry to edit or null. If unequals null then the classpath entry must be of kind IClasspathEntry.CPE_CONTAINER