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)?

Jun 7 '22 NotifyDescriptor.ComposedInput added

Added ComposedInput providing a composed input of multiple chained selection lists and/or input lines.
Feb 15 '22 NotifyDescriptor.QuickPick added

Added QuickPick providing a selection list allowing multiple selections.
Feb 14 '22 Support for CompletableFutures in Dialog API

DialogDisplayer.notifyFuture now allows to chain processing after user closes the dialog without blocking a thread as with DialogDisplayer.notify.
Jan 31 '22 Allow vetoable Next/Finish validation in wizard

Added PasswordLine, which is implementation of InputLine intended for password entry.
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.

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.