Package com.intellij.find.findUsages

Class AbstractFindUsagesDialog

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.find.findUsages.AbstractFindUsagesDialog

Direct Known Subclasses:

CommonFindUsagesDialog

public abstract class AbstractFindUsagesDialog
extends DialogWrapper

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 StateRestoringCheckBox	myCbToSearchForTextOccurrences
protected javax.swing.JCheckBox	myCbToSkipResultsWhenOneUsage
protected FindUsagesOptions	myFindUsagesOptions

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	AbstractFindUsagesDialog(Project project, FindUsagesOptions findUsagesOptions, boolean toShowInNewTab, boolean mustOpenInNewTab, boolean isSingleFile, boolean searchForTextOccurrencesAvailable, boolean searchInLibrariesAvailable)

Method Summary

Modifier and Type	Method and Description
protected StateRestoringCheckBox	addCheckboxToPanel(java.lang.String name, boolean toSelect, javax.swing.JPanel panel, boolean toUpdate)
protected void	addScopeData(FeatureUsageData data, SearchScope scope)
protected void	addUsagesOptions(javax.swing.JPanel optionsPanel)
FindUsagesOptions	calcFindUsagesOptions()
void	calcFindUsagesOptions(FindUsagesOptions options)
abstract void	configureLabelComponent(SimpleColoredComponent coloredComponent)
protected javax.swing.Action []	createActions() Creates actions for dialog.
protected javax.swing.JPanel	createAllOptionsPanel()
protected javax.swing.JComponent	createCenterPanel() Factory method.
protected abstract javax.swing.JPanel	createFindWhatPanel()
protected javax.swing.JComponent	createNorthPanel() Factory method.
protected javax.swing.JPanel	createUsagesOptionsPanel()
protected void	doOKAction() This method is invoked by default implementation of "OK" action.
javax.swing.JComponent	getPreferredFocusedComponent()
protected javax.swing.JComponent	getPreferredFocusedControl()
protected void	init()
protected boolean	isInFileOnly()
protected static boolean	isSelected(javax.swing.JCheckBox cb)
protected static boolean	isToChange(javax.swing.JCheckBox cb)
protected boolean	shouldDoOkAction()
protected void	update()

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

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createButtonsPanel, createCancelAction, createContentPane, createContentPaneBorder, createDefaultActions, 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, getDimensionServiceKey, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHelpId, getHorizontalStretch, getInitialLocation, getLocation, getOKAction, getOwner, getPeer, getPreferredSize, getRootPane, getSize, getStyle, getTitle, getTypeAheadTimeoutMs, getValidationThreadToUse, getVerticalStretch, getWindow, hasErrors, 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, setHelpTooltip, setHorizontalStretch, setInitialLocationCallback, setLocation, setLocation, setModal, setOKActionEnabled, setOKButtonIcon, setOKButtonMnemonic, setOKButtonText, setOKButtonTooltip, setResizable, setSize, setTitle, setUndecorated, setValidationDelay, setVerticalStretch, shouldAddErrorNearButtons, shouldCloseOnCross, show, 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

myFindUsagesOptions

protected final FindUsagesOptions myFindUsagesOptions

myCbToSearchForTextOccurrences

protected StateRestoringCheckBox myCbToSearchForTextOccurrences

myCbToSkipResultsWhenOneUsage

protected javax.swing.JCheckBox myCbToSkipResultsWhenOneUsage

Constructor Detail

AbstractFindUsagesDialog

protected AbstractFindUsagesDialog(Project project,
                                   FindUsagesOptions findUsagesOptions,
                                   boolean toShowInNewTab,
                                   boolean mustOpenInNewTab,
                                   boolean isSingleFile,
                                   boolean searchForTextOccurrencesAvailable,
                                   boolean searchInLibrariesAvailable)

Method Detail

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)

isInFileOnly

protected boolean isInFileOnly()

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

configureLabelComponent

public abstract void configureLabelComponent(SimpleColoredComponent coloredComponent)

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

calcFindUsagesOptions

public final FindUsagesOptions calcFindUsagesOptions()

init

protected void init()

Overrides:

init in class DialogWrapper

calcFindUsagesOptions

public void calcFindUsagesOptions(FindUsagesOptions options)

update

protected void update()

doOKAction

protected 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

shouldDoOkAction

protected boolean shouldDoOkAction()

isToChange

protected static boolean isToChange(javax.swing.JCheckBox cb)

isSelected

protected static boolean isSelected(javax.swing.JCheckBox cb)

addCheckboxToPanel

protected StateRestoringCheckBox addCheckboxToPanel(java.lang.String name,
                                                    boolean toSelect,
                                                    javax.swing.JPanel panel,
                                                    boolean toUpdate)

createAllOptionsPanel

protected javax.swing.JPanel createAllOptionsPanel()

createFindWhatPanel

protected abstract javax.swing.JPanel createFindWhatPanel()

addUsagesOptions

protected void addUsagesOptions(javax.swing.JPanel optionsPanel)

createUsagesOptionsPanel

protected javax.swing.JPanel createUsagesOptionsPanel()

getPreferredFocusedControl

protected javax.swing.JComponent getPreferredFocusedControl()

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

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

addScopeData

protected final void addScopeData(FeatureUsageData data,
                                  SearchScope scope)