P
- the IOProvider
type used in the wizardpublic abstract class IOWizard<P extends IOProvider>
extends org.eclipse.jface.wizard.Wizard
implements org.eclipse.jface.dialogs.IPageChangingListener
IOProvider
descriptorsConstructor and Description |
---|
IOWizard(Class<P> providerType)
Create an I/O wizard
|
Modifier and Type | Method and Description |
---|---|
void |
addIOWizardListener(IOWizardListener<P,? extends IOWizard<P>> listener)
Adds an
IOWizardListener |
void |
addPage(org.eclipse.jface.wizard.IWizardPage page) |
void |
addPages() |
boolean |
canFinish() |
void |
dispose() |
protected IOReport |
execute(IOProvider provider,
IOReporter defaultReporter)
Execute the given provider
|
protected String |
getActionId()
Get the action identifier
|
protected IOAdvisor<P> |
getAdvisor()
Get the I/O advisor
|
protected List<AbstractConfigurationPage<? extends P,? extends IOWizard<P>>> |
getConfigurationPages()
Get the list of configuration pages for the currently selected provider
factory
null if there are none. |
org.eclipse.core.runtime.content.IContentType |
getContentType()
Get the content type assigned to the wizard
|
List<IOProviderDescriptor> |
getFactories()
Get the available provider descriptors.
|
org.eclipse.jface.wizard.IWizardPage |
getNextPage(org.eclipse.jface.wizard.IWizardPage page) |
int |
getPageCount() |
org.eclipse.jface.wizard.IWizardPage |
getPreviousPage(org.eclipse.jface.wizard.IWizardPage page) |
P |
getProvider()
Get the provider assigned to the wizard.
|
IOProviderDescriptor |
getProviderFactory()
Get the provider descriptor assigned to the wizard.
|
Class<P> |
getProviderType()
Get the supported I/O provider type, usually an interface.
|
org.eclipse.jface.wizard.IWizardPage |
getStartingPage() |
void |
handlePageChanging(org.eclipse.jface.dialogs.PageChangingEvent event) |
boolean |
performFinish() |
void |
removeIOWizardListener(IOWizardListener<P,? extends IOWizard<P>> listener)
Removes an
IOWizardListener |
void |
setAdvisor(IOAdvisor<P> advisor,
String actionId)
Set the I/O advisor
|
void |
setContentType(org.eclipse.core.runtime.content.IContentType contentType)
Assign a content type to the wizard
|
void |
setProviderFactory(IOProviderDescriptor descriptor)
Assign an I/O provider factory to the wizard
|
protected void |
updateConfiguration(P provider)
Update the provider configuration.
|
protected boolean |
validatePage(org.eclipse.jface.wizard.IWizardPage page)
Validate the given page and update the I/O provider
|
createPageControls, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPages, getShell, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle
protected String getActionId()
public void setAdvisor(IOAdvisor<P> advisor, String actionId)
advisor
- the advisor to setactionId
- the action identifier, null
if it has nonepublic void addPages()
addPages
in interface org.eclipse.jface.wizard.IWizard
addPages
in class org.eclipse.jface.wizard.Wizard
Wizard.addPages()
public void handlePageChanging(org.eclipse.jface.dialogs.PageChangingEvent event)
handlePageChanging
in interface org.eclipse.jface.dialogs.IPageChangingListener
IPageChangingListener.handlePageChanging(PageChangingEvent)
public void dispose()
dispose
in interface org.eclipse.jface.wizard.IWizard
dispose
in class org.eclipse.jface.wizard.Wizard
Wizard.dispose()
public void addPage(org.eclipse.jface.wizard.IWizardPage page)
addPage
in class org.eclipse.jface.wizard.Wizard
Wizard.addPage(IWizardPage)
protected List<AbstractConfigurationPage<? extends P,? extends IOWizard<P>>> getConfigurationPages()
null
if there are none.public boolean canFinish()
canFinish
in interface org.eclipse.jface.wizard.IWizard
canFinish
in class org.eclipse.jface.wizard.Wizard
Wizard.canFinish()
public org.eclipse.jface.wizard.IWizardPage getNextPage(org.eclipse.jface.wizard.IWizardPage page)
getNextPage
in interface org.eclipse.jface.wizard.IWizard
getNextPage
in class org.eclipse.jface.wizard.Wizard
Wizard.getNextPage(IWizardPage)
public int getPageCount()
getPageCount
in interface org.eclipse.jface.wizard.IWizard
getPageCount
in class org.eclipse.jface.wizard.Wizard
Wizard.getPageCount()
public org.eclipse.jface.wizard.IWizardPage getPreviousPage(org.eclipse.jface.wizard.IWizardPage page)
getPreviousPage
in interface org.eclipse.jface.wizard.IWizard
getPreviousPage
in class org.eclipse.jface.wizard.Wizard
Wizard.getPreviousPage(IWizardPage)
public org.eclipse.jface.wizard.IWizardPage getStartingPage()
getStartingPage
in interface org.eclipse.jface.wizard.IWizard
getStartingPage
in class org.eclipse.jface.wizard.Wizard
Wizard.getStartingPage()
public List<IOProviderDescriptor> getFactories()
public P getProvider()
null
if
no page assigned a provider factory to the wizard yet.public void setProviderFactory(IOProviderDescriptor descriptor)
descriptor
- the provider factory to setpublic org.eclipse.core.runtime.content.IContentType getContentType()
null
public void setContentType(org.eclipse.core.runtime.content.IContentType contentType)
contentType
- the content type to setpublic IOProviderDescriptor getProviderFactory()
null
if no page assigned a provider factory to the wizard
yet.public boolean performFinish()
performFinish
in interface org.eclipse.jface.wizard.IWizard
performFinish
in class org.eclipse.jface.wizard.Wizard
true
if executing the I/O provider was successfulWizard.performFinish()
protected IOReport execute(IOProvider provider, IOReporter defaultReporter)
provider
- the I/O providerdefaultReporter
- the default reporter that is used if the provider
doesn't supply a reportprotected void updateConfiguration(P provider)
provider
- the I/O providerprotected boolean validatePage(org.eclipse.jface.wizard.IWizardPage page)
page
- the wizard page to validatepublic Class<P> getProviderType()
public void addIOWizardListener(IOWizardListener<P,? extends IOWizard<P>> listener)
IOWizardListener
listener
- the listener to addpublic void removeIOWizardListener(IOWizardListener<P,? extends IOWizard<P>> listener)
IOWizardListener
listener
- the listener to removeBuild 2013-10-07_11-27-38
Revision 99b27713a799a59a21b0b166eaaea8aaefbf125a