Package com.intellij.refactoring.ui

Class RefactoringDialog

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.refactoring.ui.RefactoringDialog

Direct Known Subclasses:

AbstractIntroduceParameterObjectDialog, AbstractMakeStaticDialog, AbstractPushDownDialog, ChangeClassSignatureDialog, ChangeSignatureDialogBase, CopyFilesOrDirectoriesDialog, EncapsulateFieldsDialog, ExtractMethodDialog, ExtractSuperBaseDialog, InheritanceToDelegationDialog, InlineOptionsDialog, InlineParameterDialog, IntroduceParameterDialog, InvertBooleanDialog, MembersBasedViewSwingImpl, MoveDialogBase, MoveFilesOrDirectoriesDialog, PullUpDialogBase, PyBaseMoveDialog, RemoveMiddlemanDialog, RenameDialog, ReplaceConstructorWithBuilderDialog, ReplaceConstructorWithFactoryDialog, TurnRefsToSuperDialog, TypeCookDialog, TypeMigrationDialog, XmlTagRenameDialog

public abstract class RefactoringDialog
extends DialogWrapper

Author: msk

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.ui.DialogWrapper

DialogWrapper.CancelAction, DialogWrapper.DialogStyle, DialogWrapper.DialogWrapperAction, DialogWrapper.DialogWrapperExitAction, DialogWrapper.DoNotAskOption, DialogWrapper.IdeModalityType, DialogWrapper.OkAction

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject

Fields inherited from class com.intellij.openapi.ui.DialogWrapper

CANCEL_EXIT_CODE, CLOSE_EXIT_CODE, DEFAULT_ACTION, DIALOG_CONTENT_PANEL_PROPERTY, ERROR_FOREGROUND_COLOR, FOCUSED_ACTION, IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY, myCancelAction, myCheckBoxDoNotShowDialog, myDisposable, myHelpAction, myOKAction, myPerformAction, myPreferredFocusedComponent, NEXT_USER_EXIT_CODE, OK_EXIT_CODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefactoringDialog(Project project, boolean canBeParent)
protected	RefactoringDialog(Project project, boolean canBeParent, boolean addOpenInEditorCheckbox)

Method Summary

Modifier and Type	Method and Description
protected void	addOpenInEditorCheckbox() Must be called before DialogWrapper.init().
protected boolean	areButtonsValid()
protected void	canRun()
protected void	closeOKAction()
protected javax.swing.Action []	createActions() Creates actions for dialog.
protected void	createDefaultActions()
protected abstract void	doAction()
protected void	doOKAction() This method is invoked by default implementation of "OK" action.
protected void	doRefactorAction()
protected javax.swing.Action	getPreviewAction()
protected Project	getProject()
protected javax.swing.Action	getRefactorAction()
protected java.lang.String	getRefactoringId()
protected boolean	hasHelpAction()
protected boolean	hasPreviewButton()
protected void	invokeRefactoring(BaseRefactoringProcessor processor)
boolean	isOpenInEditor()
boolean	isPreviewUsages()
protected void	setHelpTooltip(javax.swing.JButton helpButton)
void	setPreviewResults(boolean previewResults)
void	show() Show the dialog.
protected void	validateButtons()

Methods inherited from class com.intellij.openapi.ui.DialogWrapper

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createButtonsPanel, createCancelAction, createCenterPanel, createContentPane, createContentPaneBorder, createDefaultBorder, createDoNotAskCheckbox, createHelpButton, createJButtonForAction, createJButtonForAction, createLeftSideActions, createNorthPanel, createPeer, createPeer, createPeer, createPeer, createPeer, createPeer, createRootLayout, createSouthAdditionalPanel, createSouthPanel, createTitlePane, dispose, disposeIfNeeded, doCancelAction, doCancelAction, doHelpAction, doValidate, doValidateAll, extractMnemonic, findInstance, findInstanceFromFocus, getButton, getCancelAction, getContentPane, getContentPanel, getDimensionKey, getDimensionServiceKey, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHelpId, getHorizontalStretch, getInitialLocation, getLocation, getOKAction, getOwner, getPeer, getPreferredFocusedComponent, getPreferredSize, getRootPane, getSize, getStyle, getTitle, getTypeAheadTimeoutMs, getValidationThreadToUse, getVerticalStretch, getWindow, hasErrors, init, initValidation, isAutoAdjustable, isCenterStrictedToPreferredSize, isDisposed, isModal, isModalProgress, isMoveHelpButtonLeft, isNorthStrictedToPreferredSize, isOK, isOKActionEnabled, isProgressDialog, isResizable, isShowing, isSouthStrictedToPreferredSize, isToDispatchTypeAhead, isTypeAheadEnabled, isVisible, layoutButtonsPanel, pack, postponeValidation, processDoNotAskOnOk, repaint, setAutoAdjustable, setButtonsAlignment, setButtonsMargin, setCancelButtonIcon, setCancelButtonText, setCrossClosesWindow, setDoNotAskOption, setErrorInfoAll, setErrorText, setErrorText, setHorizontalStretch, setInitialLocationCallback, setLocation, setLocation, setModal, setOKActionEnabled, setOKButtonIcon, setOKButtonMnemonic, setOKButtonText, setOKButtonTooltip, setResizable, setSize, setTitle, setUndecorated, setValidationDelay, setVerticalStretch, shouldAddErrorNearButtons, shouldCloseOnCross, showAndGet, showAndGetOk, startTrackingValidation, toBack, toBeShown, toFront, unregisterKeyboardActions, updateErrorInfo, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myProject

protected final Project myProject

Constructor Detail

RefactoringDialog

protected RefactoringDialog(Project project,
                            boolean canBeParent)

RefactoringDialog

protected RefactoringDialog(Project project,
                            boolean canBeParent,
                            boolean addOpenInEditorCheckbox)

Method Detail

addOpenInEditorCheckbox

protected void addOpenInEditorCheckbox()

Must be called before DialogWrapper.init().

getRefactoringId

protected java.lang.String getRefactoringId()

isOpenInEditor

public boolean isOpenInEditor()

isPreviewUsages

public final boolean isPreviewUsages()

setPreviewResults

public void setPreviewResults(boolean previewResults)

show

public void show()

Description copied from class: DialogWrapper

Show the dialog.

Overrides:

show in class DialogWrapper

See Also:

DialogWrapper.showAndGet()

createDefaultActions

protected void createDefaultActions()

Overrides:

createDefaultActions in class DialogWrapper

getRefactorAction

protected final javax.swing.Action getRefactorAction()

Returns:

default implementation of "Refactor" action.

getPreviewAction

protected final javax.swing.Action getPreviewAction()

Returns:

default implementation of "Preview" action.

doAction

protected abstract void doAction()

doRefactorAction

protected void doRefactorAction()

closeOKAction

protected final void closeOKAction()

doOKAction

protected final void doOKAction()

Description copied from class: DialogWrapper

This method is invoked by default implementation of "OK" action. It just closes dialog with OK_EXIT_CODE. This is convenient place to override functionality of "OK" action. Note that the method does nothing if "OK" action isn't enabled.

Overrides:

doOKAction in class DialogWrapper

areButtonsValid

protected boolean areButtonsValid()

canRun

protected void canRun()
               throws ConfigurationException

Throws:

ConfigurationException

setHelpTooltip

protected void setHelpTooltip(javax.swing.JButton helpButton)

Overrides:

setHelpTooltip in class DialogWrapper

validateButtons

protected void validateButtons()

hasHelpAction

protected boolean hasHelpAction()

hasPreviewButton

protected boolean hasPreviewButton()

createActions

protected javax.swing.Action [] createActions()

Description copied from class: DialogWrapper

Creates actions for dialog.

By default "OK" and "Cancel" actions are returned. The "Help" action is automatically added if DialogWrapper.getHelpId() returns non-null value.

Each action is represented by JButton created by DialogWrapper.createJButtonForAction(Action). These buttons are then placed into south panel of dialog.

Overrides:

createActions in class DialogWrapper

Returns:

dialog actions

See Also:

DialogWrapper.createSouthPanel(), DialogWrapper.createJButtonForAction(javax.swing.Action)

getProject

protected Project getProject()

invokeRefactoring

protected void invokeRefactoring(BaseRefactoringProcessor processor)