Package org.eclipse.jdt.ui.wizards
Interface IClasspathContainerPage
-
- All Superinterfaces:
IDialogPage
,IWizardPage
public interface IClasspathContainerPage extends IWizardPage
A classpath container page allows the user to create a new or edit an existing classpath container entry.Clients should implement this interface and include the name of their class in an extension contributed to the jdt.ui's classpath container page extension point (named
org.eclipse.jdt.ui.classpathContainerPage
).Clients implementing this interface may subclass from
Clients implementing this interface may also implementorg.eclipse.jface.wizard.WizardPage
.IClasspathContainerPageExtension
to get additional context before this page is opened.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
finish()
Called when the classpath container wizard is closed by selecting the finish button.IClasspathEntry
getSelection()
Returns the edited or created classpath container entry.void
setSelection(IClasspathEntry containerEntry)
Sets the classpath container entry to be edited ornull
if a new entry should be created.-
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
-
Methods inherited from interface org.eclipse.jface.wizard.IWizardPage
canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard
-
-
-
-
Method Detail
-
finish
boolean finish()
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 classpath entry returned in getSelection) into its model.- Returns:
- if the operation was successful. Only when returned
true
, the wizard will close.
-
getSelection
IClasspathEntry getSelection()
Returns the edited or created classpath container entry. This method may returnnull
if no classpath container entry exists. The returned classpath entry is of kindIClasspathEntry.CPE_CONTAINER
.- Returns:
- the classpath entry edited or created on the page.
-
setSelection
void setSelection(IClasspathEntry containerEntry)
Sets the classpath container entry to be edited ornull
if a new entry should be created.- Parameters:
containerEntry
- the classpath entry to edit ornull
. If notnull
then the classpath entry must be of kindIClasspathEntry.CPE_CONTAINER
-
-