|
Eclipse Platform Release 3.1 |
|||||||||||
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
org.eclipse.ltk.ui.refactoring.UserInputWizardPage
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.
Field Summary |
---|
Fields inherited from class org.eclipse.ltk.ui.refactoring.RefactoringWizardPage |
---|
REFACTORING_SETTINGS |
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
---|
ERROR, INFORMATION, NONE, WARNING |
Constructor Summary | |
---|---|
UserInputWizardPage(String name)
Creates a new user input page. |
Method Summary | |
---|---|
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. Subclasses may override (extend or reimplement). |
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()
|
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. This method is called by the refactoring wizard on the currently active refactoring wizard page. |
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. Subclasses may extend. |
Methods inherited from class org.eclipse.ltk.ui.refactoring.RefactoringWizardPage |
---|
getRefactoring, getRefactoringSettings, getRefactoringWizard, setWizard |
Methods inherited from class org.eclipse.jface.wizard.WizardPage |
---|
getContainer, getDialogSettings, getImage, getName, 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 |
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 |
Constructor Detail |
public UserInputWizardPage(String name)
name
- the page's name.Method Detail |
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
public IWizardPage getNextPage()
getNextPage
in interface IWizardPage
getNextPage
in class WizardPage
public 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
WizardPage.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
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.