Package com.intellij.internal.psiView

Class PsiViewerDialog

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.internal.psiView.PsiViewerDialog

All Implemented Interfaces:

DataProvider, Disposable

public class PsiViewerDialog
extends DialogWrapper
implements DataProvider, Disposable

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

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	BOX_COLOR
static Logger	LOG

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
PsiViewerDialog(Project project, Editor selectedEditor)

Method Summary

Modifier and Type	Method and Description
protected javax.swing.Action []	createActions() Creates actions for dialog.
protected javax.swing.JComponent	createCenterPanel() Factory method.
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.
protected void	doOKAction() This method is invoked by default implementation of "OK" action.
static javax.swing.tree.TreeNode	findNodeWithObject(java.lang.Object object, javax.swing.tree.TreeModel model, java.lang.Object parent)
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
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.
javax.swing.JComponent	getPreferredFocusedComponent()
protected void	init()
static void	initTree(javax.swing.JTree tree)
void	updateReferences(PsiElement element)

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, createNorthPanel, createPeer, createPeer, createPeer, createPeer, createPeer, createPeer, createRootLayout, createSouthAdditionalPanel, createSouthPanel, createTitlePane, disposeIfNeeded, 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, 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

BOX_COLOR

public static final java.awt.Color BOX_COLOR

LOG

public static final Logger LOG

Constructor Detail

PsiViewerDialog

public PsiViewerDialog(Project project,
                       Editor selectedEditor)

Method Detail

init

protected void init()

Overrides:

init in class DialogWrapper

initTree

public static void initTree(javax.swing.JTree tree)

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

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

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

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

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

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)

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

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Specified by:

getData in interface DataProvider

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.

updateReferences

public void updateReferences(PsiElement element)

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

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.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class DialogWrapper

findNodeWithObject

public static javax.swing.tree.TreeNode findNodeWithObject(java.lang.Object object,
                                                           javax.swing.tree.TreeModel model,
                                                           java.lang.Object parent)