Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>To wrap up our overview of AST transformations, let's finish by speaking about two transformations very useful to Swing developers: @Bindable and @Vetoable.     When creating Swing UIs, you're often interested in monitoring the changes of value of certain UI elements.     For this purpose, the usual approach is to use JavaBeans PropertyChangeListeners to be notified when the value of a class field changes.     You then end up writing this very common boiler-plate code in your Java beans:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;

public class MyBean {
    private String prop;

PropertyChangeSupport pcs = new PropertyChangeSupport(this);

public void addPropertyChangeListener(PropertyChangeListener l) {
        pcs.add(l);
    }

public void removePropertyChangeListener(PropertyChangeListener l) {
        pcs.remove(l);
    }

public String getProp() {
        return prop;
    }

public void setProp(String prop) {
        pcs.firePropertyChanged("prop", this.prop, this.prop = prop);
    }
}
</pre></td></tr></table>
<p>Fortunately, with Groovy and the @Bindable annotation, this code can be greatly simplified:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
class MyBean {
    @Bindable String prop
}
</pre></td></tr></table>
<p>Now pair that with Groovy's Swing builder new bind() method, define a text field and bind its value to a property of your data model:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
textField text: bind(source: myBeanInstance, sourceProperty: 'prop')
</pre></td></tr></table>
<p>Or even:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
textField text: bind { myBeanInstance.prop }
</pre></td></tr></table>
<p>The binding also works with simple expressions in the closure, for instance something like this is possible too:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
bean location: bind { pos.x + ', ' + pos.y }
</pre></td></tr></table>
<p>You may also be interested in having a look at ObservableMap and ObservableList, for a similar mechanism on maps and lists.</p>

<p>Along with @Bindable, there's also a @Vetoable transformation for when you need to be able to veto some property change.     Let's consider a Trompetist class, where the performer's name is not allowed to contain the letter 'z':</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import java.beans.*
import groovy.beans.Vetoable

class Trumpetist {
    @Vetoable String name
}

def me = new Trumpetist()
me.vetoableChange = { PropertyChangeEvent pce ->
    if (pce.newValue.contains('z'))
        throw new PropertyVetoException("The letter 'z' is not allowed in a name", pce)
}

me.name = "Louis Armstrong"

try {
    me.name = "Dizzy Gillespie"
    assert false: "You should not be able to set a name with letter 'z' in it."
} catch (PropertyVetoException pve) {
    assert true
}
</pre></td></tr></table>
<p>Looking at a more thorough Swing builder example with binding:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import groovy.swing.SwingBuilder
import groovy.beans.Bindable
import static javax.swing.JFrame.EXIT_ON_CLOSE

class TextModel {
    @Bindable String text
}

def textModel = new TextModel()

SwingBuilder.build {
    frame( title: 'Binding Example (Groovy)', size: [240,100], show: true,
          locationRelativeTo: null, defaultCloseOperation: EXIT_ON_CLOSE ) {
        gridLayout cols: 1, rows: 2
        textField id: 'textField'
        bean textModel, text: bind{ textField.text }
        label text: bind{ textModel.text }
    }
}
</pre></td></tr></table>
<p>Running this script shows up a frame with a text field and a lable below, and the label's text is bound on the text field's content.</p>

<p>SwingBuilder has evolved so nicely in the past year that the Groovy Swing team decided to launch a new project based on it,     and on the Grails foundations: project Griffon was born.     Griffon proposes to bring the <em>Convention over Configuration</em> paradigm of Grails,     as well as all its project structure, plugin system, gant scripting capabilities, etc.</p>

<p>If you are developing Swing rich clients, make sure to have a look at <a href="http://griffon.codehaus.org">Griffon</a>.</p>