How to Incorporate a Wizard into a Griffon Application

Let's create a Griffon application that includes a wizard! In the end, you'll have an application, as shown below, with a "New" menu item, which pops up a wizard. When "Finish" is clicked, the text in the wizard is put into the text area in the application:

Here are the steps:


  1. Run "griffon create-app", using "WizardDemo1" when prompted for a name. Or use the "New Griffon Application" template in NetBeans IDE.


  2. Run "griffon list-plugins" and then install the Wizard plugin. Or right-click the application in NetBeans IDE, choose "Griffon Plugins...", and use the New Plugins tab to install the "wizard" plugin (currently the last one in the list). By doing this, you add a new folder, "griffon-app/wizards" and you also have a new scripts available for creating wizard artifacts.


  3. Run "griffon create-wizard-page". Or right-click the application in NetBeans IDE, choose "Run Griffon Command...", choose "create-wizard-page", and choose Run. Type "One" when prompted, which will result in a new file called "OneWizardPage.groovy" in the "griffon-app/wizards" folder.

    The content of "OneWizardPage.groovy" is as follows, none of which you will need to change in this example:

    class OneWizardPage {
       def stepId = "step1" // must be unique per WizardPage
       def description = "Step Description"
       def autoListen = true
       def pageContents = {
          // remember to always set a name: property to each input widget
          textField( name: "tf1", text: "Add Content Here" ) 
       // Either return a String that indicates a problem
       // or return a null valud indicating no problem
       def onValidate = { component, /\*PropertyChangeEvent\*/ event ->
          return null // no problems


  4. Change the "WizardDemo1View.groovy", in "griffon-app/views", to the following:
    application(title:'WizardDemo1',  size:[320,200], location:[50,50], locationByPlatform:true) {
        menuBar {
            menuItem('New', actionPerformed:controller.action)
        textArea(id: 'ta','<Empty>')


  5. In line 4 above, you're referring to an action in the "WizardDemo1Controller.groovy", which is in "griffon-app/controllers". Define it like this:
    def action = { evt = null ->
        def wizard = wizard( title: "My Wizard", pages: ["One"] )
        def result = showWizard(wizard)
        view.ta.text = result.tf1

    The "One" in line 2 above refers to the "One" you typed when you created the wizard page. From the "showWizard", you get a result, from which you get "tf1", which is the name of the text field in the wizard page. That's what you put in the text area, which has the id "ta", in the view.

Hurray. You're done. Simple example for one wizard page which, when "Finish" is clicked, causes the content of the wizard to be put in the view's text area. And a lot of this is thanks to Tim's project, as can be seen from the NetBeans 5.0 splash screen in the left of the wizard shown above.


Nice plugin Geertjan!

Unfortunately I had to make two changes in order to get the code to work for me using Griffon 0.1.1 on OS X.

1) I had to enclose menuItem('New', actionPerformed:controller.action) with menu("File") {}
so it looks like

menuBar {
menu("File") {
menuItem('New', actionPerformed:controller.action)

2) I also had to change view.ta.text = result.tf1 to view.ta.text = result.tf1.value.toString() to get the wizard value back.

Let me know if I'm making these change incorrectly as I'm not a Griffon expert. :-)

Bill Gloff

Posted by Bill Gloff on June 22, 2009 at 04:15 AM PDT #

Thank you for this article series!

But I have one issue with Wizard plugin. I can't import my Java class to any wizard pages. Compiler always says: unable to resolve class.

I'm newbie in griffon/groovy development, could you please point me how to resolve this issue.

Thanks in advance.

Posted by Artem on August 24, 2009 at 12:38 PM PDT #

Post a Comment:
  • HTML Syntax: NOT allowed

Geertjan Wielenga (@geertjanw) is a Principal Product Manager in the Oracle Developer Tools group living & working in Amsterdam. He is a Java technology enthusiast, evangelist, trainer, speaker, and writer. He blogs here daily.

The focus of this blog is mostly on NetBeans (a development tool primarily for Java programmers), with an occasional reference to NetBeans, and sometimes diverging to topics relating to NetBeans. And then there are days when NetBeans is mentioned, just for a change.


« August 2016