Package org.eclipse.ltk.ui.refactoring
Class UserInputWizardPage
java.lang.Object
org.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.eclipse.ltk.ui.refactoring.RefactoringWizardPage
org.eclipse.ltk.ui.refactoring.UserInputWizardPage
- All Implemented Interfaces:
IDialogPage,IMessageProvider,IWizardPage
- Direct Known Subclasses:
RenameResourceWizard.RenameResourceRefactoringConfigurationPage
An abstract wizard page that is to be used to implement user input pages presented
inside a
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.
- Since:
- 3.0
-
Field Summary
Fields inherited from class org.eclipse.ltk.ui.refactoring.RefactoringWizardPage
REFACTORING_SETTINGSFields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanTheWizardPageimplementation of thisIWizardPagemethod returnstrueif this page is complete (isPageComplete) and there is a next page to flip to.protected final IWizardPageTriggers the refactoring's condition checking and returns either the error wizard page or a preview page, depending on the outcome of the precondition checking.Returns the wizard page that would to be shown if the user was to press the Next button.booleanReturnstrueif this is the last user input page in the stack of input pages;falseotherwise.protected booleanPerforms any actions appropriate in response to the user having pressed the Finish button, or refuse if finishing now is not permitted.voidsetPageComplete(RefactoringStatus status) Sets the page's complete status depending on the givenReactoringStatus.voidsetVisible(boolean visible) TheDialogPageimplementation of thisIDialogPagemethod sets the control to the given visibility state.Methods inherited from class org.eclipse.ltk.ui.refactoring.RefactoringWizardPage
getRefactoring, getRefactoringSettings, getRefactoringWizard, setWizardMethods inherited from class org.eclipse.jface.wizard.WizardPage
getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, toStringMethods 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, setMessageMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelpMethods inherited from interface org.eclipse.jface.wizard.IWizardPage
getMinimumPageSize
-
Constructor Details
-
UserInputWizardPage
Creates a new user input page.- Parameters:
name- the page's name.
-
-
Method Details
-
isLastUserInputPage
public boolean isLastUserInputPage()Returnstrueif this is the last user input page in the stack of input pages;falseotherwise. 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.- Returns:
- whether this is the last user input page or not.
-
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.- Returns:
- either the error or the preview page, depending on the refactoring's precondition checking
-
setPageComplete
Sets the page's complete status depending on the givenReactoringStatus.- Parameters:
status- theRefactoringStatus
-
setVisible
public void setVisible(boolean visible) Description copied from class:DialogPageTheDialogPageimplementation of thisIDialogPagemethod sets the control to the given visibility state. Subclasses may extend.- Specified by:
setVisiblein interfaceIDialogPage- Overrides:
setVisiblein classDialogPage- Parameters:
visible-trueto make this page visible, andfalseto hide it
-
getNextPage
Description copied from interface:IWizardPageReturns the wizard page that would to be shown if the user was to press the Next button.- Specified by:
getNextPagein interfaceIWizardPage- Overrides:
getNextPagein classWizardPage- Returns:
- the next wizard page, or
nullif none
-
canFlipToNextPage
public boolean canFlipToNextPage()Description copied from class:WizardPageTheWizardPageimplementation of thisIWizardPagemethod returnstrueif this page is complete (isPageComplete) and there is a next page to flip to. Subclasses may override (extend or reimplement).- Specified by:
canFlipToNextPagein interfaceIWizardPage- Overrides:
canFlipToNextPagein classWizardPage- Returns:
trueif the next page could be displayed, andfalseotherwise- See Also:
-
performFinish
protected boolean performFinish()Description copied from class:RefactoringWizardPagePerforms 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.- Overrides:
performFinishin classRefactoringWizardPage- Returns:
trueto indicate the finish request was accepted, andfalseto indicate that the finish request was refused
-