Package com.intellij.structuralsearch.plugin.ui

Class StructuralSearchDialog

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.structuralsearch.plugin.ui.StructuralSearchDialog

All Implemented Interfaces:

DocumentListener, ProjectManagerListener, java.util.EventListener

public class StructuralSearchDialog
extends DialogWrapper
implements ProjectManagerListener, DocumentListener

This dialog is used in two ways: 1. a non-modal search dialog, showing a scope panel 2. a modal edit dialog for Structural Search inspection patterns

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
static Key<StructuralSearchDialog>	STRUCTURAL_SEARCH_DIALOG
static Key<java.lang.Runnable>	STRUCTURAL_SEARCH_ERROR_CALLBACK
static Key<java.lang.String>	STRUCTURAL_SEARCH_PATTERN_CONTEXT_ID

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

Fields inherited from interface com.intellij.openapi.project.ProjectManagerListener

EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
StructuralSearchDialog(SearchContext searchContext, boolean replace)
StructuralSearchDialog(SearchContext searchContext, boolean replace, boolean editConfigOnly)

Method Summary

Modifier and Type	Method and Description
protected javax.swing.JComponent	createCenterPanel() Factory method.
protected javax.swing.JComponent	createNorthPanel() Factory method.
protected javax.swing.JPanel	createSouthAdditionalPanel() Additional panel in the lower left part of dialog to the left from additional buttons
void	dispose() Dispose the wrapped and releases all resources allocated be the wrapper to help more efficient garbage collection.
void	doCancelAction() This method is invoked by default implementation of "Cancel" action.
void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.
protected void	doOKAction() This method is invoked by default implementation of "OK" action.
Configuration	getConfiguration()
protected java.lang.String	getDimensionServiceKey() Returns key for persisting dialog dimensions.
protected java.lang.String	getHelpId() Returns the help identifier, or null if no help is available.
java.awt.Point	getInitialLocation()
javax.swing.JComponent	getPreferredFocusedComponent()
static java.lang.String	getUserDefined()
void	loadConfiguration(Configuration configuration)
void	projectClosing(Project project) Invoked on project close before any closing activities
void	setUseLastConfiguration(boolean useLastConfiguration)
void	show() Show the dialog.
void	showFilterPanel(java.lang.String variableName)

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

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createActions, createButtonsPanel, createCancelAction, createContentPane, createContentPaneBorder, createDefaultActions, createDefaultBorder, createDoNotAskCheckbox, createHelpButton, createJButtonForAction, createJButtonForAction, createLeftSideActions, createPeer, createPeer, createPeer, createPeer, createPeer, createPeer, createRootLayout, createSouthPanel, createTitlePane, disposeIfNeeded, doCancelAction, doHelpAction, doValidate, doValidateAll, extractMnemonic, findInstance, findInstanceFromFocus, getButton, getCancelAction, getContentPane, getContentPanel, getDimensionKey, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHorizontalStretch, 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, setHelpTooltip, 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

Methods inherited from interface com.intellij.openapi.project.ProjectManagerListener

canCloseProject, projectClosed, projectClosingBeforeSave, projectOpened

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

beforeDocumentChange, bulkUpdateFinished, bulkUpdateStarting

Field Detail

STRUCTURAL_SEARCH_DIALOG

public static final Key<StructuralSearchDialog> STRUCTURAL_SEARCH_DIALOG

STRUCTURAL_SEARCH_PATTERN_CONTEXT_ID

public static final Key<java.lang.String> STRUCTURAL_SEARCH_PATTERN_CONTEXT_ID

STRUCTURAL_SEARCH_ERROR_CALLBACK

public static final Key<java.lang.Runnable> STRUCTURAL_SEARCH_ERROR_CALLBACK

Constructor Detail

StructuralSearchDialog

public StructuralSearchDialog(SearchContext searchContext,
                              boolean replace)

StructuralSearchDialog

public StructuralSearchDialog(SearchContext searchContext,
                              boolean replace,
                              boolean editConfigOnly)

Method Detail

setUseLastConfiguration

public void setUseLastConfiguration(boolean useLastConfiguration)

documentChanged

public void documentChanged(DocumentEvent event)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

event - the event containing the information about the change.

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

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

createSouthAdditionalPanel

protected javax.swing.JPanel createSouthAdditionalPanel()

Description copied from class: DialogWrapper

Additional panel in the lower left part of dialog to the left from additional buttons

Overrides:

createSouthAdditionalPanel in class DialogWrapper

Returns:

panel to be shown or null if it's not required

getInitialLocation

public java.awt.Point getInitialLocation()

Overrides:

getInitialLocation in class DialogWrapper

Returns:

Location in absolute coordinates which is used when dialog has no dimension service key or no position was stored yet. Can return null. In that case dialog will be centered relative to its owner.

show

public void show()

Description copied from class: DialogWrapper

Show the dialog.

Overrides:

show in class DialogWrapper

See Also:

DialogWrapper.showAndGet()

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

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

doCancelAction

public void doCancelAction()

Description copied from class: DialogWrapper

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

Overrides:

doCancelAction in class DialogWrapper

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

getConfiguration

public Configuration getConfiguration()

showFilterPanel

public void showFilterPanel(java.lang.String variableName)

loadConfiguration

public void loadConfiguration(Configuration configuration)

getDimensionServiceKey

protected final 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

projectClosing

public void projectClosing(Project project)

Description copied from interface: ProjectManagerListener

Invoked on project close before any closing activities

Specified by:

projectClosing in interface ProjectManagerListener

dispose

public void dispose()

Description copied from class: DialogWrapper

Dispose the wrapped and releases all resources allocated be the wrapper to help more efficient garbage collection. You should never invoke this method twice or invoke any method of the wrapper after invocation of dispose.

Overrides:

dispose in class DialogWrapper

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

getUserDefined

public static java.lang.String getUserDefined()