I post the intention to make new Wizard API which
responds to strong enhancements and reported
issues in the current wizard implementation. The
motivation for this is summarized in attached
document. A design document, plans, problems will
be added during tracking this task. The
corresponing javadoc and arch document will be
# A short issue description outlining what the
issue is and why it is being done.
"I propose make new API based on supported
use-cases. To avoid force the changes on the
client side then the current API and its
implementation won't be changed but will be
deprecated. The new API will be separated to own
package contained API, SPI and the whole wizard's
# Target milestone
# Dependencies on other issues and issues that
depend on this one
Umbrella task 26552 depends on it (see dependency
# An explanation of the change in architecture/API.
# A list of the interfaces that the project offers
(imports) and depends on (exports).
Wizard Manager - place for create, open and obtain
a active wizard's state, optionally close it.
Manager controls the move through wizard's
sequence, dispatches the commutation between
StepProvider, WizardHandler and WizardUI.
StepProvider: Provider the wizard's steps. Can
provide next/prev step in wizard sequence, knows
the steps, knows when can wizard finish and can
Step: one member in wizard's sequence and wrapper
the wizard's page. If the is marked as required
then the wizard cannot be finished before this
Page: The central part of wizard's window. Page
provides the UI part of wizard's and controls how
to proceed the wizard's page. Page also parts in
wizard's validation. Notifies data changes to
listeners, e.g. wizard's UI to reflect it.
WizardUI: Presents UI of wizard's dialog. It's
built on list of steps and wizard page. Reflects
data changes in page (e.g. change of button's
state) and notifies the listeners about move
through wizard sequence.
# The specification (e.g. javadoc) and stability
category (aka commitment level) for each interface.
I propose deprecate current WizardDescriptor and
its subclasses and make official WizardManager,
Step, Page, StepProvider, WizardUI APIs.
The only thing I am missing is a summary of issues that depend on the
new Wizards framework. 26552 does not have any issues depending on it,
does it mean there are no dependencies or they are on subtasks?
Based on the review process this issue qualifies for the standard review:
Please complete answers for the arc questions:
and reassign back to me.
The pre-review questions are answered at
Also you can checkout openide/wizards module from wizard_36584 branch
and generate javadoc. The issue with dependences will be attached soon.
Issue 26552 has now the bunch of enhancements/tasks depend on this
umbrella issue. I assign back to Pavel.
reassigning to reviewers, Jarda is the owner (responsible for holding
the meeting and summarizing results), Petr J, Mila and Hrebejk are
I am setting 11/7 as target date. You can have the review whenever you
want (just in PRG).
Review document is here:
No changes planned to 3.6.
Making the state to match the result of the review.
This issue was solved long time ago. Because nobody has reopened it neither
added comments, we are verifying/closing it now.
If you are still able to reproduce the problem, please reopen.
Thanks in advance.