DialogWrapper (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.ui.DialogWrapper

Direct Known Subclasses:

AbstractExtractMethodDialog, AbstractFieldPanel.Viewer, AbstractFindUsagesDialog, AbstractNewProjectDialog, AbstractSelectFilesDialog, AbstractTreeClassChooserDialog, AbstractUpdateDialog, AbstractWizard, AddClientPropertyDialog, AddCustomLibraryDialog, AddFieldBreakpointDialog, AddFrameworkSupportDialog, AddMethodsDialog, AddNamespaceDialog, AddRepositoryLocationDialog, AddSupportForSingleFrameworkDialog, AddWildcardBreakpointDialog, AdvancedOptionsDialog, AnalyzeStacktraceDialog, ApplyPatchDifferentiatedDialog, ArrangementRuleAliasDialog, AuthDialog, AuthenticationDialog, AutomaticRenamingDialog, AutomaticUsageRenamingDialog, BackgroundImageDialog, BaseAnalysisActionDialog, BaseExecuteBeforeRunDialog, BaseIntroduceDialog, BranchConfigurationDialog, BreakpointsDialog, CallerChooserBase, CannotUndoReportDialog, CertificateWarningDialog, ChangeLibraryLevelDialog, ChangeListChooser, ChangelistConflictDialog, ChangeListViewerDialog, ChangesBrowserDialog, CheckoutOptionsDialog, ChooseActionsDialog, ChooseElementsDialog, ChooseEncodingDialog, ChooseLibrariesDialogBase, ChooseStacktraceDialog, ClassNameInputDialog, CleanUnshelvedFilterDialog, CloneDvcsDialog, CloseTaskDialog, CollectTroubleshootingInformationDialog, CommitChangeListDialog, CommittedChangesFilterDialog, CompileQrcAction.CompileQrcDialog, ComponentItemDialog, ConfigureBranchContextDialog, ConfigureClientPropertiesDialog, ConfigureCvsGlobalSettingsDialog, ConfigureDetectedFrameworksDialog, ConfigureTasksActivationDialog, ConflictsDialog, ContentChooser, ConvertProjectDialog, ConvertSchemaDialog, CopyOptionsDialog, CorruptedProjectFilesDialog, CoverageSuiteChooserDialog, CreateBranchOrTagDialog, CreateClassDialog, CreateDesktopEntryAction.CreateDesktopEntryDialog, CreateEditorConfigDialog, CreateFieldFromParameterDialog, CreateFileFromTemplateDialog, CreateFromTemplateDialog, CreateLibraryFromFilesDialog, CreateRemoteSdkDialog, CreateResourceBundleDialogComponent.Dialog, CreateTestDialog, CreateTestDialog, CustomizeIDEWizardDialog, CustomizeKeywordSubstitutionDialog, CvsConfigurationsListEditor, CvsTagDialog, DefaultValueChooser, DeleteOptionsDialog, DetectedRootsChooserDialog, DiffOptionsDialog, DirDiffDialog, DirectoryChooser, DownloadingOptionsDialog, DynamicDialog, EditChangelistDialog, EditClassFiltersDialog, EditContextDialog, EditCvsConfigurationFieldByFieldDialog, EditInstanceFiltersDialog, EditLibraryDialog, EditLocationDialog, EditLogPatternDialog, EditMigrationDialog, EditMigrationEntryDialog, EditSdkDialog, EditTaskDialog, EditXmxVMOptionDialog, EnclosingMethodSelectionDialog, EncodingViewer, EvaluationAwareTraceWindow, ExcludedFilesDialogBase, ExperimentsDialog, ExportEclipseProjectsDialog, ExportOptionsDialog, ExportToFileUtil.ExportDialogBase, ExportToHTMLDialog, ExportToHTMLDialog, ExternalProjectDataSelectorDialog, ExternalSystemEditTaskDialog, ExtractArtifactDialog, ExtractedSettingsDialog, ExtractIncludeDialog, ExtractMethodObjectDialog, FailedConversionsDialog, FileChooserDialogImpl, FileColorConfigurationEditDialog, FileNestingInProjectViewDialog, FileStructureDialog, FileTypeChooser, FocusTracesDialog, FontEditorDialog, GenerateByPatternDialog, GenerateGroovyDocDialog, GenerateInstanceDocumentFromSchemaDialog, GenerateSchemaFromInstanceDocumentDialog, GetJPDADialog, GitBranchIsNotFullyMergedDialog, GitCrlfDialog, GitDefineRemoteDialog, GithubCreatePullRequestDialog, GithubSelectForkDialog, GitMergeDialog, GitNewResetDialog, GitPullDialog, GitRebaseDialog, GitRefDialog, GitRejectedPushUpdateDialog, GitResetDialog, GitSmartOperationDialog, GitStashDialog, GitTagDialog, GitUnstashDialog, GitUnstructuredEditor, GotoLineNumberDialog, GradleProjectCompositeSelectorDialog, GradleRunTaskDialog, GrIntroduceConstantDialog, GrIntroduceFieldDialog, GrIntroduceParameterDialog, GroovyCreateClassDialog, GroovyExtractMethodDialog, GroovyIntroduceVariableDialog, GroovyMapParameterDialog, HgBookmarkDialog, HgCommonDialogWithChoices, HgGlobalStatusDialog, HgInitAlreadyUnderHgDialog, HgInitDialog, HgPullDialog, HgRunConflictResolverDialog, HgTagDialog, I18nizeMultipleStringsDialog, I18nizeQuickFixDialog, IdeaDialog, IdeErrorsDialog, IgnoredViewDialog, ImageDuplicateResultsDialog, ImportOptionsDialog, ImportSchemeChooserDialog, IncompatibleEncodingDialog, InfoDialog, InstancesWindowBase, IntegratedSelectedOptionsDialog, IOExceptionDialog, IssueLinkConfigurationDialog, JarArtifactFromModulesDialog, JavaFxApplicationIconsDialog, JavaFxEditCertificatesDialog, JdkChooserPanel.MyDialog, KeyChooserDialog, LayoutCodeDialog, LayoutProjectCodeDialog, LegalNoticeDialog, LibraryEditorDialogBase, ListEditorDialog, LocateLibraryDialog, MacrosDialog, ManagePackagesDialog, ManageRepoDialog, ManageTemplateVariablesDialog, MapExternalResourceDialog, MemberChooser, MessageDialog, MethodListDlg, MigrateRootDialog, MigrationDialog, MissedTestsDialog, MkdirOptionsDialog, ModeSwitchableDialog, MoveChangesDialog, MvcRunTargetDialog, NewChangelistDialog, NewKeyDialog, NonProjectFileWritingAccessDialog, NullableNotNullDialog, OpenTaskDialog, OptionsDialog, OutOfMemoryDialog, PackageChooser, PackagingErrorDialog, PathMacroEditor, PluginConflictDialog, PluginInfoDialog, PluginsAdvertiserDialog, PluginUpdateDialog, PostfixEditTemplateDialog, ProjectJdksEditor, PsiViewerDialog, PublicSshKeyDialog, PyChooseRequirementsDialog, PyDataViewDialog, PyIntroduceDialog, PyManagePackagesDialog, PythonDocumentationEntryEditor, PythonSdkDetailsDialog, RefactoringDialog, RefactoringMessageDialog, ReformatFilesDialog, RelocateDialog, RemoveInvalidElementsDialog, ReplacementPreviewDialog, ReplacePromptDialog, RepositoryAttachDialog, RepositoryBrowserDialog, RepositoryLibraryPropertiesDialog, RollbackChangesDialog, RunDialog, SafeDeleteDialog, SaveMetaTargetDialog, SaveProjectAsTemplateDialog, ScopesOrderDialog, SelectCvsConfigurationDialog, SelectDateDialog, SelectExternalSystemNodeDialog, SelectFilesDialog, SelectFileVersionDialog, SelectFromListDialog, SelectLocationDialog, SelectTagDialog, SelectTemplateDialog, SelectTemplateDialog, ServerSSHDialog, ServerSSLDialog, SetKeywordsDialog, SetPropertyDialog, SettingsDialog, SetupTaskDialog, SeverityEditorDialog, ShelfStorageConfigurationDialog, ShowFeatureUsageStatisticsDialog, SideEffectWarningDialog, SimpleCredentialsDialog, SimpleFieldChooser, SingleConfigurableEditor, SphinxBaseCommand.AskForWorkDir, SshPasswordDialog, SSLCredentialsDialog, StringEditorDialog, StructuralSearchDialog, SvnConfigureProxiesDialog, SvnEditCommitMessageDialog, TargetChooserDialog, TestParseEventLogWhitelistDialog, TipDialog, ToBeMergedDialog, ToolEditorDialog, ToolSelectDialog, TreeFileChooserDialog, UnsafeUsagesDialog, UnscrambleDialog, UnversionedViewDialog, UpgradeFormatDialog, ValidationTest, ValueMarkerPresentationDialogBase, VcsMappingConfigurationDialog, VcsPushDialog, VcsStructureChooser, WatcherDialog, WizardDialog, XDebuggerEvaluationDialog, XInspectDialog, YesNoPreviewUsagesDialog
```
public abstract class DialogWrapper
extends java.lang.Object
```
The standard base class for modal dialog boxes. The dialog wrapper could be used only on event dispatch thread. In case when the dialog must be created from other threads use EventQueue.invokeLater(Runnable) or EventQueue.invokeAndWait(Runnable).

See Also:

DialogWrapper on SDK DevGuide

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DialogWrapper.CancelAction`
`static class`	`DialogWrapper.DialogStyle`
`protected class`	`DialogWrapper.DialogWrapperAction` Base class for dialog wrapper actions that need to ensure that only one action for the dialog is running.
`protected class`	`DialogWrapper.DialogWrapperExitAction` The action that just closes dialog with the specified exit code (like the default behavior of the actions "Ok" and "Cancel").
`static interface`	`DialogWrapper.DoNotAskOption`
`static class`	`DialogWrapper.IdeModalityType`
`protected class`	`DialogWrapper.OkAction`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CANCEL_EXIT_CODE` The default exit code for "Cancel" action.
`static int`	`CLOSE_EXIT_CODE` The default exit code for "Close" action.
`static java.lang.String`	`DEFAULT_ACTION` If your action returned by `createActions` method has non `null` value for this key, then the button that corresponds to the action will be the default button for the dialog.
`static java.lang.Object`	`DIALOG_CONTENT_PANEL_PROPERTY`
`static java.awt.Color`	`ERROR_FOREGROUND_COLOR`
`static java.lang.String`	`FOCUSED_ACTION`
`static java.lang.String`	`IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY`
`protected javax.swing.Action`	`myCancelAction`
`protected javax.swing.JCheckBox`	`myCheckBoxDoNotShowDialog`
`protected Disposable`	`myDisposable`
`protected javax.swing.Action`	`myHelpAction`
`protected javax.swing.Action`	`myOKAction`
`protected boolean`	`myPerformAction`
`protected javax.swing.JComponent`	`myPreferredFocusedComponent`
`static int`	`NEXT_USER_EXIT_CODE` If you use your own custom exit codes you have to start them with this constant.
`static int`	`OK_EXIT_CODE` The default exit code for "OK" action.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DialogWrapper(boolean canBeParent)` Creates modal `DialogWrapper`.
`protected`	`DialogWrapper(boolean canBeParent, boolean applicationModalIfPossible)` Deprecated. use `DialogWrapper(Project, boolean, boolean)`
`protected`	`DialogWrapper(java.awt.Component parent, boolean canBeParent)`
`protected`	`DialogWrapper(Project project)` Creates modal `DialogWrapper` that can be parent for other windows.
`protected`	`DialogWrapper(Project project, boolean canBeParent)` Creates modal `DialogWrapper`.
`protected`	`DialogWrapper(Project project, boolean canBeParent, boolean applicationModalIfPossible)`
`protected`	`DialogWrapper(Project project, boolean canBeParent, DialogWrapper.IdeModalityType ideModalityType)`
`protected`	`DialogWrapper(Project project, java.awt.Component parentComponent, boolean canBeParent, DialogWrapper.IdeModalityType ideModalityType)`
`protected`	`DialogWrapper(Project project, java.awt.Component parentComponent, boolean canBeParent, DialogWrapper.IdeModalityType ideModalityType, boolean createSouth)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addKeyListener(java.awt.event.KeyListener listener)`
`void`	`addMouseListener(java.awt.event.MouseListener listener)`
`void`	`addMouseListener(java.awt.event.MouseMotionListener listener)`
`protected boolean`	`canRecordDialogId()` If dialog open/close events should be recorded in user event log, it can be used to understand how often this dialog is used.
`void`	`centerRelativeToParent()`
`static void`	`cleanupRootPane(javax.swing.JRootPane rootPane)`
`static void`	`cleanupWindowListeners(java.awt.Window window)`
`void`	`clickDefaultButton()` Programmatically perform a "click" of default dialog's button.
`void`	`close(int exitCode)`
`void`	`close(int exitCode, boolean isOk)` Closes and disposes the dialog and sets the specified exit code.
`protected javax.swing.Action []`	`createActions()` Creates actions for dialog.
`protected javax.swing.JPanel`	`createButtonsPanel(java.util.List<? extends javax.swing.JButton> buttons)`
`protected java.awt.event.ActionListener`	`createCancelAction()` Return `null` if we should ignore for window closing.
`protected abstract javax.swing.JComponent`	`createCenterPanel()` Factory method.
`protected javax.swing.JComponent`	`createContentPane()`
`protected javax.swing.border.Border`	`createContentPaneBorder()` Creates border for dialog's content pane.
`protected void`	`createDefaultActions()`
`static javax.swing.border.Border`	`createDefaultBorder()` The shared instance of default border for dialog's content pane.
`protected javax.swing.JComponent`	`createDoNotAskCheckbox()`
`protected javax.swing.JButton`	`createHelpButton(java.awt.Insets insets)`
`protected javax.swing.JButton`	`createJButtonForAction(javax.swing.Action action)` Creates `JButton` for the specified action.
`static javax.swing.JButton`	`createJButtonForAction(javax.swing.Action action, javax.swing.JRootPane rootPane)`
`protected javax.swing.Action []`	`createLeftSideActions()`
`protected javax.swing.JComponent`	`createNorthPanel()` Factory method.
`protected DialogWrapperPeer`	`createPeer(boolean canBeParent, boolean applicationModalIfPossible)` Deprecated. Dialogs with no parents are discouraged.
`protected DialogWrapperPeer`	`createPeer(java.awt.Component parent, boolean canBeParent)`
`protected DialogWrapperPeer`	`createPeer(Project project, boolean canBeParent)`
`protected DialogWrapperPeer`	`createPeer(Project project, boolean canBeParent, DialogWrapper.IdeModalityType ideModalityType)`
`protected DialogWrapperPeer`	`createPeer(java.awt.Window owner, boolean canBeParent, boolean applicationModalIfPossible)`
`protected DialogWrapperPeer`	`createPeer(java.awt.Window owner, boolean canBeParent, DialogWrapper.IdeModalityType ideModalityType)`
`protected java.awt.LayoutManager`	`createRootLayout()`
`protected javax.swing.JPanel`	`createSouthAdditionalPanel()` Additional panel in the lower left part of dialog to the left from additional buttons
`protected javax.swing.JComponent`	`createSouthPanel()` Creates panel located at the south of the content pane.
`protected javax.swing.JComponent`	`createTitlePane()`
`protected void`	`dispose()` Dispose the wrapped and releases all resources allocated be the wrapper to help more efficient garbage collection.
`void`	`disposeIfNeeded()`
`void`	`doCancelAction()` This method is invoked by default implementation of "Cancel" action.
`void`	`doCancelAction(java.awt.AWTEvent source)` You can use this method if you want to know by which event this actions got triggered.
`protected void`	`doHelpAction()`
`protected void`	`doOKAction()` This method is invoked by default implementation of "OK" action.
`protected ValidationInfo`	`doValidate()` Validates user input and returns `null` if everything is fine or validation description with component where problem has been found.
`protected java.util.List<ValidationInfo>`	`doValidateAll()` Validates user input and returns `List<ValidationInfo>`.
`static Pair<java.lang.Integer,java.lang.String>`	`extractMnemonic(java.lang.String text)`
`static DialogWrapper`	`findInstance(java.awt.Component c)`
`static DialogWrapper`	`findInstanceFromFocus()`
`protected javax.swing.JButton`	`getButton(javax.swing.Action action)`
`protected javax.swing.Action`	`getCancelAction()`
`java.awt.Container`	`getContentPane()` Returns content pane
`javax.swing.JComponent`	`getContentPanel()`
`java.lang.String`	`getDimensionKey()`
`protected java.lang.String`	`getDimensionServiceKey()` Returns key for persisting dialog dimensions.
`Disposable`	`getDisposable()`
`protected java.lang.String`	`getDoNotShowMessage()`
`protected int`	`getErrorTextAlignment()`
`int`	`getExitCode()`
`protected javax.swing.Action`	`getHelpAction()`
`protected java.lang.String`	`getHelpId()` Returns the help identifier, or `null` if no help is available.
`float`	`getHorizontalStretch()`
`java.awt.Point`	`getInitialLocation()`
`java.awt.Point`	`getLocation()`
`protected javax.swing.Action`	`getOKAction()`
`java.awt.Window`	`getOwner()`
`DialogWrapperPeer`	`getPeer()`
`javax.swing.JComponent`	`getPreferredFocusedComponent()`
`java.awt.Dimension`	`getPreferredSize()`
`javax.swing.JRootPane`	`getRootPane()`
`java.awt.Dimension`	`getSize()`
`protected DialogWrapper.DialogStyle`	`getStyle()`
`java.lang.String`	`getTitle()`
`long`	`getTypeAheadTimeoutMs()`
`protected Alarm.ThreadToUse`	`getValidationThreadToUse()`
`float`	`getVerticalStretch()`
`java.awt.Window`	`getWindow()`
`protected boolean`	`hasErrors(javax.swing.JComponent component)` Check if component is in error state validation-wise
`protected void`	`init()`
`protected void`	`initValidation()`
`boolean`	`isAutoAdjustable()`
`protected boolean`	`isCenterStrictedToPreferredSize()` Deprecated. unused
`boolean`	`isDisposed()`
`boolean`	`isModal()`
`boolean`	`isModalProgress()`
`protected static boolean`	`isMoveHelpButtonLeft()`
`protected boolean`	`isNorthStrictedToPreferredSize()` Deprecated. unused
`boolean`	`isOK()`
`boolean`	`isOKActionEnabled()`
`protected boolean`	`isProgressDialog()`
`void`	`isResizable()`
`boolean`	`isShowing()`
`protected boolean`	`isSouthStrictedToPreferredSize()` Deprecated. unused
`boolean`	`isToDispatchTypeAhead()` Deprecated. unused (equals `isOK()`)
`boolean`	`isTypeAheadEnabled()`
`boolean`	`isVisible()`
`static javax.swing.JPanel`	`layoutButtonsPanel(java.util.List<? extends javax.swing.JButton> buttons)`
`void`	`pack()`
`protected boolean`	`postponeValidation()` Allows to postpone first start of validation
`protected void`	`processDoNotAskOnOk(int exitCode)`
`void`	`repaint()`
`protected boolean`	`setAutoAdjustable(boolean autoAdjustable)`
`protected void`	`setButtonsAlignment(int alignment)` Sets horizontal alignment of dialog's buttons.
`void`	`setButtonsMargin(java.awt.Insets insets)` Deprecated. button margins aren't used anymore. Button style is standardized.
`protected void`	`setCancelButtonIcon(javax.swing.Icon icon)` Deprecated. button icons aren't used anymore (except "OK" action). Button style is standardized.
`protected void`	`setCancelButtonText(java.lang.String text)`
`void`	`setCrossClosesWindow(boolean crossClosesWindow)`
`void`	`setDoNotAskOption(DialogWrapper.DoNotAskOption doNotAsk)`
`protected void`	`setErrorInfoAll(java.util.List<ValidationInfo> info)`
`protected void`	`setErrorText(java.lang.String text)` Don't override this method.
`protected void`	`setErrorText(java.lang.String text, javax.swing.JComponent component)`
`protected void`	`setHelpTooltip(javax.swing.JButton helpButton)`
`protected void`	`setHorizontalStretch(float hStretch)`
`void`	`setInitialLocationCallback(Computable<? extends java.awt.Point> callback)`
`void`	`setLocation(int x, int y)`
`void`	`setLocation(java.awt.Point p)`
`void`	`setModal(boolean modal)`
`void`	`setOKActionEnabled(boolean isEnabled)`
`protected void`	`setOKButtonIcon(javax.swing.Icon icon)`
`protected void`	`setOKButtonMnemonic(int c)`
`protected void`	`setOKButtonText(java.lang.String text)`
`protected void`	`setOKButtonTooltip(java.lang.String text)`
`void`	`setResizable(boolean resizable)`
`void`	`setSize(int width, int height)`
`void`	`setTitle(java.lang.String title)`
`void`	`setUndecorated(boolean undecorated)`
`void`	`setValidationDelay(int delay)`
`protected void`	`setVerticalStretch(float vStretch)`
`protected boolean`	`shouldAddErrorNearButtons()`
`boolean`	`shouldCloseOnCross()`
`void`	`show()` Show the dialog.
`boolean`	`showAndGet()` Show the modal dialog and check if it was closed with OK.
`<any>`	`showAndGetOk()` Deprecated. override `doOKAction()` / `doCancelAction()` or hook on `myDisposable`
`protected void`	`startTrackingValidation()`
`void`	`toBack()`
`protected boolean`	`toBeShown()`
`void`	`toFront()`
`static void`	`unregisterKeyboardActions(java.awt.Component rootPane)`
`protected void`	`updateErrorInfo(java.util.List<ValidationInfo> info)`
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY
```
public static final java.lang.String IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY
```
    See Also:
    
    Constant Field Values
  - OK_EXIT_CODE
```
public static final int OK_EXIT_CODE
```
    The default exit code for "OK" action.
    
    See Also:
    
    Constant Field Values
  - CANCEL_EXIT_CODE
```
public static final int CANCEL_EXIT_CODE
```
    The default exit code for "Cancel" action.
    
    See Also:
    
    Constant Field Values
  - CLOSE_EXIT_CODE
```
public static final int CLOSE_EXIT_CODE
```
    The default exit code for "Close" action. Equal to cancel.
    
    See Also:
    
    Constant Field Values
  - NEXT_USER_EXIT_CODE
```
public static final int NEXT_USER_EXIT_CODE
```
    If you use your own custom exit codes you have to start them with this constant.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ACTION
```
public static final java.lang.String DEFAULT_ACTION
```
    If your action returned by createActions method has non null value for this key, then the button that corresponds to the action will be the default button for the dialog. It's true if you don't change this behaviour of createJButtonForAction(Action) method.
    
    See Also:
    
    Constant Field Values
  - FOCUSED_ACTION
```
public static final java.lang.String FOCUSED_ACTION
```
    See Also:
    
    Constant Field Values
  - DIALOG_CONTENT_PANEL_PROPERTY
```
public static final java.lang.Object DIALOG_CONTENT_PANEL_PROPERTY
```
  - ERROR_FOREGROUND_COLOR
```
public static final java.awt.Color ERROR_FOREGROUND_COLOR
```
  - myDisposable
```
protected final Disposable myDisposable
```
  - myOKAction
```
protected javax.swing.Action myOKAction
```
  - myCancelAction
```
protected javax.swing.Action myCancelAction
```
  - myHelpAction
```
protected javax.swing.Action myHelpAction
```
  - myPerformAction
```
protected boolean myPerformAction
```
  - myCheckBoxDoNotShowDialog
```
protected javax.swing.JCheckBox myCheckBoxDoNotShowDialog
```
  - myPreferredFocusedComponent
```
protected javax.swing.JComponent myPreferredFocusedComponent
```
- Constructor Detail
  - DialogWrapper
```
protected DialogWrapper(Project project,
                        boolean canBeParent)
```
    Creates modal DialogWrapper. The currently active window will be the dialog's parent.
    
    Parameters:
    
    project - parent window for the dialog will be calculated based on focused window for the specified project. This parameter can be null. In this case parent window will be suggested based on current focused window.
    
    canBeParent - specifies whether the dialog can be parent for other windows. This parameter is used by WindowManager.
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is invoked not on the event dispatch thread
  - DialogWrapper
```
protected DialogWrapper(Project project,
                        boolean canBeParent,
                        DialogWrapper.IdeModalityType ideModalityType)
```
  - DialogWrapper
```
protected DialogWrapper(Project project,
                        java.awt.Component parentComponent,
                        boolean canBeParent,
                        DialogWrapper.IdeModalityType ideModalityType)
```
  - DialogWrapper
```
protected DialogWrapper(Project project,
                        java.awt.Component parentComponent,
                        boolean canBeParent,
                        DialogWrapper.IdeModalityType ideModalityType,
                        boolean createSouth)
```
  - DialogWrapper
```
protected DialogWrapper(Project project)
```
    Creates modal DialogWrapper that can be parent for other windows. The currently active window will be the dialog's parent.
    
    Parameters:
    
    project - parent window for the dialog will be calculated based on focused window for the specified project. This parameter can be null. In this case parent window will be suggested based on current focused window.
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is invoked not on the event dispatch thread
    
    See Also:
    
    DialogWrapper(Project, boolean)
  - DialogWrapper
```
protected DialogWrapper(boolean canBeParent)
```
    Creates modal DialogWrapper. The currently active window will be the dialog's parent.
    
    Parameters:
    
    canBeParent - specifies whether the dialog can be parent for other windows. This parameter is used by WindowManager.
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is invoked not on the event dispatch thread
  - DialogWrapper
```
@Deprecated
protected DialogWrapper(boolean canBeParent,
                        boolean applicationModalIfPossible)
```
    Deprecated. use DialogWrapper(Project, boolean, boolean)
    
    Typically, we should set a parent explicitly. Use WindowManager.suggestParentWindow(com.intellij.openapi.project.Project) method to find out the best parent for your dialog. Exceptions are cases when we do not have a project to figure out which window is more suitable as an owner for the dialog.
  - DialogWrapper
```
protected DialogWrapper(Project project,
                        boolean canBeParent,
                        boolean applicationModalIfPossible)
```
  - DialogWrapper
```
protected DialogWrapper(java.awt.Component parent,
                        boolean canBeParent)
```
    Parameters:
    
    parent - parent component which is used to calculate heavy weight window ancestor. parent cannot be null and must be showing.
    
    canBeParent - can be parent
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is invoked not on the event dispatch thread
- Method Detail
  - createDefaultBorder
```
public static javax.swing.border.Border createDefaultBorder()
```
    The shared instance of default border for dialog's content pane.
  - getDoNotShowMessage
```
protected java.lang.String getDoNotShowMessage()
```
  - setDoNotAskOption
```
public void setDoNotAskOption(DialogWrapper.DoNotAskOption doNotAsk)
```
  - getValidationThreadToUse
```
protected Alarm.ThreadToUse getValidationThreadToUse()
```
  - postponeValidation
```
protected boolean postponeValidation()
```
    Allows to postpone first start of validation
    
    Returns:
    
    false if start validation in init() method
  - doValidate
```
protected ValidationInfo doValidate()
```
    Validates user input and returns null if everything is fine or validation description with component where problem has been found.
    
    Returns:
    
    null if everything is OK or validation descriptor
    
    See Also:
    
    Validation errors guidelines
  - doValidateAll
```
protected java.util.List<ValidationInfo> doValidateAll()
```
    Validates user input and returns List<ValidationInfo>. If everything is fine the returned list is empty otherwise the list contains all invalid fields with error messages. This method should preferably be used when validating forms with multiply fields that require validation.
    
    Returns:
    
    List<ValidationInfo> of invalid fields. List is empty if no errors found.
    
    See Also:
    
    Validation errors guidelines
  - setValidationDelay
```
public void setValidationDelay(int delay)
```
  - updateErrorInfo
```
protected void updateErrorInfo(java.util.List<ValidationInfo> info)
```
  - createDefaultActions
```
protected void createDefaultActions()
```
  - setUndecorated
```
public void setUndecorated(boolean undecorated)
```
  - addMouseListener
```
public final void addMouseListener(java.awt.event.MouseListener listener)
```
  - addMouseListener
```
public final void addMouseListener(java.awt.event.MouseMotionListener listener)
```
  - addKeyListener
```
public final void addKeyListener(java.awt.event.KeyListener listener)
```
  - close
```
public final void close(int exitCode,
                        boolean isOk)
```
    Closes and disposes the dialog and sets the specified exit code.
    
    Parameters:
    
    exitCode - exit code
    
    isOk - is OK
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is invoked not on the event dispatch thread
  - close
```
public final void close(int exitCode)
```
  - createContentPaneBorder
```
protected javax.swing.border.Border createContentPaneBorder()
```
    Creates border for dialog's content pane. By default content pane has has empty border with (8,12,8,12) insets. Subclasses can return null for no border.
    
    Returns:
    
    content pane border
  - isMoveHelpButtonLeft
```
protected static boolean isMoveHelpButtonLeft()
```
  - createSouthPanel
```
protected javax.swing.JComponent createSouthPanel()
```
    Creates panel located at the south of the content pane. By default that panel contains dialog's buttons. This default implementation uses createActions() and createJButtonForAction(Action) methods to construct the panel.
    
    Returns:
    
    south panel
  - createHelpButton
```
protected javax.swing.JButton createHelpButton(java.awt.Insets insets)
```
  - setHelpTooltip
```
protected void setHelpTooltip(javax.swing.JButton helpButton)
```
  - shouldAddErrorNearButtons
```
protected boolean shouldAddErrorNearButtons()
```
  - getStyle
```
protected DialogWrapper.DialogStyle getStyle()
```
  - toBeShown
```
protected boolean toBeShown()
```
  - isTypeAheadEnabled
```
public boolean isTypeAheadEnabled()
```
  - createDoNotAskCheckbox
```
protected javax.swing.JComponent createDoNotAskCheckbox()
```
  - createButtonsPanel
```
protected javax.swing.JPanel createButtonsPanel(java.util.List<? extends javax.swing.JButton> buttons)
```
  - layoutButtonsPanel
```
public static javax.swing.JPanel layoutButtonsPanel(java.util.List<? extends javax.swing.JButton> buttons)
```
  - createSouthAdditionalPanel
```
protected javax.swing.JPanel createSouthAdditionalPanel()
```
    Additional panel in the lower left part of dialog to the left from additional buttons
    
    Returns:
    
    panel to be shown or null if it's not required
  - getButton
```
protected javax.swing.JButton getButton(javax.swing.Action action)
```
    Parameters:
    
    action - should be registered to find corresponding JButton
    
    Returns:
    
    button for specified action or null if it's not found
  - createJButtonForAction
```
protected javax.swing.JButton createJButtonForAction(javax.swing.Action action)
```
    Creates JButton for the specified action. If the button has not null value for DialogWrapper.DEFAULT_ACTION key then the created button will be the default one for the dialog.
    
    Parameters:
    
    action - action for the button
    
    Returns:
    
    button with action specified
    
    See Also:
    
    DEFAULT_ACTION
  - createJButtonForAction
```
public static javax.swing.JButton createJButtonForAction(javax.swing.Action action,
                                                         javax.swing.JRootPane rootPane)
```
  - extractMnemonic
```
public static Pair<java.lang.Integer,java.lang.String> extractMnemonic(java.lang.String text)
```
  - createPeer
```
protected DialogWrapperPeer createPeer(java.awt.Component parent,
                                       boolean canBeParent)
```
  - createPeer
```
@Deprecated
protected DialogWrapperPeer createPeer(boolean canBeParent,
                                       boolean applicationModalIfPossible)
```
    Deprecated. Dialogs with no parents are discouraged.
  - createPeer
```
protected DialogWrapperPeer createPeer(java.awt.Window owner,
                                       boolean canBeParent,
                                       DialogWrapper.IdeModalityType ideModalityType)
```
  - createPeer
```
protected DialogWrapperPeer createPeer(java.awt.Window owner,
                                       boolean canBeParent,
                                       boolean applicationModalIfPossible)
```
  - createPeer
```
protected DialogWrapperPeer createPeer(Project project,
                                       boolean canBeParent,
                                       DialogWrapper.IdeModalityType ideModalityType)
```
  - createPeer
```
protected DialogWrapperPeer createPeer(Project project,
                                       boolean canBeParent)
```
  - createTitlePane
```
protected javax.swing.JComponent createTitlePane()
```
  - createNorthPanel
```
protected javax.swing.JComponent createNorthPanel()
```
    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.
    
    Returns:
    
    north panel
  - createCenterPanel
```
protected abstract javax.swing.JComponent createCenterPanel()
```
    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.
  - toFront
```
public void toFront()
```
    See Also:
    
    Window.toFront()
  - toBack
```
public void toBack()
```
    See Also:
    
    Window.toBack()
  - setAutoAdjustable
```
protected boolean setAutoAdjustable(boolean autoAdjustable)
```
  - isAutoAdjustable
```
public boolean isAutoAdjustable()
```
  - dispose
```
protected void dispose()
```
    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.
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is disposed not on the event dispatch thread
  - cleanupRootPane
```
public static void cleanupRootPane(javax.swing.JRootPane rootPane)
```
  - unregisterKeyboardActions
```
public static void unregisterKeyboardActions(java.awt.Component rootPane)
```
  - cleanupWindowListeners
```
public static void cleanupWindowListeners(java.awt.Window window)
```
  - doCancelAction
```
public void doCancelAction()
```
    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.
  - doCancelAction
```
public void doCancelAction(java.awt.AWTEvent source)
```
    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.
    
    Parameters:
    
    source - AWT event
    
    See Also:
    
    doCancelAction()
  - clickDefaultButton
```
public void clickDefaultButton()
```
    Programmatically perform a "click" of default dialog's button. The method does nothing if the dialog has no default button.
  - doOKAction
```
protected void doOKAction()
```
    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.
  - processDoNotAskOnOk
```
protected void processDoNotAskOnOk(int exitCode)
```
  - shouldCloseOnCross
```
public boolean shouldCloseOnCross()
```
    Returns:
    
    whether the native window cross button closes the window or not. true means that cross performs hide or dispose of the dialog.
  - createActions
```
protected javax.swing.Action [] createActions()
```
    Creates actions for dialog.
    By default "OK" and "Cancel" actions are returned. The "Help" action is automatically added if getHelpId() returns non-null value.
    Each action is represented by JButton created by createJButtonForAction(Action). These buttons are then placed into south panel of dialog.
    
    Returns:
    
    dialog actions
    
    See Also:
    
    createSouthPanel(), createJButtonForAction(javax.swing.Action)
  - createLeftSideActions
```
protected javax.swing.Action [] createLeftSideActions()
```
  - getOKAction
```
protected javax.swing.Action getOKAction()
```
    Returns:
    
    default implementation of "OK" action. This action just invokes doOKAction() method.
    
    See Also:
    
    doOKAction()
  - getCancelAction
```
protected javax.swing.Action getCancelAction()
```
    Returns:
    
    default implementation of "Cancel" action. This action just invokes doCancelAction() method.
    
    See Also:
    
    doCancelAction()
  - getHelpAction
```
protected javax.swing.Action getHelpAction()
```
    Returns:
    
    default implementation of "Help" action. This action just invokes doHelpAction() method.
    
    See Also:
    
    doHelpAction()
  - isProgressDialog
```
protected boolean isProgressDialog()
```
  - isModalProgress
```
public final boolean isModalProgress()
```
  - getContentPane
```
public java.awt.Container getContentPane()
```
    Returns content pane
    
    Returns:
    
    content pane
    
    See Also:
    
    JDialog.getContentPane()
  - validate
```
public void validate()
```
    See Also:
    
    Container.validate()
  - repaint
```
public void repaint()
```
    See Also:
    
    JDialog.repaint(long, int, int, int, int)
  - getDimensionServiceKey
```
protected java.lang.String getDimensionServiceKey()
```
    Returns key for persisting dialog dimensions.
    Default implementation returns null (no persisting).
    
    Returns:
    
    dimension service key
  - getDimensionKey
```
public final java.lang.String getDimensionKey()
```
  - getExitCode
```
public int getExitCode()
```
  - getPreferredFocusedComponent
```
public javax.swing.JComponent getPreferredFocusedComponent()
```
    Returns:
    
    component which should be focused when the dialog appears on the screen.
  - getHorizontalStretch
```
public final float getHorizontalStretch()
```
    Returns:
    
    horizontal stretch of the dialog. It means that the dialog's horizontal size is the product of horizontal stretch by horizontal size of packed dialog. The default value is 1.0f
  - getVerticalStretch
```
public final float getVerticalStretch()
```
    Returns:
    
    vertical stretch of the dialog. It means that the dialog's vertical size is the product of vertical stretch by vertical size of packed dialog. The default value is 1.0f
  - setHorizontalStretch
```
protected final void setHorizontalStretch(float hStretch)
```
  - setVerticalStretch
```
protected final void setVerticalStretch(float vStretch)
```
  - getOwner
```
public java.awt.Window getOwner()
```
    Returns:
    
    window owner
    
    See Also:
    
    Window.getOwner()
  - getWindow
```
public java.awt.Window getWindow()
```
  - getContentPanel
```
public javax.swing.JComponent getContentPanel()
```
  - getRootPane
```
public javax.swing.JRootPane getRootPane()
```
    Returns:
    
    root pane
    
    See Also:
    
    JDialog.getRootPane()
  - getSize
```
public java.awt.Dimension getSize()
```
    Returns:
    
    dialog size
    
    See Also:
    
    Component.getSize()
  - getTitle
```
public java.lang.String getTitle()
```
    Returns:
    
    dialog title
    
    See Also:
    
    Dialog.getTitle()
  - init
```
protected void init()
```
  - getErrorTextAlignment
```
protected int getErrorTextAlignment()
```
  - createRootLayout
```
protected java.awt.LayoutManager createRootLayout()
```
  - startTrackingValidation
```
protected void startTrackingValidation()
```
  - initValidation
```
protected final void initValidation()
```
  - isNorthStrictedToPreferredSize
```
@Deprecated
protected boolean isNorthStrictedToPreferredSize()
```
    Deprecated. unused
  - isCenterStrictedToPreferredSize
```
@Deprecated
protected boolean isCenterStrictedToPreferredSize()
```
    Deprecated. unused
  - isSouthStrictedToPreferredSize
```
@Deprecated
protected boolean isSouthStrictedToPreferredSize()
```
    Deprecated. unused
  - createContentPane
```
protected javax.swing.JComponent createContentPane()
```
  - pack
```
public void pack()
```
    See Also:
    
    Window.pack()
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
  - setButtonsAlignment
```
protected final void setButtonsAlignment(int alignment)
```
    Sets horizontal alignment of dialog's buttons.
    
    Parameters:
    
    alignment - alignment of the buttons. Acceptable values are SwingConstants.CENTER and SwingConstants.RIGHT. The SwingConstants.RIGHT is the default value.
    
    Throws:
    
    java.lang.IllegalArgumentException - if alignment isn't acceptable
  - setButtonsMargin
```
@Deprecated
public final void setButtonsMargin(java.awt.Insets insets)
```
    Deprecated. button margins aren't used anymore. Button style is standardized.
  - setCrossClosesWindow
```
public final void setCrossClosesWindow(boolean crossClosesWindow)
```
  - setCancelButtonIcon
```
@Deprecated
protected final void setCancelButtonIcon(javax.swing.Icon icon)
```
    Deprecated. button icons aren't used anymore (except "OK" action). Button style is standardized.
  - setCancelButtonText
```
protected final void setCancelButtonText(java.lang.String text)
```
  - setModal
```
public void setModal(boolean modal)
```
  - isModal
```
public boolean isModal()
```
  - isOKActionEnabled
```
public boolean isOKActionEnabled()
```
  - setOKActionEnabled
```
public void setOKActionEnabled(boolean isEnabled)
```
  - setOKButtonIcon
```
protected final void setOKButtonIcon(javax.swing.Icon icon)
```
  - setOKButtonText
```
protected final void setOKButtonText(java.lang.String text)
```
    Parameters:
    
    text - action without mnemonic. If mnemonic is set, presentation would be shifted by one to the left AbstractButton.setText(String) AbstractButton.updateDisplayedMnemonicIndex(String, int)
  - setOKButtonMnemonic
```
protected final void setOKButtonMnemonic(int c)
```
  - setOKButtonTooltip
```
protected final void setOKButtonTooltip(java.lang.String text)
```
  - getHelpId
```
protected java.lang.String getHelpId()
```
    Returns the help identifier, or null if no help is available.
  - doHelpAction
```
protected void doHelpAction()
```
  - isOK
```
public boolean isOK()
```
  - isVisible
```
public boolean isVisible()
```
    Returns:
    
    true if and only if visible
    
    See Also:
    
    Component.isVisible()
  - isShowing
```
public boolean isShowing()
```
    Returns:
    
    true if and only if showing
    
    See Also:
    
    Window.isShowing()
  - setSize
```
public void setSize(int width,
                    int height)
```
    Parameters:
    
    width - width
    
    height - height
    
    See Also:
    
    Window.setSize(java.awt.Dimension)
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Parameters:
    
    title - title
    
    See Also:
    
    Dialog.setTitle(java.lang.String)
  - isResizable
```
public void isResizable()
```
    See Also:
    
    Dialog.isResizable()
  - setResizable
```
public void setResizable(boolean resizable)
```
    Parameters:
    
    resizable - is resizable
    
    See Also:
    
    Dialog.setResizable(boolean)
  - getLocation
```
public java.awt.Point getLocation()
```
    Returns:
    
    dialog location
    
    See Also:
    
    Component.getLocation()
  - setLocation
```
public void setLocation(java.awt.Point p)
```
    Parameters:
    
    p - new dialog location
    
    See Also:
    
    Window.setLocation(Point)
  - setLocation
```
public void setLocation(int x,
                        int y)
```
    Parameters:
    
    x - x
    
    y - y
    
    See Also:
    
    Window.setLocation(int, int)
  - centerRelativeToParent
```
public void centerRelativeToParent()
```
  - show
```
public void show()
```
    Show the dialog.
    
    Throws:
    
    java.lang.IllegalStateException - if the method is invoked not on the event dispatch thread
    
    See Also:
    
    showAndGet()
  - showAndGet
```
public boolean showAndGet()
```
    Show the modal dialog and check if it was closed with OK.
    
    Returns:
    
    true if the exit code is OK_EXIT_CODE.
    
    Throws:
    
    java.lang.IllegalStateException - if the dialog is non-modal, or if the method is invoked not on the EDT.
    
    See Also:
    
    show()
  - showAndGetOk
```
@Deprecated
public <any> showAndGetOk()
```
    Deprecated. override doOKAction() / doCancelAction() or hook on myDisposable
  - getInitialLocation
```
public java.awt.Point getInitialLocation()
```
    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.
  - setInitialLocationCallback
```
public void setInitialLocationCallback(Computable<? extends java.awt.Point> callback)
```
  - createCancelAction
```
protected java.awt.event.ActionListener createCancelAction()
```
    Return null if we should ignore for window closing.
  - getTypeAheadTimeoutMs
```
public long getTypeAheadTimeoutMs()
```
  - isToDispatchTypeAhead
```
@Deprecated
public boolean isToDispatchTypeAhead()
```
    Deprecated. unused (equals isOK())
  - canRecordDialogId
```
protected boolean canRecordDialogId()
```
    If dialog open/close events should be recorded in user event log, it can be used to understand how often this dialog is used.
  - setErrorText
```
protected void setErrorText(java.lang.String text)
```
    Don't override this method. It is not final for the API compatibility. It will not be called by the DialogWrapper's validator. Use this method only in circumstances when the exact invalid component is hard to detect or the valid status is based on several fields. In other cases use setErrorText(String, JComponent) method.
    
    Parameters:
    
    text - the error text to display
  - setErrorText
```
protected void setErrorText(java.lang.String text,
                            javax.swing.JComponent component)
```
  - setErrorInfoAll
```
protected void setErrorInfoAll(java.util.List<ValidationInfo> info)
```
  - hasErrors
```
protected boolean hasErrors(javax.swing.JComponent component)
```
    Check if component is in error state validation-wise
  - findInstance
```
public static DialogWrapper findInstance(java.awt.Component c)
```
  - findInstanceFromFocus
```
public static DialogWrapper findInstanceFromFocus()
```
  - getPeer
```
public final DialogWrapperPeer getPeer()
```
  - getDisposable
```
public final Disposable getDisposable()
```
  - isDisposed
```
public boolean isDisposed()
```
  - disposeIfNeeded
```
public void disposeIfNeeded()
```

Class DialogWrapper

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY

OK_EXIT_CODE

CANCEL_EXIT_CODE

CLOSE_EXIT_CODE

NEXT_USER_EXIT_CODE

DEFAULT_ACTION

FOCUSED_ACTION

DIALOG_CONTENT_PANEL_PROPERTY

ERROR_FOREGROUND_COLOR

myDisposable

myOKAction

myCancelAction

myHelpAction

myPerformAction

myCheckBoxDoNotShowDialog

myPreferredFocusedComponent

Constructor Detail

DialogWrapper

DialogWrapper

DialogWrapper

DialogWrapper

DialogWrapper

DialogWrapper

DialogWrapper

DialogWrapper

DialogWrapper

Method Detail

createDefaultBorder

getDoNotShowMessage

setDoNotAskOption

getValidationThreadToUse

postponeValidation

doValidate

doValidateAll

setValidationDelay

updateErrorInfo

createDefaultActions

setUndecorated

addMouseListener

addMouseListener

addKeyListener

close

close

createContentPaneBorder

isMoveHelpButtonLeft

createSouthPanel

createHelpButton

setHelpTooltip

shouldAddErrorNearButtons

getStyle

toBeShown

isTypeAheadEnabled

createDoNotAskCheckbox

createButtonsPanel

layoutButtonsPanel

createSouthAdditionalPanel

getButton

createJButtonForAction

createJButtonForAction

extractMnemonic

createPeer

createPeer

createPeer

createPeer

createPeer

createPeer

createTitlePane

createNorthPanel

createCenterPanel

toFront

toBack

setAutoAdjustable

isAutoAdjustable