|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.wizard.Wizard
org.eclipse.team.ui.synchronize.ParticipantSynchronizeWizard
public abstract class ParticipantSynchronizeWizard
This is a convenience class for creating wizards for use with the
org.eclipse.team.ui.synchronizeWizard extension point.
| Field Summary |
|---|
| Fields inherited from class org.eclipse.jface.wizard.Wizard |
|---|
DEFAULT_IMAGE |
| Constructor Summary | |
|---|---|
protected |
ParticipantSynchronizeWizard()
Create the wizard. |
| Method Summary | |
|---|---|
void |
addPages()
The Wizard implementation of this IWizard
method does nothing. |
boolean |
canFinish()
Returns whether this wizard could be finished without further user interaction. |
protected abstract void |
createParticipant()
Method called from performFinish() to create
a participant. |
protected abstract WizardPage |
createScopeSelectionPage()
Create the page which allows the user to select the scope for the operation. |
protected abstract IWizard |
getImportWizard()
Return a wizard that can be used to populate the workspace if there are no resources returned from getRootResources(). |
IWizardPage |
getNextPage(IWizardPage page)
Returns the successor of the given page. |
protected abstract String |
getPageTitle()
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. |
IWizardPage |
getStartingPage()
Returns the first page to be shown in this wizard. |
String |
getWindowTitle()
Returns the window title string for this wizard. |
boolean |
performCancel()
The Wizard implementation of this IWizard
method does nothing and returns true. |
boolean |
performFinish()
Subclasses must implement this IWizard 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, getPage, getPageCount, getPages, getPreviousPage, getShell, getTitleBarColor, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected ParticipantSynchronizeWizard()
| Method Detail |
|---|
public String getWindowTitle()
IWizard
getWindowTitle in interface IWizardgetWindowTitle in class Wizardnull for no titlepublic void addPages()
WizardWizard implementation of this IWizard
method does nothing. Subclasses should extend if extra pages need to be
added before the wizard opens. New pages should be added by calling
addPage.
addPages in interface IWizardaddPages in class Wizardpublic boolean performFinish()
WizardIWizard method to perform
any special finish processing for their wizard.
performFinish in interface IWizardperformFinish in class Wizardtrue to indicate the finish request
was accepted, and false to indicate
that the finish request was refusedpublic IWizardPage getNextPage(IWizardPage page)
IWizardThis method is typically called by a wizard page
getNextPage in interface IWizardgetNextPage in class Wizardpage - the page
null if nonepublic boolean performCancel()
WizardWizard implementation of this IWizard
method does nothing and returns true. Subclasses should
reimplement this method if they need to perform any special cancel
processing for their wizard.
performCancel in interface IWizardperformCancel in class Wizardtrue to indicate the cancel request
was accepted, and false to indicate
that the cancel request was refusedpublic boolean canFinish()
IWizardThe result of this method is typically used by the wizard container to enable or disable the Finish button.
canFinish in interface IWizardcanFinish in class Wizardtrue if the wizard could be finished,
and false otherwisepublic IWizardPage getStartingPage()
IWizard
getStartingPage in interface IWizardgetStartingPage in class Wizardprotected abstract String getPageTitle()
protected abstract IWizard getImportWizard()
getRootResources().
protected abstract IResource[] getRootResources()
protected abstract WizardPage createScopeSelectionPage()
protected abstract void createParticipant()
performFinish() to create
a participant. This participant will be added to the
Synchronize view.
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.