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">JideBuilder is a Groovy builder for the open source <a href="http://jide-oss.dev.java.net">JIDE Common Layer</a> </td></tr></table>

<table class="wysiwyg-macro" data-macro-name="warning" data-macro-parameters="title=Warning" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3dhcm5pbmc6dGl0bGU9V2FybmluZ30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">
JideBuilder has been relocated to the <a href="http://griffon.codehaus.org">Griffon</a> project, please update your links to <a href="http://griffon.codehaus.org/JideBuilder">http://griffon.codehaus.org/JideBuilder</a>. The information on this page may be outdated.</td></tr></table>

<h2>Contribution Overview</h2>

JideBuilder will let you create Jide components and standard Swing components as SwingBuilder does, because it doesn't override the default names of previously registered components in SwingBuilder, this means that you can mix both types of components with the same builder.
<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 griffon.builder.jide.JideBuilder

def jide = new JideBuilder()
jide.edt {
 frame( id: 'frame', title: 'JideBuilder', pack: true, visible: true ){
 panel( layout: new BorderLayout(5,5) ){
 button( label: "Swing", constraints: BorderLayout.WEST )
 jideButton( label: "Jide", constraints: BorderLayout.EAST )
 textField( constraints: BorderLayout.NORTH )
 calculator( constraints: BorderLayout.CENTER )
 }
}
</pre></td></tr></table>
There are 5 *Searchable components that will add searching capabilities to a previously created widget or an internal one, exposing the searchable widget and the searchable wrapper if an 'id' attribute was provided, for example ComboBoxSearchable:
<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 griffon.builder.jide.JideBuilder

def jide = new JideBuilder()
jide.edt {
 frame( id: 'frame', title: 'JideBuilder', pack: true, visible: true ){
 panel( layout: new BorderLayout(5,5) ){
 comboBox( id: "mycombo", items: [1,2,3] )
 comboBoxSearchable( id: "c1", comboBox: mycombo )
 comboBoxSearchable( id: "c2", items: [4,5,6] )
 }
}
assertNotNull jide.ci_searchable
</pre></td></tr></table>
JIDE Common Layer defines a basic structure for dialogs with StandardDialog, which is an abstract class, you may create your own dialogs based on that template by calling 'standardDialog()', by default all 3 panels will be empty, but yout can provide your own content by calling 'dialogBannerPanel()', 'dialogContentPanel()' and 'dialogButtonPanel()' inside its closure.

All JTextComponents (even those created with regular SwingBuilder methods) will accept a 'selectAll' property, which will call com.jidesoft.swing.SelectAllUtils.install() on the component. 
SearchableBar has an additional property 'install' which will register a SearchableBar.Installer automatically into the inmediate container. This property must be a Map and may have the following properties:
<ul>
	<li>constraints: must be a valid Object accepted by the container's layout (required).</li>
	<li>keyStroke: must be a javax.swing.KeyStroke, defaults to CTRL + F (optional).</li>
</ul>

<h3>Team Members</h3>

Andres Almiray [aalmiray at users dot sourceforge dot net]

<h2>Download</h2>

<a href="http://docs.codehaus.org/download/attachments/34701376/jidebuilder-2.0-binary.zip">jidebuilder-2.0</a>

<h3>Installing</h3>

Drop jidebuilder-2.0 into $GROOVY_HOME/lib along with is dependencies
<ul>
	<li><a href="http://jide-oss.dev.java.net">jide-oss-2.3.0</a></li>
	<li><a href="https://svgsalamander.dev.java.net">svg-salamander-1.0</a></li>
</ul>

<h3>Pre-requisites</h3>

Groovy 1.6-beta-2 is the required minimum version to run JideBuilder 2.0 
Previous versions of JideBuilder will run with earlier versions of Groovy, it is recommended that you upgrade to the 1.6.x series in order to take advantage of
<ul>
	<li>@Bindable and ASTTransformations</li>
	<li>short binding syntax</li>
	<li>numerous enhancements made to SwingBuilder and FactoryBuilderSupport</li>
</ul>

<h2>Documentation</h2>

<h4>Alphabetical list of 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"> animator </td>
<td class="confluenceTd"> Animator </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> autoCompletion </td>
<td class="confluenceTd"> AutoCompletion </td>
<td class="confluenceTd"> Wraps an existing JComboBox with 'comboBox' attribute 
 Wraps an existing JTextComponent with 'textComponent' attribute 
 Will create an internal JTextField if 'textComponent' and 'comboBox' are ommitted 
 If 'textComponent' is specified (or internal JTextField is created), 'searchable' or 'list' 
 must also be specified 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> autoCompletionComboBox </td>
<td class="confluenceTd"> AutoCompletionComboBox </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> autoResizingTextArea </td>
<td class="confluenceTd"> AutoResizingTextArea </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> bannerPanel </td>
<td class="confluenceTd"> BannerPanel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> bottom </td>
<td class="confluenceTd"><ul class="alternate">
	
</ul>
</td>
<td class="confluenceTd"> JideSwingUtilities.createBottomPanel </td>
</tr>
<tr>
<td class="confluenceTd"> buttonPanel </td>
<td class="confluenceTd"> ButtonPanel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> calculator </td>
<td class="confluenceTd"> Calculator </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> center </td>
<td class="confluenceTd"><ul class="alternate">
	
</ul>
</td>
<td class="confluenceTd"> JideSwingUtilities.createCenterPanel </td>
</tr>
<tr>
<td class="confluenceTd"> checkBoxList </td>
<td class="confluenceTd"> CheckBoxList </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> checkBoxListWithSelectable </td>
<td class="confluenceTd"> CheckBoxListWithSelectable </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> checkBoxTree </td>
<td class="confluenceTd"> CheckBoxTree </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> clickThroughLabel </td>
<td class="confluenceTd"> ClickThroughLabel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> comboBoxSearchable </td>
<td class="confluenceTd"> ComboBoxSearchable </td>
<td class="confluenceTd"> Wraps an existing JComboBox with 'comboBox' attribute 
 Will create an internal JComboBox if 'comboBox' is ommitted 
 Additional attributes may be set on the wrapped component 
 Obeys 'items' when creating an internal JComboBox. </td>
</tr>
<tr>
<td class="confluenceTd"> contentContainer </td>
<td class="confluenceTd"> ContentContainer </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> dateSpinner </td>
<td class="confluenceTd"> DateSpinner </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> dialogBannerPanel </td>
<td class="confluenceTd"> DialogBannerPanel (from JideBuilder) </td>
<td class="confluenceTd"> Use it inside standardDialog </td>
</tr>
<tr>
<td class="confluenceTd"> dialogButtonPanel </td>
<td class="confluenceTd"> DialogButtonPanel (from JideBuilder) </td>
<td class="confluenceTd"> Use it inside standardDialog </td>
</tr>
<tr>
<td class="confluenceTd"> dialogContentPanel </td>
<td class="confluenceTd"> DialogContentPanel (from JideBuilder) </td>
<td class="confluenceTd"> Use it inside standardDialog </td>
</tr>
<tr>
<td class="confluenceTd"> dialogPage </td>
<td class="confluenceTd"> DefaultDialogPage (from JideBuilder) </td>
<td class="confluenceTd"> Use it inside a multiplePageDialog 
 Add a 'closure' attribute as the body of lazyInitialize() default does nothing </td>
</tr>
<tr>
<td class="confluenceTd"> fileIntelliHints </td>
<td class="confluenceTd"> FileIntelliHints </td>
<td class="confluenceTd"> Needs 'textComponent' attribute 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> folderChooser </td>
<td class="confluenceTd"> FolderChooser </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> gripper </td>
<td class="confluenceTd"> Gripper </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> headerBox </td>
<td class="confluenceTd"> HeaderBox </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideButton </td>
<td class="confluenceTd"> JideButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideBorderLayout </td>
<td class="confluenceTd"> JideBorderLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideBoxLayout </td>
<td class="confluenceTd"> JideBoxLayout </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideMenu </td>
<td class="confluenceTd"> JideMenu </td>
<td class="confluenceTd"> Use a closure with 'customize' attribute to create a PopupMenuConfigurer </td>
</tr>
<tr>
<td class="confluenceTd"> jideOptionPane </td>
<td class="confluenceTd"> JideOptionPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jidePopup </td>
<td class="confluenceTd"> JidePopup </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jidePopupMenu </td>
<td class="confluenceTd"> JidePopupMenu </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideScrollPane </td>
<td class="confluenceTd"> JideScrollPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideSplitButton </td>
<td class="confluenceTd"> JideSplitButton </td>
<td class="confluenceTd"> Use a closure with 'customize' attribute to create a PopupMenuConfigurer </td>
</tr>
<tr>
<td class="confluenceTd"> jideSplitPane </td>
<td class="confluenceTd"> JideSplitPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideTabbedPane </td>
<td class="confluenceTd"> JideTabbedPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideToggleButton </td>
<td class="confluenceTd"> JideToggleButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> jideToggleSplitButton </td>
<td class="confluenceTd"> JideToggleSplitButton </td>
<td class="confluenceTd"> Use a closure with 'customize' attribute to create a PopupMenuConfigurer </td>
</tr>
<tr>
<td class="confluenceTd"> labeledTextField </td>
<td class="confluenceTd"> LabeledTextField </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> left </td>
<td class="confluenceTd"><ul class="alternate">
	
</ul>
</td>
<td class="confluenceTd"> JideSwingUtilities.createLeftPanel </td>
</tr>
<tr>
<td class="confluenceTd"> listDataIntelliHints </td>
<td class="confluenceTd"> ListDataIntelliHints </td>
<td class="confluenceTd"> Needs 'textComponent' and 'completionList' attributes, 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> listSearchable </td>
<td class="confluenceTd"> ListSearchable </td>
<td class="confluenceTd"> Wraps an existing JList with 'list' attribute 
 Will create an internal JList if 'list' is ommitted 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> multilineLabel </td>
<td class="confluenceTd"> MultilineLabel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> multiplePageDialog </td>
<td class="confluenceTd"> MultiplePageDialog </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> multiplePageDialogPane </td>
<td class="confluenceTd"> MultiplePageDialogPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullButton </td>
<td class="confluenceTd"> NullButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullCheckBox </td>
<td class="confluenceTd"> NullCheckBox </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullJideButton </td>
<td class="confluenceTd"> NullJideButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullLabel </td>
<td class="confluenceTd"> NullLabel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullPanel </td>
<td class="confluenceTd"> NullPanel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullRadioButton </td>
<td class="confluenceTd"> NullRadioButton </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> nullTristateCheckBox </td>
<td class="confluenceTd"> NullTristateCheckBox </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> paintPanel </td>
<td class="confluenceTd"> PaintPanel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> pointSpinner </td>
<td class="confluenceTd"> PointSpinner </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> popupMenuCustomizer </td>
<td class="confluenceTd"> DefaultPopupMenuCustomizer (from JideBuilder) </td>
<td class="confluenceTd"> Use 'closure' attribute to define the body of customize() </td>
</tr>
<tr>
<td class="confluenceTd"> rangeSlider </td>
<td class="confluenceTd"> RangeSlider </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> resizableDialog </td>
<td class="confluenceTd"> ResizableDialog </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> resizableFrame </td>
<td class="confluenceTd"> ResizableFrame </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> resizablePanel </td>
<td class="confluenceTd"> ResizablePanel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> resizableWindow </td>
<td class="confluenceTd"> ResizableWindow </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> right </td>
<td class="confluenceTd"><ul class="alternate">
	
</ul>
</td>
<td class="confluenceTd"> JideSwingUtilities.createRightPanel </td>
</tr>
<tr>
<td class="confluenceTd"> searchableBar </td>
<td class="confluenceTd"> SearchableBar </td>
<td class="confluenceTd"> Wraps an existing Searchable with 'searchable' attribute 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> simpleScrollPane </td>
<td class="confluenceTd"> SimpleScrollPane </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> splitButtonGroup </td>
<td class="confluenceTd"> SplitButtonGroup </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> standardDialog </td>
<td class="confluenceTd"> DefaultStandardDialog (from JideBuilder) </td>
<td class="confluenceTd"> Use 'dialogBannerPanel, 'dialodContentPanel' and 'dialogButtonPanel' 
 to provide additional configuration for each panel </td>
</tr>
<tr>
<td class="confluenceTd"> styledLabel </td>
<td class="confluenceTd"> StyledLabel </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> tableSearchable </td>
<td class="confluenceTd"> TableSearchable </td>
<td class="confluenceTd"> Wraps an existing JTable with 'table' attribute 
 Will create an internal JTable if 'table' is ommitted 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> textComponentSearchable </td>
<td class="confluenceTd"> TextComponentSearchable </td>
<td class="confluenceTd"> Wraps an existing JTextComponent with 'textComponent' attribute 
 Will create an internal JTextField if 'textComponent' is ommitted 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> top </td>
<td class="confluenceTd"><ul class="alternate">
	
</ul>
</td>
<td class="confluenceTd"> JideSwingUtilities.createTopPanel </td>
</tr>
<tr>
<td class="confluenceTd"> treeSearchable </td>
<td class="confluenceTd"> TreeSearchable </td>
<td class="confluenceTd"> Wraps an existing JTree with 'tree' attribute 
 Will create an internal JTree if 'tree' is ommitted 
 Additional attributes may be set on the wrapped component </td>
</tr>
<tr>
<td class="confluenceTd"> tristateCheckBox </td>
<td class="confluenceTd"> TristateCheckBox </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> svgIcon </td>
<td class="confluenceTd"> ResizableSVGIcon </td>
<td class="confluenceTd"><ul>
	<li>path: same as svgResourcePath but allows aliases</li>
	<li>trackSize: enables/disables resizing (default: false)</li>
	<li>resizePercentage: controls how much the icon will change size, value must be in range 10..100 (default: 100)</li>
	<li>retainAspectRatio: controls how resizing will take effect (default: true)</li>
	<li>size: alias for 'preferredSize'</li>
</ul>
</td>
</tr>
</tbody></table>

<h2>Developers</h2>

Andres Almiray

<h3>Source Control</h3>

<a href="http://svn.codehaus.org/griffon/builders/jidebuilder">http://svn.codehaus.org/griffon/builders/jidebuilder</a>

<h3>Building</h3>

JideBuilder uses Ant as its build tool, which means that if you want to 
build your own version of JideBuilder from source you'll need to have it 
installed. Follow the instructions at <a href="http://ant.apache.org">http://ant.apache.org</a>

<h3>Contributing</h3>

Please contact the team members by e-mail.

<h2>Community</h2>

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

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

<h3>Issue tracker</h3>

<a href="http://jira.codehaus.org/browse/GRIFFON">http://jira.codehaus.org/browse/GRIFFON</a>