Overview (Dialogs API)

Dialogs API
Package	Description
org.openide	Miscellaneous general classes, especially the util classes to handle a user notifications, displaying dialogs and wizards.

What is New (see all changes)?

Apr 18 '14 Allow to specify dialog parent window when using DialogDisplayer.

When a document window is floated (decoupled from the main IDE window) and has focus then a new dialog window will use it as a parent window by default. That means such non-modal dialogs will close when that document window is closed. To avoid such situation pass WindowManager.getDefault().getMainWindow() as dialog parent window when creating the dialog instance.
Sep 17 '13 Added an option to disable the closing of a dialog with ESC key and title bar close button.

Added method setNoDefaultClose(boolean) to NotifyDescriptor class which disables ESC key closing of dialog window and also disables close button in dialogs title bar. When the method is invoked with true parameter then the dialog window can be closed only by pressing one of its Ok/Yes/No/Cancel buttons (depending on the specified closing options).
Apr 10 '13 Added ExtendedAsynchronousValidatingPanel

Added a new wizard panel type which introduces finishValidation() method. It is complementary to prepareValidation() method in AsynchronousValidatingPanel and should be used to unlock user interface when the validation is finished.
Sep 7 '11 Added BackgroundInstantiatingIterator

Added a new form of instantiating wizard iterator which can do its work after the wizard has been closed.
Apr 13 '11 Public API to move wizard to its next/previous step
This change makes four existing methods in WizardDescriptor public: doNextClick(), doPreviousClick(), doFinishClick() and doCancelClick(). In previous version the methods were declared final and package private.
Using these methods it will be possible to move to wizard's next step without clicking the Next button for example when user double-clicks some selected item in wizard's panel .

Use Cases

There is a Wizard Guide Book providing the introductionary information, moreover here is a list of frequently asked questions and their answers:

How to change the title of a wizard?

Q: Although none of my panels have names set (using setName() method) and the method name() in the WizardDescriptor.Iterator returns an empty string, I'm getting "wizard ( )" as the title of each panel in my wizard. When I set the name of the panel and return a string from the method name() I get: "panelName wizard (myName)". The wizard steps are labeled correctly, it just the panel title/name that looks like it adds "wizard ()" to any of my panels. I don't mind the "( )", but I would like to rid of the word "wizard".

A: You can change the format of your wizard's title by WizardDescriptor.setTitleFormat(MessageFormat format) and rid of 'wizard' word in the default wizard's title.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
DialogsAPI	Exported	Official	.../org/openide/package-summary.html

Implementation Details

Read more about the implementation in the answers to architecture questions.