Eclipse Platform
Release 3.8

org.eclipse.team.ui
Interface IScmUrlImportWizardPage

All Superinterfaces:
IDialogPage, IWizardPage

public interface IScmUrlImportWizardPage
extends IWizardPage

IScmUrlImportWizardPage defines the interface that users of the extension point org.eclipse.team.ui.scmUrlImportPages must implement. EXPERIMENTAL. This class has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the Team team.

Since:
3.6

Field Summary
static String ATT_EXTENSION
           
static String ATT_IMPORTER
           
static String ATT_PAGE
           
 
Method Summary
 boolean finish()
          Called when the import wizard is closed by selecting the finish button.
 ScmUrlImportDescription[] getSelection()
          Return the import descriptions for the page.
 void setSelection(ScmUrlImportDescription[] descriptions)
          Sets the import descriptions to be edited on the page.
 
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
 

Field Detail

ATT_EXTENSION

static final String ATT_EXTENSION
See Also:
Constant Field Values

ATT_PAGE

static final String ATT_PAGE
See Also:
Constant Field Values

ATT_IMPORTER

static final String ATT_IMPORTER
See Also:
Constant Field Values
Method Detail

finish

boolean finish()
Called when the import wizard is closed by selecting the finish button. Implementers may store the page result (new/changed bundle import descriptions in getSelection) here.

Returns:
if the operation was successful. The wizard will only close when true is returned.

getSelection

ScmUrlImportDescription[] getSelection()
Return the import descriptions for the page. The descriptions may differ from those initially set using setSelection(ScmUrlImportDescription[]) if the user modified the import configuration.

Returns:
the SCM URLs descriptions for the page or null if no selection has been set

setSelection

void setSelection(ScmUrlImportDescription[] descriptions)
Sets the import descriptions to be edited on the page. The passed descriptions can be edited and should be returned in getSelection().

Parameters:
descriptions - the SCM URLs descriptions edited on the page.

Eclipse Platform
Release 3.8

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2012. All rights reserved.