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
This is a convenience class for creating wizards for use with the
org.eclipse.team.ui.synchronizeWizard
extension point.- Since:
- 3.2
-
Field Summary
Fields inherited from class org.eclipse.jface.wizard.Wizard
DEFAULT_IMAGE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addPages()
TheWizard
implementation of thisIWizard
method does nothing.boolean
Returns whether this wizard could be finished without further user interaction.protected abstract void
Method called fromperformFinish()
to create a participant.protected abstract WizardPage
Create the page which allows the user to select the scope for the operation.protected abstract IWizard
Return a wizard that can be used to populate the workspace if there are no resources returned fromgetRootResources()
.getNextPage
(IWizardPage page) Returns the successor of the given page.protected abstract String
Return the page title for the page used by this wizard.protected abstract IResource[]
Return the resources that are the roots of the resource trees that can be considered for inclusion.Returns the first page to be shown in this wizard.Returns the window title string for this wizard.boolean
TheWizard
implementation of thisIWizard
method does nothing and returnstrue
.boolean
Subclasses must implement thisIWizard
method to perform any special finish processing for their wizard.Methods inherited from class org.eclipse.jface.wizard.Wizard
addPage, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getMinimumWizardSize, getPage, getPageCount, getPages, getPreviousPage, getShell, getTitleBarColor, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle
-
Constructor Details
-
ParticipantSynchronizeWizard
protected ParticipantSynchronizeWizard()Create the wizard.
-
-
Method Details
-
getWindowTitle
Description copied from interface:IWizard
Returns the window title string for this wizard.- Specified by:
getWindowTitle
in interfaceIWizard
- Overrides:
getWindowTitle
in classWizard
- Returns:
- the window title string, or
null
for no title
-
addPages
public void addPages()Description copied from class:Wizard
TheWizard
implementation of thisIWizard
method 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:Wizard
Subclasses must implement thisIWizard
method to perform any special finish processing for their wizard.- Specified by:
performFinish
in interfaceIWizard
- Specified by:
performFinish
in classWizard
- Returns:
true
to indicate the finish request was accepted, andfalse
to indicate that the finish request was refused
-
getNextPage
Description copied from interface:IWizard
Returns the successor of the given page.This method is typically called by a wizard page
- Specified by:
getNextPage
in interfaceIWizard
- Overrides:
getNextPage
in classWizard
- Parameters:
page
- the page- Returns:
- the next page, or
null
if none
-
performCancel
public boolean performCancel()Description copied from class:Wizard
TheWizard
implementation of thisIWizard
method does nothing and returnstrue
. Subclasses should reimplement this method if they need to perform any special cancel processing for their wizard.- Specified by:
performCancel
in interfaceIWizard
- Overrides:
performCancel
in classWizard
- Returns:
true
to indicate the cancel request was accepted, andfalse
to indicate that the cancel request was refused
-
canFinish
public boolean canFinish()Description copied from interface:IWizard
Returns 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
Description copied from interface:IWizard
Returns the first page to be shown in this wizard.- Specified by:
getStartingPage
in interfaceIWizard
- Overrides:
getStartingPage
in classWizard
- Returns:
- the first wizard page
-
getPageTitle
Return the page title for the page used by this wizard.- Returns:
- the page title for the page used by this wizard
-
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
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
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.
-