Package com.intellij.openapi.options.ex

Class SingleConfigurableEditor

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.openapi.options.ex.SingleConfigurableEditor

Direct Known Subclasses:

ConfigureTemplatesDialog, EditConfigurationsDialog, EditKeymapsDialog

public class SingleConfigurableEditor
extends DialogWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SingleConfigurableEditor.ApplyAction

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 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
SingleConfigurableEditor(java.awt.Component parent, Configurable configurable)
SingleConfigurableEditor(java.awt.Component parent, Configurable configurable, java.lang.String dimensionServiceKey)
SingleConfigurableEditor(java.awt.Component parent, Configurable configurable, java.lang.String dimensionServiceKey, boolean showApplyButton)
SingleConfigurableEditor(java.awt.Component parent, Configurable configurable, java.lang.String dimensionServiceKey, boolean showApplyButton, DialogWrapper.IdeModalityType ideModalityType)
SingleConfigurableEditor(Project project, Configurable configurable)
SingleConfigurableEditor(Project project, Configurable configurable, DialogWrapper.IdeModalityType ideModalityType)
SingleConfigurableEditor(Project project, Configurable configurable, java.lang.String dimensionKey)
SingleConfigurableEditor(Project project, Configurable configurable, java.lang.String dimensionKey, boolean showApplyButton)
SingleConfigurableEditor(Project project, Configurable configurable, java.lang.String dimensionKey, boolean showApplyButton, DialogWrapper.IdeModalityType ideModalityType)
SingleConfigurableEditor(Project project, Configurable configurable, java.lang.String dimensionKey, DialogWrapper.IdeModalityType ideModalityType)

Method Summary

Modifier and Type	Method and Description
protected javax.swing.Action []	createActions() Creates actions for dialog.
protected javax.swing.JComponent	createCenterPanel() Factory method.
protected static java.lang.String	createDimensionKey(Configurable configurable)
void	dispose() Dispose the wrapped and releases all resources allocated be the wrapper to help more efficient garbage collection.
protected void	doOKAction() This method is invoked by default implementation of "OK" action.
Configurable	getConfigurable()
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()
Project	getProject()

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, 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, 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

Constructor Detail

SingleConfigurableEditor

public SingleConfigurableEditor(Project project,
                                Configurable configurable,
                                java.lang.String dimensionKey,
                                boolean showApplyButton,
                                DialogWrapper.IdeModalityType ideModalityType)

SingleConfigurableEditor

public SingleConfigurableEditor(java.awt.Component parent,
                                Configurable configurable,
                                java.lang.String dimensionServiceKey,
                                boolean showApplyButton,
                                DialogWrapper.IdeModalityType ideModalityType)

SingleConfigurableEditor

public SingleConfigurableEditor(Project project,
                                Configurable configurable,
                                java.lang.String dimensionKey,
                                boolean showApplyButton)

SingleConfigurableEditor

public SingleConfigurableEditor(java.awt.Component parent,
                                Configurable configurable,
                                java.lang.String dimensionServiceKey,
                                boolean showApplyButton)

SingleConfigurableEditor

public SingleConfigurableEditor(Project project,
                                Configurable configurable,
                                java.lang.String dimensionKey,
                                DialogWrapper.IdeModalityType ideModalityType)

SingleConfigurableEditor

public SingleConfigurableEditor(Project project,
                                Configurable configurable,
                                java.lang.String dimensionKey)

SingleConfigurableEditor

public SingleConfigurableEditor(java.awt.Component parent,
                                Configurable configurable,
                                java.lang.String dimensionServiceKey)

SingleConfigurableEditor

public SingleConfigurableEditor(Project project,
                                Configurable configurable,
                                DialogWrapper.IdeModalityType ideModalityType)

SingleConfigurableEditor

public SingleConfigurableEditor(Project project,
                                Configurable configurable)

SingleConfigurableEditor

public SingleConfigurableEditor(java.awt.Component parent,
                                Configurable configurable)

Method Detail

getConfigurable

public Configurable getConfigurable()

getProject

public Project getProject()

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

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)

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

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

createDimensionKey

protected static java.lang.String createDimensionKey(Configurable configurable)

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

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

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

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