Package com.intellij.refactoring.changeSignature

Class ChangeSignatureDialogBase<ParamInfo extends ParameterInfo,Method extends PsiElement,Visibility,Descriptor extends MethodDescriptor<ParamInfo,Visibility>,ParameterTableModelItem extends ParameterTableModelItemBase<ParamInfo>,ParameterTableModel extends ParameterTableModelBase<ParamInfo,ParameterTableModelItem>>

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.refactoring.ui.RefactoringDialog

com.intellij.refactoring.changeSignature.ChangeSignatureDialogBase<ParamInfo,Method,Visibility,Descriptor,ParameterTableModelItem,ParameterTableModel>

Direct Known Subclasses:

GrChangeSignatureDialog, JavaChangeSignatureDialog, PyChangeSignatureDialog

public abstract class ChangeSignatureDialogBase<ParamInfo extends ParameterInfo,Method extends PsiElement,Visibility,Descriptor extends MethodDescriptor<ParamInfo,Visibility>,ParameterTableModelItem extends ParameterTableModelItemBase<ParamInfo>,ParameterTableModel extends ParameterTableModelBase<ParamInfo,ParameterTableModelItem>>
extends RefactoringDialog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ChangeSignatureDialogBase.ParametersListTable
protected class	ChangeSignatureDialogBase.UpdateSignatureListener

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 static java.lang.String	EXIT_SILENTLY
protected PsiElement	myDefaultValueContext
protected Descriptor	myMethod
protected java.util.Set<Method>	myMethodsToPropagateParameters
protected EditorTextField	myNameField
protected javax.swing.JPanel	myNamePanel
protected JBListTable	myParametersList
protected TableView<ParameterTableModelItem>	myParametersTable
protected ParameterTableModel	myParametersTableModel
protected AnActionButton	myPropagateParamChangesButton
protected PsiCodeFragment	myReturnTypeCodeFragment
protected EditorTextField	myReturnTypeField
protected ChangeSignatureDialogBase.UpdateSignatureListener	mySignatureUpdater
protected VisibilityPanelBase<Visibility>	myVisibilityPanel

Fields inherited from class com.intellij.refactoring.ui.RefactoringDialog

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

Constructor and Description
ChangeSignatureDialogBase(Project project, Descriptor method, boolean allowDelegation, PsiElement defaultValueContext)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	calculateSignature()
protected java.util.List<Pair<java.lang.String,javax.swing.JPanel>>	createAdditionalPanels()
protected abstract CallerChooserBase<Method>	createCallerChooser(java.lang.String title, Tree treeToReuse, Consumer<java.util.Set<Method>> callback)
protected javax.swing.JComponent	createCenterPanel() Factory method.
protected javax.swing.JComponent	createNorthPanel() Factory method.
protected javax.swing.JComponent	createOptionsPanel()
protected abstract ParameterTableModel	createParametersInfoModel(Descriptor method)
protected ChangeSignatureDialogBase.ParametersListTable	createParametersListTable()
protected javax.swing.JPanel	createParametersPanel(boolean hasTabsInDialog)
protected abstract BaseRefactoringProcessor	createRefactoringProcessor()
protected abstract PsiCodeFragment	createReturnTypeCodeFragment()
protected EditorTextField	createReturnTypeTextField(Document document)
protected MethodSignatureComponent	createSignaturePreviewComponent()
protected abstract VisibilityPanelBase<Visibility>	createVisibilityControl()
protected javax.swing.JPanel	createVisibilityPanel()
protected void	customizeParametersTable(TableView<ParameterTableModelItem> table)
protected void	doAction()
protected java.lang.String	getDimensionServiceKey() Returns key for persisting dialog dimensions.
protected abstract LanguageFileType	getFileType()
protected java.lang.String	getHelpId() Returns the help identifier, or null if no help is available.
protected java.lang.String	getMethodName()
java.util.List<ParamInfo>	getParameters()
javax.swing.JComponent	getPreferredFocusedComponent()
protected javax.swing.JComponent	getRowPresentation(ParameterTableModelItemBase<ParamInfo> item, boolean selected, boolean focused) Deprecated. override createParametersListTable() instead.
protected int	getSelectedIdx()
protected JBTable	getTableComponent()
protected JBTableRowEditor	getTableEditor(javax.swing.JTable table, ParameterTableModelItemBase<ParamInfo> item) Deprecated. override createParametersListTable() instead.
protected Visibility	getVisibility()
protected boolean	isEmptyRow(ParameterTableModelItemBase<ParamInfo> row) Deprecated. override createParametersListTable() instead.
boolean	isGenerateDelegate()
protected boolean	isListTableViewSupported()
protected boolean	mayPropagateParameters()
boolean	placeReturnTypeBeforeName()
void	setParameterInfos(java.util.List<? extends ParamInfo> parameterInfos)
protected void	updatePropagateButtons()
protected void	updateSignature()
protected void	updateSignatureAlarmFired()
protected abstract java.lang.String	validateAndCommitData()

Methods inherited from class com.intellij.refactoring.ui.RefactoringDialog

addOpenInEditorCheckbox, areButtonsValid, canRun, closeOKAction, createActions, createDefaultActions, doOKAction, doRefactorAction, getPreviewAction, getProject, getRefactorAction, getRefactoringId, hasHelpAction, hasPreviewButton, invokeRefactoring, isOpenInEditor, isPreviewUsages, setHelpTooltip, setPreviewResults, show, validateButtons

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

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createButtonsPanel, createCancelAction, createContentPane, createContentPaneBorder, createDefaultBorder, createDoNotAskCheckbox, createHelpButton, createJButtonForAction, createJButtonForAction, createLeftSideActions, 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, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHorizontalStretch, getInitialLocation, getLocation, getOKAction, getOwner, getPeer, 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

EXIT_SILENTLY

protected static final java.lang.String EXIT_SILENTLY

See Also:

Constant Field Values

myMethod

protected final Descriptor extends MethodDescriptor<ParamInfo,Visibility> myMethod

myNamePanel

protected javax.swing.JPanel myNamePanel

myNameField

protected EditorTextField myNameField

myReturnTypeField

protected EditorTextField myReturnTypeField

myParametersList

protected JBListTable myParametersList

myParametersTable

protected TableView<ParameterTableModelItem extends ParameterTableModelItemBase<ParamInfo>> myParametersTable

myParametersTableModel

protected final ParameterTableModel extends ParameterTableModelBase<ParamInfo,ParameterTableModelItem> myParametersTableModel

mySignatureUpdater

protected final ChangeSignatureDialogBase.UpdateSignatureListener mySignatureUpdater

myVisibilityPanel

protected VisibilityPanelBase<Visibility> myVisibilityPanel

myReturnTypeCodeFragment

protected PsiCodeFragment myReturnTypeCodeFragment

myPropagateParamChangesButton

protected AnActionButton myPropagateParamChangesButton

myMethodsToPropagateParameters

protected java.util.Set<Method extends PsiElement> myMethodsToPropagateParameters

myDefaultValueContext

protected final PsiElement myDefaultValueContext

Constructor Detail

ChangeSignatureDialogBase

public ChangeSignatureDialogBase(Project project,
                                 Descriptor method,
                                 boolean allowDelegation,
                                 PsiElement defaultValueContext)

Method Detail

getFileType

protected abstract LanguageFileType getFileType()

createParametersInfoModel

protected abstract ParameterTableModel createParametersInfoModel(Descriptor method)

createRefactoringProcessor

protected abstract BaseRefactoringProcessor createRefactoringProcessor()

createReturnTypeCodeFragment

protected abstract PsiCodeFragment createReturnTypeCodeFragment()

createCallerChooser

protected abstract CallerChooserBase<Method> createCallerChooser(java.lang.String title,
                                                                 Tree treeToReuse,
                                                                 Consumer<java.util.Set<Method>> callback)

validateAndCommitData

protected abstract java.lang.String validateAndCommitData()

calculateSignature

protected abstract java.lang.String calculateSignature()

createVisibilityControl

protected abstract VisibilityPanelBase<Visibility> createVisibilityControl()

setParameterInfos

public void setParameterInfos(java.util.List<? extends ParamInfo> parameterInfos)

getMethodName

protected java.lang.String getMethodName()

getVisibility

protected Visibility getVisibility()

getParameters

public java.util.List<ParamInfo> getParameters()

isGenerateDelegate

public boolean isGenerateDelegate()

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

component which should be focused when the dialog appears on the screen.

getSelectedIdx

protected int getSelectedIdx()

getTableComponent

protected JBTable getTableComponent()

placeReturnTypeBeforeName

public boolean placeReturnTypeBeforeName()

createNorthPanel

protected javax.swing.JComponent createNorthPanel()

Description copied from class: DialogWrapper

Factory method. It creates the panel located at the north of the dialog's content pane. The implementation can return null value. In this case there will be no input panel.

Overrides:

createNorthPanel in class DialogWrapper

Returns:

north panel

createReturnTypeTextField

protected EditorTextField createReturnTypeTextField(Document document)

createCenterPanel

protected javax.swing.JComponent createCenterPanel()

Description copied from class: DialogWrapper

Factory method. It creates panel with dialog options. Options panel is located at the center of the dialog's content pane. The implementation can return null value. In this case there will be no options panel.

Specified by:

createCenterPanel in class DialogWrapper

createOptionsPanel

protected javax.swing.JComponent createOptionsPanel()

createVisibilityPanel

protected javax.swing.JPanel createVisibilityPanel()

createAdditionalPanels

protected java.util.List<Pair<java.lang.String,javax.swing.JPanel>> createAdditionalPanels()

getDimensionServiceKey

protected java.lang.String getDimensionServiceKey()

Description copied from class: DialogWrapper

Returns key for persisting dialog dimensions.

Default implementation returns null (no persisting).

Overrides:

getDimensionServiceKey in class DialogWrapper

Returns:

dimension service key

isListTableViewSupported

protected boolean isListTableViewSupported()

createParametersPanel

protected javax.swing.JPanel createParametersPanel(boolean hasTabsInDialog)

createParametersListTable

protected ChangeSignatureDialogBase.ParametersListTable createParametersListTable()

getTableEditor

@Deprecated
protected JBTableRowEditor getTableEditor(javax.swing.JTable table,
                                          ParameterTableModelItemBase<ParamInfo> item)

Deprecated. override createParametersListTable() instead.

isEmptyRow

@Deprecated
protected boolean isEmptyRow(ParameterTableModelItemBase<ParamInfo> row)

Deprecated. override createParametersListTable() instead.

getRowPresentation

@Deprecated
protected javax.swing.JComponent getRowPresentation(ParameterTableModelItemBase<ParamInfo> item,
                                                    boolean selected,
                                                    boolean focused)

Deprecated. override createParametersListTable() instead.

customizeParametersTable

protected void customizeParametersTable(TableView<ParameterTableModelItem> table)

createSignaturePreviewComponent

protected MethodSignatureComponent createSignaturePreviewComponent()

updateSignature

protected void updateSignature()

updateSignatureAlarmFired

protected void updateSignatureAlarmFired()

updatePropagateButtons

protected void updatePropagateButtons()

mayPropagateParameters

protected boolean mayPropagateParameters()

doAction

protected void doAction()

Specified by:

doAction in class RefactoringDialog

getHelpId

protected java.lang.String getHelpId()

Description copied from class: DialogWrapper

Returns the help identifier, or null if no help is available.

Overrides:

getHelpId in class DialogWrapper