|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Base interface for all wizards defined via workbench extension points.
This interface is not intended to be implemented by clients.
Method Summary | |
---|---|
IStructuredSelection |
adaptedSelection(IStructuredSelection selection)
Answer the selection for the reciever based on whether the it can handle the selection. |
boolean |
canFinishEarly()
Answer true if this wizard is able to finish without
loading any pages. |
IWorkbenchWizard |
createWizard()
Create a wizard. |
IWizardCategory |
getCategory()
Return the category for this wizard. |
String |
getDescription()
Return the description. |
ImageDescriptor |
getDescriptionImage()
Return the description image for this wizard. |
String |
getHelpHref()
Return the help system href for this wizard. |
String[] |
getTags()
Return the tags associated with this wizard. |
boolean |
hasPages()
Answer true if this wizard has any pages. |
Methods inherited from interface org.eclipse.ui.IWorkbenchPartDescriptor |
---|
getId, getImageDescriptor, getLabel |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Method Detail |
public IStructuredSelection adaptedSelection(IStructuredSelection selection)
selection
- IStructuredSelection
public String getDescription()
public String[] getTags()
public IWorkbenchWizard createWizard() throws CoreException
CoreException
- thrown if there is a problem creating the wizardpublic ImageDescriptor getDescriptionImage()
null
public String getHelpHref()
null
public IWizardCategory getCategory()
null
public boolean canFinishEarly()
true
if this wizard is able to finish without
loading any pages. This is a hint to any
WizardSelectionPage
or container that
may contain this wizard to allow the finish button to be pressed without
actually entering the wizard. If this occurs the
IWizard.performFinish()
method should be
invoked by the containing wizard without creating any pages.
true
if this wizard can finish immediatelypublic boolean hasPages()
true
if this wizard has any pages. This is a
hint to any WizardSelectionPage
or
container that may contain this wizard that they should enable the "Next"
button, if appropriate.
true
if this wizard has wizard pages
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.