Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.ltk.ui.refactoring
Class RefactoringWizardPage  view RefactoringWizardPage download RefactoringWizardPage.java

java.lang.Object
  extended byorg.eclipse.jface.dialogs.DialogPage
      extended byorg.eclipse.jface.wizard.WizardPage
          extended byorg.eclipse.ltk.ui.refactoring.RefactoringWizardPage
All Implemented Interfaces:
org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
Direct Known Subclasses:
UserInputWizardPage

public abstract class RefactoringWizardPage
extends org.eclipse.jface.wizard.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.


Field Summary
static java.lang.String REFACTORING_SETTINGS
           
 
Fields inherited from class org.eclipse.jface.wizard.WizardPage
 
Fields inherited from class org.eclipse.jface.dialogs.DialogPage
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
protected RefactoringWizardPage(java.lang.String name)
          Creates a new refactoring wizard page.
 
Method Summary
protected  org.eclipse.ltk.core.refactoring.Refactoring getRefactoring()
          Returns the refactoring associated with this wizard page.
protected  org.eclipse.jface.dialogs.IDialogSettings getRefactoringSettings()
          Returns the refactoring wizard's dialog settings.
protected  RefactoringWizard getRefactoringWizard()
          Returns the page's refactoring wizard.
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.
 void setWizard(org.eclipse.jface.wizard.IWizard newWizard)
          null This method asserts that the wizard passed as a parameter is of type RefactoringWizard.
 
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, toString
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible
 

Field Detail

REFACTORING_SETTINGS

public static final java.lang.String REFACTORING_SETTINGS
See Also:
Constant Field Values
Constructor Detail

RefactoringWizardPage

protected RefactoringWizardPage(java.lang.String name)
Creates a new refactoring wizard page.

Method Detail

setWizard

public void setWizard(org.eclipse.jface.wizard.IWizard newWizard)
null This method asserts that the wizard passed as a parameter is of type RefactoringWizard.


getRefactoring

protected org.eclipse.ltk.core.refactoring.Refactoring getRefactoring()
Returns the refactoring associated with this wizard page. Returns null if the page isn't been added to any refactoring wizard yet.


getRefactoringWizard

protected RefactoringWizard getRefactoringWizard()
Returns the page's refactoring wizard.


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.


getRefactoringSettings

protected org.eclipse.jface.dialogs.IDialogSettings getRefactoringSettings()
Returns the refactoring wizard's dialog settings.