Package org.eclipse.team.ui.synchronize
Class ParticipantSynchronizeWizard
- java.lang.Object
-
- org.eclipse.jface.wizard.Wizard
-
- org.eclipse.team.ui.synchronize.ParticipantSynchronizeWizard
-
- All Implemented Interfaces:
IShellProvider,IWizard
- Direct Known Subclasses:
ModelParticipantWizard,SubscriberParticipantWizard
public abstract class ParticipantSynchronizeWizard extends Wizard
This is a convenience class for creating wizards for use with theorg.eclipse.team.ui.synchronizeWizardextension point.- Since:
- 3.2
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.wizard.Wizard
DEFAULT_IMAGE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedParticipantSynchronizeWizard()Create the wizard.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddPages()TheWizardimplementation of thisIWizardmethod does nothing.booleancanFinish()Returns whether this wizard could be finished without further user interaction.protected abstract voidcreateParticipant()Method called fromperformFinish()to create a participant.protected abstract WizardPagecreateScopeSelectionPage()Create the page which allows the user to select the scope for the operation.protected abstract IWizardgetImportWizard()Return a wizard that can be used to populate the workspace if there are no resources returned fromgetRootResources().IWizardPagegetNextPage(IWizardPage page)Returns the successor of the given page.protected abstract StringgetPageTitle()Return the page title for the page used by this wizard.protected abstract IResource[]getRootResources()Return the resources that are the roots of the resource trees that can be considered for inclusion.IWizardPagegetStartingPage()Returns the first page to be shown in this wizard.StringgetWindowTitle()Returns the window title string for this wizard.booleanperformCancel()TheWizardimplementation of thisIWizardmethod does nothing and returnstrue.booleanperformFinish()Subclasses must implement thisIWizardmethod to perform any special finish processing for their wizard.-
Methods inherited from class org.eclipse.jface.wizard.Wizard
addPage, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPages, getPreviousPage, getShell, getTitleBarColor, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle
-
-
-
-
Method Detail
-
getWindowTitle
public String getWindowTitle()
Description copied from interface:IWizardReturns the window title string for this wizard.- Specified by:
getWindowTitlein interfaceIWizard- Overrides:
getWindowTitlein classWizard- Returns:
- the window title string, or
nullfor no title
-
addPages
public void addPages()
Description copied from class:WizardTheWizardimplementation of thisIWizardmethod does nothing. Subclasses should extend if extra pages need to be added before the wizard opens. New pages should be added by callingaddPage.
-
performFinish
public boolean performFinish()
Description copied from class:WizardSubclasses must implement thisIWizardmethod to perform any special finish processing for their wizard.- Specified by:
performFinishin interfaceIWizard- Specified by:
performFinishin classWizard- Returns:
trueto indicate the finish request was accepted, andfalseto indicate that the finish request was refused
-
getNextPage
public IWizardPage getNextPage(IWizardPage page)
Description copied from interface:IWizardReturns the successor of the given page.This method is typically called by a wizard page
- Specified by:
getNextPagein interfaceIWizard- Overrides:
getNextPagein classWizard- Parameters:
page- the page- Returns:
- the next page, or
nullif none
-
performCancel
public boolean performCancel()
Description copied from class:WizardTheWizardimplementation of thisIWizardmethod does nothing and returnstrue. Subclasses should reimplement this method if they need to perform any special cancel processing for their wizard.- Specified by:
performCancelin interfaceIWizard- Overrides:
performCancelin classWizard- Returns:
trueto indicate the cancel request was accepted, andfalseto indicate that the cancel request was refused
-
canFinish
public boolean canFinish()
Description copied from interface:IWizardReturns whether this wizard could be finished without further user interaction.The result of this method is typically used by the wizard container to enable or disable the Finish button.
-
getStartingPage
public IWizardPage getStartingPage()
Description copied from interface:IWizardReturns the first page to be shown in this wizard.- Specified by:
getStartingPagein interfaceIWizard- Overrides:
getStartingPagein classWizard- Returns:
- the first wizard page
-
getPageTitle
protected abstract String getPageTitle()
Return the page title for the page used by this wizard.- Returns:
- the page title for the page used by this wizard
-
getImportWizard
protected abstract IWizard getImportWizard()
Return a wizard that can be used to populate the workspace if there are no resources returned fromgetRootResources().- Returns:
- a wizard that can be used to populate the workspace
-
getRootResources
protected abstract IResource[] getRootResources()
Return the resources that are the roots of the resource trees that can be considered for inclusion.- Returns:
- the resources that are the roots of the resource trees that can be considered for inclusion
-
createScopeSelectionPage
protected abstract WizardPage createScopeSelectionPage()
Create the page which allows the user to select the scope for the operation.- Returns:
- the page which allows the user to select the scope for the operation
-
createParticipant
protected abstract void createParticipant()
Method called fromperformFinish()to create a participant. This participant will be added to the Synchronize view.
-
-