public abstract class UserInputWizardPage extends RefactoringWizardPage
refactoring wizard
.
User input pages are shown at the beginning of a wizard. As soon as the last input
page is left the refactoring's condition checking is performed. Depending on the
outcome an error page or the preview page is shown.
Clients may extend this class.
REFACTORING_SETTINGS
ERROR, INFORMATION, NONE, WARNING
Constructor and Description |
---|
UserInputWizardPage(String name)
Creates a new user input page.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canFlipToNextPage()
The
WizardPage implementation of this IWizardPage
method returns true if this page is complete (isPageComplete )
and there is a next page to flip to. |
protected IWizardPage |
computeSuccessorPage()
Triggers the refactoring's condition checking and returns either the
error wizard page or a preview page, depending on the outcome of the
precondition checking.
|
IWizardPage |
getNextPage()
Returns the wizard page that would to be shown if the user was to
press the Next button.
|
boolean |
isLastUserInputPage()
Returns
true if this is the last user input page in the stack
of input pages; false otherwise. |
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 |
setPageComplete(RefactoringStatus status)
Sets the page's complete status depending on the given
ReactoringStatus.
|
void |
setVisible(boolean visible)
The
DialogPage implementation of this
IDialogPage method sets the control to the given
visibility state. |
getRefactoring, getRefactoringSettings, getRefactoringWizard, setWizard
getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, toString
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp
public UserInputWizardPage(String name)
name
- the page's name.public boolean isLastUserInputPage()
true
if this is the last user input page in the stack
of input pages; false
otherwise. The last user input page is not
necessarily the page after which the refactoring's precondition has to be
triggered. For wizards implementing a dynamic work flow, this may happen for
other pages as well.protected final IWizardPage computeSuccessorPage()
public void setPageComplete(RefactoringStatus status)
status
- the RefactoringStatuspublic void setVisible(boolean visible)
DialogPage
implementation of this
IDialogPage
method sets the control to the given
visibility state. Subclasses may extend.setVisible
in interface IDialogPage
setVisible
in class DialogPage
visible
- true
to make this page visible,
and false
to hide itpublic IWizardPage getNextPage()
getNextPage
in interface IWizardPage
getNextPage
in class WizardPage
null
if nonepublic boolean canFlipToNextPage()
WizardPage
implementation of this IWizardPage
method returns true
if this page is complete (isPageComplete
)
and there is a next page to flip to. Subclasses may override (extend or reimplement).canFlipToNextPage
in interface IWizardPage
canFlipToNextPage
in class WizardPage
true
if the next page could be displayed,
and false
otherwiseWizardPage.getNextPage()
,
WizardPage.isPageComplete()
protected boolean performFinish()
performFinish
in class RefactoringWizardPage
true
to indicate the finish request was accepted,
and false
to indicate that the finish request was
refused
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.