|
Eclipse JDT Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ltk.ui.refactoring.RefactoringWizardOpenOperation
A helper class to open a refactoring wizard dialog. The class first checks the initial conditions of the refactoring and depending on its outcome the wizard dialog or an error dialog is shown.
Note: this class is not intended to be extended by clients.
Field Summary | |
static int |
INITIAL_CONDITION_CHECKING_FAILED
Constant (value 1025) indicating that the precondition check failed when opening a refactoring wizard dialog. |
Constructor Summary | |
RefactoringWizardOpenOperation(RefactoringWizard wizard)
Creates a new refactoring wizard starter for the given wizard. |
Method Summary | |
RefactoringStatus |
getInitialConditionCheckingStatus()
Returns the outcome of the initial condition checking. |
int |
run(org.eclipse.swt.widgets.Shell parent,
String dialogTitle)
Opens the refactoring dialog for the refactoring wizard passed to the constructor. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int INITIAL_CONDITION_CHECKING_FAILED
run(Shell, String)
,
Constant Field ValuesConstructor Detail |
public RefactoringWizardOpenOperation(RefactoringWizard wizard)
wizard
- the wizard to open a dialog forMethod Detail |
public RefactoringStatus getInitialConditionCheckingStatus()
null
if the condition checking hasn't been performed yetpublic int run(org.eclipse.swt.widgets.Shell parent, String dialogTitle) throws InterruptedException
RefactoringStatus.FATAL
then
a message dialog is opened containing the corresponding status message. No wizard
dialog is opened in this situation. If the condition checking passes then the
refactoring dialog is opened.
parent
- the parent shell for the dialog or null
if the dialog
is a top level dialogdialogTitle
- the dialog title of the message box presenting the failed
condition check (if any)
INITIAL_CONDITION_CHECKING_FAILED
if the initial condition checking
failed and no wizard dialog was presented. Otherwise either IDialogConstants.OK_ID
or IDialogConstants.CANCEL_ID
is returned depending on whether the user
has pressed the OK or cancel button on the wizard dialog.
InterruptedException
- if the initial condition checking got cancelled by
the user.
|
Eclipse JDT Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |