Package com.intellij.openapi.options.newEditor

Class SettingsDialog

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.openapi.options.newEditor.SettingsDialog

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

EditScopesDialog

public class SettingsDialog
extends DialogWrapper
implements DataProvider

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 java.lang.String	DIMENSION_KEY

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
SettingsDialog(java.awt.Component parent, java.lang.String key, Configurable configurable, boolean showApplyButton, boolean showResetButton)
SettingsDialog(Project project, java.awt.Component parentComponent, java.util.List<? extends ConfigurableGroup> groups, Configurable configurable, java.lang.String filter)
SettingsDialog(Project project, java.util.List<? extends ConfigurableGroup> groups, Configurable configurable, java.lang.String filter)
SettingsDialog(Project project, java.lang.String key, Configurable configurable, boolean showApplyButton, boolean showResetButton)

Method Summary

Modifier and Type	Method and Description
void	applyAndClose(boolean scheduleSave)
protected javax.swing.Action []	createActions() Creates actions for dialog.
protected javax.swing.JComponent	createCenterPanel() Factory method.
void	doCancelAction(java.awt.AWTEvent source) You can use this method if you want to know by which event this actions got triggered.
void	doOKAction() This method is invoked by default implementation of "OK" action.
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 DialogWrapper.DialogStyle	getStyle()
boolean	isTypeAheadEnabled()
protected void	setHelpTooltip(javax.swing.JButton helpButton)
protected SettingsTreeView	treeViewFactory(SettingsFilter filter, java.util.List<? extends ConfigurableGroup> groups)
protected void	tryAddOptionsListener(OptionsEditorColleague colleague)

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, dispose, 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, getTitle, getTypeAheadTimeoutMs, getValidationThreadToUse, getVerticalStretch, getWindow, hasErrors, init, initValidation, isAutoAdjustable, isCenterStrictedToPreferredSize, isDisposed, isModal, isModalProgress, isMoveHelpButtonLeft, isNorthStrictedToPreferredSize, isOK, isOKActionEnabled, isProgressDialog, isResizable, isShowing, isSouthStrictedToPreferredSize, isToDispatchTypeAhead, 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, 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

DIMENSION_KEY

public static final java.lang.String DIMENSION_KEY

See Also:

Constant Field Values

Constructor Detail

SettingsDialog

public SettingsDialog(Project project,
                      java.lang.String key,
                      Configurable configurable,
                      boolean showApplyButton,
                      boolean showResetButton)

SettingsDialog

public SettingsDialog(java.awt.Component parent,
                      java.lang.String key,
                      Configurable configurable,
                      boolean showApplyButton,
                      boolean showResetButton)

SettingsDialog

public SettingsDialog(Project project,
                      java.util.List<? extends ConfigurableGroup> groups,
                      Configurable configurable,
                      java.lang.String filter)

SettingsDialog

public SettingsDialog(Project project,
                      java.awt.Component parentComponent,
                      java.util.List<? extends ConfigurableGroup> groups,
                      Configurable configurable,
                      java.lang.String filter)

Method Detail

treeViewFactory

protected SettingsTreeView treeViewFactory(SettingsFilter filter,
                                           java.util.List<? extends ConfigurableGroup> groups)

setHelpTooltip

protected void setHelpTooltip(javax.swing.JButton helpButton)

Overrides:

setHelpTooltip 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.

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

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

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

isTypeAheadEnabled

public boolean isTypeAheadEnabled()

Overrides:

isTypeAheadEnabled in class DialogWrapper

getStyle

protected DialogWrapper.DialogStyle getStyle()

Overrides:

getStyle in class DialogWrapper

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

tryAddOptionsListener

protected void tryAddOptionsListener(OptionsEditorColleague colleague)

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

public 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

applyAndClose

public void applyAndClose(boolean scheduleSave)

doCancelAction

public void doCancelAction(java.awt.AWTEvent source)

Description copied from class: DialogWrapper

You can use this method if you want to know by which event this actions got triggered. It is called only if the cancel action was triggered by some input event, doCancelAction is called otherwise.

Overrides:

doCancelAction in class DialogWrapper

Parameters:

source - AWT event

See Also:

DialogWrapper.doCancelAction()