Class RefactoringWizardPage

All Implemented Interfaces:
IDialogPage, IMessageProvider, IWizardPage
Direct Known Subclasses:

public abstract class RefactoringWizardPage extends WizardPage
An abstract base implementation of a refactoring wizard page. The class provides access to the refactoring wizard and to the refactoring itself. Refactoring wizard pages can only be added to a RefactoringWizard. Adding them to a normal wizard result in an exception.

Note: this class is not intended to be subclassed by clients. Clients should extend UserInputWizardPage.

See Also:
This class is not intended to be subclassed by clients.
  • Field Details

  • Constructor Details

    • RefactoringWizardPage

      protected RefactoringWizardPage(String name, boolean wizard)
      Creates a new refactoring wizard page.

      Note: this constructor is not intended to be used outside the refactoring framework.

      name - the page's name.
      wizard - true if the page belongs to a conventional wizard, false otherwise
      See Also:
    • RefactoringWizardPage

      protected RefactoringWizardPage(String name)
      Creates a new refactoring wizard page.
      name - the page's name.
      See Also:
  • Method Details

    • setWizard

      public void setWizard(IWizard newWizard)
      Sets the wizard that hosts this wizard page. Once established, a page's wizard cannot be changed to a different wizard. This method asserts that the wizard passed as a parameter is of type RefactoringWizard.
      Specified by:
      setWizard in interface IWizardPage
      setWizard in class WizardPage
      newWizard - the wizard
      See Also:
    • getRefactoring

      protected Refactoring getRefactoring()
      Returns the refactoring associated with this wizard page. Returns null if the page isn't been added to any refactoring wizard yet.
      the refactoring associated with this refactoring wizard page or null
    • getRefactoringWizard

      protected RefactoringWizard getRefactoringWizard()
      Returns the page's refactoring wizard.
      the page's refactoring wizard or null if the wizard hasn't been set yet
    • performFinish

      protected boolean performFinish()
      Performs any actions appropriate in response to the user having pressed the Finish button, or refuse if finishing now is not permitted. This method is called by the refactoring wizard on the currently active refactoring wizard page.
      true to indicate the finish request was accepted, and false to indicate that the finish request was refused
    • getRefactoringSettings

      protected IDialogSettings getRefactoringSettings()
      Returns the refactoring wizard's dialog settings.
      the refactoring wizard's dialog settings or null if no settings are associated with the refactoring wizard dialog