Package org.eclipse.ui.wizards

Interface IWizardDescriptor

All Superinterfaces:
IAdaptable, IWorkbenchPartDescriptor
public interface IWizardDescriptor extends IWorkbenchPartDescriptor, IAdaptable
Base interface for all wizards defined via workbench extension points.

This interface is not intended to be implemented by clients.

Since:
3.1
Restriction:
This interface is not intended to be implemented by clients.

  • Method Details

    • adaptedSelection

      IStructuredSelection adaptedSelection(IStructuredSelection selection)
      Answer the selection for the receiver based on whether the it can handle the selection. If it can return the selection. If it can handle the adapted to IResource value of the selection. If it satisfies neither of these conditions return an empty IStructuredSelection.
      Parameters:
      selection - IStructuredSelection
      Returns:
      IStructuredSelection

    • getDescription

      String getDescription()
      Return the description.
      Returns:
      the description

    • getTags

      String[] getTags()
      Return the tags associated with this wizard.
      Returns:
      the tags associated with this wizard

    • createWizard

      IWorkbenchWizard createWizard() throws CoreException
      Create a wizard.
      Returns:
      the wizard
      Throws:
      CoreException - thrown if there is a problem creating the wizard

    • getDescriptionImage

      ImageDescriptor getDescriptionImage()
      Return the description image for this wizard.
      Returns:
      the description image for this wizard or null

    • getHelpHref

      String getHelpHref()
      Return the help system href for this wizard.
      Returns:
      the help system href for this wizard or null

    • getCategory

      IWizardCategory getCategory()
      Return the category for this wizard.
      Returns:
      the category or null

    • canFinishEarly

      boolean canFinishEarly()
      Answer 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.
      Returns:
      true if this wizard can finish immediately

    • hasPages

      boolean hasPages()
      Answer 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.
      Returns:
      true if this wizard has wizard pages