[jbosstools-issues] [JBoss JIRA] (JBIDE-10264) Wizard-ify the project examples

[Snjezana Peco (JIRA)]

    [ https://issues.jboss.org/browse/JBIDE-10264?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12664651#comment-12664651 ] 

Snjezana Peco commented on JBIDE-10264:
---------------------------------------

>> 1) The mockup doesn't show the first page when calling the Project Examples wizard using Help>Project Examples. Would it be as it is now?

> It would be fine - but now it can be "decluttered".

> No "output location" field on top and quickfix option can be removed.

OK. The details (requirements) panel can also be removed. 

>> 3) Why wouldn't we set the QuickFix/Readme checkboxes to the first page and remove the last page?

> Because the project aren't imported yet so no way for you ask/know the details for this.

I don't think that is important.
There is also a problem when adding this as a separate wizard page.
Let's say we start a project example that is not of the mavenArchetype type from JBoss Central (the problem exists in any other case, but this is the easiest one to explain).
We have two pages (or three when including Quick Fix as a wizard page):

Page 1 - Requirements
Page 2 - a page with these two checkboxes

On the Page 1, before downloading we don't know if the Page 2 (or 3) will appear at all.
Would we enable the Next button on this page?  Would the Next/Previous buttons exist at all?
If we enable Next, it could happen the following:
- the user clicks it
- the project example is downloaded and we see that there aren't any errors or readme/cheatcheet files
We should finish the wizard allthough the user hasn't clicked Finish.
If we disable Next
-  the user clicks Finish
- the project example has been downloaded and we see that there are errors or readme/cheatcheet files
We need to show a new page allthough the user clicked Finish.

In my opinion, it is better to move these two checkboxes to the first page. 

>>4) If there is a Quick Fix, would it be on the new wizard page or in the dialog as it is now?

> Depends what is technically possible. Showing it in a dialog will be ok for me.

The Quick Fix is a wizard too. We could move its wizard page to our new wizard.
The problem is that the wizard wouldn't finish the project build and we wouldn't be able to determine the state of the Next button on the previous page (as previously described.

>>5)
>> It would mean download start on Page 3 and if you choose to go in background and the job finishes the wizard will open up again starting >from what would have been Page 4.

>>I am not sure what page you mean when saying Page 3 or 4. Do you mean the page I mentioned or a page in the mockup?

> In the comment I was referring to your text - did the mockup after that.

Now, the Page 3 exists only for the project examples of the mavenArchetype type. As to all other project examples, the Page 3 doesn't exist and we can't start download on that page. 
It would start on the Page 1 (for JBoss Central) or Page 2 (Help>Project Examples). As to project examples that contribute a wizard page(s), the download would have to be delegated to the contributed wizard page.

>>I can try to solve this, but it would be good if you would know an example of an Eclipse wizard that works this way?
>>I haven't succeeded to find any wizard that goes to the background and gets back at some point.

> No, then view as two different wizards.

>>Wizards use a modal dialog. What will we do if the user opens some other wizard or a modal dialog when our wizard should be shown again?

>This is exactly why I prefer to keep the flow in a wizard - since today stuff just pops up with an editor/quickfix/cheatsheet view.

A cheatsheat/readme is opened in a view/editor. It can't pop-up. 
The Quick Fix is a wizard that can pop-up, but the user can disable it.

>>The mockup seems to be created to solve project examples of the mavenArchetype type when they are called from JBoss Central.

> No - its the same flow for both cases.

There are, at least, 4 cases:
- project examples that don't contribute some page and start from JBoss Central
- project examples that don't contribute some page and start using Help>Project Examples
- project examples that contribute some page (mavenArchetype) and start from JBoss Central
- project examples that contribute some page (mavenArchetype) and start using Help>Project Examples

Each of these cases would have to have different pages. There would also exist wizard pages depending on whether requirements/readme/cheatsheets/quickfixes exist.
That is OK if we treat this mockup as a simplified mockup for special case.

>>As to the project examples of the mavenArchetype type, the problem has been solved by JBIDE-9776. It would be enough to make JBoss >Central not to open the Project Example dialog for those >project examples that have the "wizard" tag, but to call their implementation >method directly.

> I don't understand what that changes/how it affects this jira ?

IMO, creating this wizard would have some advantage for project examples of the mavenArchetype type, but that is already solved by adding the wizard tag to the project examples file (JBIDE-9776).

                
> Wizard-ify the project examples
> -------------------------------
>
>                 Key: JBIDE-10264
>                 URL: https://issues.jboss.org/browse/JBIDE-10264
>             Project: Tools (JBoss Tools)
>          Issue Type: Feature Request
>          Components: project-examples
>    Affects Versions: 3.3.0.M4
>            Reporter: Fred Bricon
>            Assignee: Snjezana Peco
>            Priority: Blocker
>             Fix For: 3.3.0.Beta1
>
>         Attachments: wizardsuggestion.bmml, wizardsuggestion.bmml, wizardsuggestion.png
>
>
> In the wake of JBIDE-9776 and JBIDE-10140, it turns out that, in order for us to contribute 5 new wizards to the "New " menu under the Jboss perspective and in the "New project" section of JBoss central, "project examples" based projects should be created via a Wizard implementation from the get go. 
> Current project examples workflow involves :
> - displaying a form dialog : to display missing runtimes and let the user install/download the required runtimes
> - launching a workspace job, which in turn : 
>   * downloads the example
>   * does the actual project import (launches a wizard for maven archetypes)
>   * resolve quickfixes
> Ideally, all these steps would be part of a single wizard, spanning one to N pages (depending on the complexity/requirements of the examples). Everything contributed by the form dialog would be replaced by a wizard page, which would bring consistency to the UI.
> In other words, that means the project example dialog needs to be refactored into a Wizard, providing an API so that client plugins can contribute wizard pages. 
> I'm aware this is not a simple task to refactor the existing workflow to such an infrastructure but ultimately, that would allow us to easily contribute new project wizards to the IDE in a standard way.
> Current target is 3.3.0.Beta1. Snjeza, WDYT?

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira