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.

<table class="wysiwyg-macro" data-macro-name="excerpt" data-macro-parameters="atlassian-macro-output-type=BLOCK" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2V4Y2VycHQ6YXRsYXNzaWFuLW1hY3JvLW91dHB1dC10eXBlPUJMT0NLfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">WingsBuilder is a Groovy builder for the <a href="http://wingsframework.org">wingS Framework</a></td></tr></table>

<h2>Contribution Overview</h2>

You can use WingSBuilder in the same fashion as <a class="confluence-link" href="/display/GROOVY/Swing+Builder" data-linked-resource-id="78174" data-linked-resource-type="page" data-linked-resource-default-alias="Swing Builder" data-base-url="http://docs.codehaus.org">Swing Builder</a>. Most of the constructs provided by the original SwingBuilder are supported in WingSBuilder, thanks to the efforts of the wingS team in following the Swing model very closely. WingSBuilder also supports wingS specific components and the ability to attach your own components through <code>widget()</code> and <code>container()</code>.

The following is an example of WingSBuilder in action
<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 GuessingGame {
 GuessingGame(){
 def randomNr = (new Random().nextInt(10) + 1) as String
 def builder = new WingSBuilder()

/* STitledBorder was removed in wings-3.1
      def border = SBorderFactory.createSTitledBorder(
                    SBorderFactory.createSLineBorder([0,0,255] as Color, 2),
                    "Guessing Game")
      */
      def border = SBorderFactory.createSLineBorder([0,0,255] as Color, 2)
      def font = new SFont( null, SFont.BOLD, 14 )

def frame = builder.frame( title: "Guessing Game" ) {
         panel( border: border){
            gridLayout( columns: 1, rows: 5, vgap: 10)
            label("Hello World - this is wingS (+WingSBuilder&amp;Groovy)!",
                  font: font)
            label("We want fun, so let's play a game!" +
                  "Try to guess a number between 1 and 10.")
            textField( id: "answer" )
            button( text: "Guess!", actionPerformed: { event ->
               def value = builder.answer.text
               if( value == randomNr ){
                  builder.message.text = "Congratulations! You guessed my number!"
               }else{
                  builder.message.text = "No - '${value}' is not the right number. Try again!"
               }
            })
            label( id: "message" )
         }
      }

frame.visible = true
 }
}
</pre></td></tr></table>
Which is rendered in FireFox as <img class="confluence-embedded-image image-center" src="/download/attachments/230400779/wings-guessing-game.png?version=1&amp;modificationDate=1369119208491" data-image-src="/download/attachments/230400779/wings-guessing-game.png?version=1&amp;modificationDate=1369119208491" data-linked-resource-id="230565456" data-linked-resource-type="attachment" data-linked-resource-default-alias="wings-guessing-game.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400779" title="null > wings-guessing-game.png">

<h3>Team Members</h3>

Andres Almiray [aalmiray at users dot sourceforge dot net]

<h2>Download</h2>

<a href="http://svn.codehaus.org/gmod/wingsbuilder/trunk/dist/wingsbuilder-1.0.jar">wingsbuilder-1.0</a>

<h3>Installing</h3>

Just drop the wingsbuilder jar file along with its dependencies into your weabpp's lib directory.

<h3>Pre-requisites</h3>

WingS 3.1 and Groovy 1.5 are required to run WingSBuilder.

<h2>Documentation</h2>

<h4>Alphabetical list of SwingBuilder compatible components</h4>

<table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"> Element </th>
<th class="confluenceTh"> Class </th>
<th class="confluenceTh"> Notes </th>
</tr>
<tr>
<td class="confluenceTd"> action </td>
<td class="confluenceTd"> javax.swing.Action </td>
<td class="confluenceTd"> same as SwingBuilder.action() </td>
</tr>
<tr>
<td class="confluenceTd"> actions </td>
<td class="confluenceTd"> Collection </td>
<td class="confluenceTd"> same as SwingBuilder.actions() </td>
</tr>
<tr>
<td class="confluenceTd"> bean </td>
<td class="confluenceTd"> Object </td>
<td class="confluenceTd"> same as SwingBuilder.bean() </td>
</tr>
<tr>
<td class="confluenceTd"> borderLayout </td>
<td class="confluenceTd"> SBorderLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> boundedRangeModel </td>
<td class="confluenceTd"> SDefaultBoundedRangeModel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> boxLayout </td>
<td class="confluenceTd"> SBoxLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> button </td>
<td class="confluenceTd"> SButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> buttonGroup </td>
<td class="confluenceTd"> SButtonGroup </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> cardLayout </td>
<td class="confluenceTd"> SCardLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> checkbox </td>
<td class="confluenceTd"> SCheckbox </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> closureColumn </td>
<td class="confluenceTd"> DefaultTableColumn </td>
<td class="confluenceTd"> same as SwingBuilder.closureColumn() </td>
</tr>
<tr>
<td class="confluenceTd"> container </td>
<td class="confluenceTd"> SComponent </td>
<td class="confluenceTd"> placeholder for any SComponent </td>
</tr>
<tr>
<td class="confluenceTd"> comboBox </td>
<td class="confluenceTd"> SCombox </td>
<td class="confluenceTd"> Obeys 'items' to populate model </td>
</tr>
<tr>
<td class="confluenceTd"> dashedLineBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> desktopPane </td>
<td class="confluenceTd"> SDesktopPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> dialog </td>
<td class="confluenceTd"> SDialog </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> dottedLineBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> emptyBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> etchedBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> flowLayout </td>
<td class="confluenceTd"> SFlowLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> formattedTextField </td>
<td class="confluenceTd"> SSormattedTextField </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> frame </td>
<td class="confluenceTd"> SFrame </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> gbc </td>
<td class="confluenceTd"> GridBagConstraints </td>
<td class="confluenceTd"> same as SwingBuilder.gbc() </td>
</tr>
<tr>
<td class="confluenceTd"> gridBagConstraints </td>
<td class="confluenceTd"> GridBagConstraints </td>
<td class="confluenceTd"> same as SwingBuilder.gridBagConstraints() </td>
</tr>
<tr>
<td class="confluenceTd"> gridBagLayout </td>
<td class="confluenceTd"> SGridBagLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> gridLayout </td>
<td class="confluenceTd"> SGridLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> internalFrame </td>
<td class="confluenceTd"> SInternalFrame </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> label </td>
<td class="confluenceTd"> SLabel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> lineBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> list </td>
<td class="confluenceTd"> SList </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> loweredBeveldBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> loweredEtchedBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> menu </td>
<td class="confluenceTd"> SMenu </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> menuBar </td>
<td class="confluenceTd"> SMenuBar </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> menuItem </td>
<td class="confluenceTd"> SMenuItem </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> map </td>
<td class="confluenceTd"> java.util.Map </td>
<td class="confluenceTd"> same as SwingBuilder.map() </td>
</tr>
<tr>
<td class="confluenceTd"> optionPane </td>
<td class="confluenceTd"> SOptionPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> panel </td>
<td class="confluenceTd"> SPanel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> passwordField </td>
<td class="confluenceTd"> SPasswordField </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> popupMenu </td>
<td class="confluenceTd"> SPopupMenu </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> progressBar </td>
<td class="confluenceTd"> SProgressBar </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> propertyColumn </td>
<td class="confluenceTd"> DefaultTableColumn </td>
<td class="confluenceTd"> same as SwingBuilder.propertyColumn() </td>
</tr>
<tr>
<td class="confluenceTd"> radioButton </td>
<td class="confluenceTd"> SRadioButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> raisedBevelBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> raisedEtchedBorder </td>
<td class="confluenceTd"> SBorder </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> scrollBar </td>
<td class="confluenceTd"> SScrollBar </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> scrollPane </td>
<td class="confluenceTd"> SScrollPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> separator </td>
<td class="confluenceTd"> SSeparator </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> spinnerDateModel </td>
<td class="confluenceTd"> SSpinnerDateModel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> spinnerListModel </td>
<td class="confluenceTd"> SSpinnerListModel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> spinnerNumberModel </td>
<td class="confluenceTd"> SSpinnerNumberModel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> tabbedPane </td>
<td class="confluenceTd"> STabbedPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> table </td>
<td class="confluenceTd"> STable </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> tableModel </td>
<td class="confluenceTd"> DefaultTableModel </td>
<td class="confluenceTd"> same as SwingBuilder.tableModel() </td>
</tr>
<tr>
<td class="confluenceTd"> tableColumn </td>
<td class="confluenceTd"> STableColumn </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> textArea </td>
<td class="confluenceTd"> STextArea </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> textField </td>
<td class="confluenceTd"> STextField </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> toggleButton </td>
<td class="confluenceTd"> SToggleButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> toolBar </td>
<td class="confluenceTd"> SToolBar </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> tree </td>
<td class="confluenceTd"> STree </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> widget </td>
<td class="confluenceTd"> SComponent </td>
<td class="confluenceTd"> placeholder for any SComponent </td>
</tr>
</tbody></table>

<h4>Alphabetical list of WingS specific components</h4>

<h4>Alphabetical list of WingX specific components</h4>

<h2>Developers</h2>

Andres Almiray

<h3>Source Control</h3>

<a href="http://svn.codehaus.org/groovy-contrib/wingsbuilder">http://svn.codehaus.org/groovy-contrib/wingsbuilder</a>

<h3>Building</h3>

WingSBuilder uses Maven2 as its build tool, which means that if you want to 
build your own version of WingSBuilder from source you'll need to have it 
installed.  Follow the instructions at <a href="http://maven.apache.org">http://maven.apache.org</a> 
Once Maven2 is installed you will also need to install 2 files from the wingS 
distribution (but it wouldn't hurt to check at <a href="http://mvnrepository.org">http://mvnrepository.org</a> 
if they are already there). The files are:

wings-3.1.jar 
   wingx-3.1.jar

If the files are not found in any Maven2 repository the you'll need to 
download the source from <a href="http://wingsframework.org">http://wingsframework.org</a>, follow the compile &amp; 
install instructions, the jars should be at build/web/WEB-INF/lib 
Install them on your local Maven2 repo with the following command

mvn install:installFile -DgroupId=org.wings -Dversion=3.1 -Dpackaging=jar \ 
     -DartifactId=&lt;depname&gt; -Dfile=&lt;jarfile&gt;

where 'depname' is any of [wings, wingx] with its corresponding jarfile

<h3>Contributing</h3>

Please contact the team members by e-mail.

<h2>Community</h2>

<h3>Mailing List(s)</h3>

<a href="http://groovy.codehaus.org/Mailing+Lists">http://groovy.codehaus.org/Mailing+Lists</a>

<h3>Issue tracker</h3>

<a href="http://jira.codehaus.org/secure/BrowseProject.jspa?id=10242">http://jira.codehaus.org/secure/BrowseProject.jspa?id=10242</a>