|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.eclipse.ltk.ui.refactoring.RefactoringWizardPage
public abstract class RefactoringWizardPage
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.
RefactoringWizard,
Refactoring| Field Summary | |
|---|---|
static java.lang.String |
REFACTORING_SETTINGS
|
| 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. |
protected |
RefactoringWizardPage(java.lang.String name,
boolean wizard)
Creates a new refactoring wizard page. |
| Method Summary | |
|---|---|
protected Refactoring |
getRefactoring()
Returns the refactoring associated with this wizard page. |
protected 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(IWizard newWizard)
Sets the wizard that hosts this wizard page. 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 |
|---|
public static final java.lang.String REFACTORING_SETTINGS
| Constructor Detail |
|---|
protected RefactoringWizardPage(java.lang.String name,
boolean wizard)
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 otherwiseIWizardPage.getName()protected RefactoringWizardPage(java.lang.String name)
name - the page's name.IWizardPage.getName()| Method Detail |
|---|
public void setWizard(IWizard newWizard)
RefactoringWizard.
setWizard in interface IWizardPagesetWizard in class WizardPagenewWizard - the wizardIWizardPage.getWizard()protected Refactoring getRefactoring()
null if the page isn't been added to any refactoring
wizard yet.
nullprotected RefactoringWizard getRefactoringWizard()
null if the
wizard hasn't been set yetprotected boolean performFinish()
true to indicate the finish request was accepted,
and false to indicate that the finish request was
refusedprotected IDialogSettings getRefactoringSettings()
null
if no settings are associated with the refactoring wizard dialog
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.