org.metawidget.swt.widgetbuilder.SwtWidgetBuilder Maven / Gradle / Ivy
// Metawidget
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package org.metawidget.swt.widgetbuilder;
import static org.metawidget.inspector.InspectionResultConstants.*;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Scale;
import org.eclipse.swt.widgets.Spinner;
import org.eclipse.swt.widgets.Text;
import org.metawidget.swt.Stub;
import org.metawidget.swt.SwtMetawidget;
import org.metawidget.swt.SwtValuePropertyProvider;
import org.metawidget.swt.widgetprocessor.binding.BindingConverter;
import org.metawidget.util.ClassUtils;
import org.metawidget.util.CollectionUtils;
import org.metawidget.util.WidgetBuilderUtils;
import org.metawidget.widgetbuilder.iface.WidgetBuilder;
import org.metawidget.widgetbuilder.iface.WidgetBuilderException;
/**
* WidgetBuilder for SWT environments.
*
* Creates native SWT Controls, such as Text and Combo, to
* suit the inspected fields.
*
* @author Richard Kennard
*/
public class SwtWidgetBuilder
implements WidgetBuilder, SwtValuePropertyProvider {
//
// Public methods
//
public String getValueProperty( Control control ) {
if ( control instanceof Text || control instanceof Combo ) {
return "text";
}
if ( control instanceof Spinner || control instanceof Scale || control instanceof Button ) {
return "selection";
}
return null;
}
public Control buildWidget( String elementName, Map attributes, SwtMetawidget metawidget ) {
// Hidden
if ( TRUE.equals( attributes.get( HIDDEN ) ) ) {
return new Stub( metawidget.getCurrentLayoutComposite(), SWT.NONE );
}
// Action
if ( ACTION.equals( elementName ) ) {
Button button = new Button( metawidget.getCurrentLayoutComposite(), SWT.NONE );
button.setText( metawidget.getLabelString( attributes ) );
return button;
}
String type = WidgetBuilderUtils.getActualClassOrType( attributes );
// If no type, assume a String
if ( type == null ) {
type = String.class.getName();
}
// Lookup the Class
Class clazz = ClassUtils.niceForName( type );
// Support mandatory Booleans (can be rendered as a checkbox, even though they have a
// Lookup)
if ( Boolean.class.equals( clazz ) && TRUE.equals( attributes.get( REQUIRED ) ) ) {
return new Button( metawidget.getCurrentLayoutComposite(), SWT.CHECK );
}
// Lookups
String lookup = attributes.get( LOOKUP );
if ( lookup != null && !"".equals( lookup ) ) {
Combo comboDropDown = new Combo( metawidget.getCurrentLayoutComposite(), SWT.READ_ONLY );
// Add an empty choice (if nullable, and not required)
if ( WidgetBuilderUtils.needsEmptyLookupItem( attributes ) ) {
comboDropDown.add( "" );
}
List values = CollectionUtils.fromString( lookup );
BindingConverter converter = metawidget.getWidgetProcessor( BindingConverter.class );
for ( String value : values ) {
// Convert (if supported)
Object convertedValue;
if ( converter == null ) {
convertedValue = value;
} else {
convertedValue = converter.convertFromString( value, clazz );
}
comboDropDown.add( String.valueOf( convertedValue ) );
}
// Vanilla SWT doesn't support differing Combo values and labels (JFace does)
return comboDropDown;
}
if ( clazz != null ) {
// Primitives
if ( clazz.isPrimitive() ) {
// booleans
if ( boolean.class.equals( clazz ) ) {
return new Button( metawidget.getCurrentLayoutComposite(), SWT.CHECK );
}
// chars
if ( char.class.equals( clazz )) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
// Ranged
String minimumValue = attributes.get( MINIMUM_VALUE );
String maximumValue = attributes.get( MAXIMUM_VALUE );
if ( minimumValue != null && !"".equals( minimumValue ) && maximumValue != null && !"".equals( maximumValue ) ) {
Scale scale = new Scale( metawidget.getCurrentLayoutComposite(), SWT.NONE );
scale.setMinimum( Integer.parseInt( minimumValue ) );
scale.setSelection( scale.getMinimum() );
scale.setMaximum( Integer.parseInt( maximumValue ) );
return scale;
}
// Not-ranged
if ( byte.class.equals( clazz ) ) {
Spinner spinner = new Spinner( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
byte value = 0;
byte minimum = Byte.MIN_VALUE;
byte maximum = Byte.MAX_VALUE;
if ( minimumValue != null && !"".equals( minimumValue ) ) {
minimum = Byte.parseByte( minimumValue );
value = (byte) Math.max( value, minimum );
}
if ( maximumValue != null && !"".equals( maximumValue ) ) {
maximum = Byte.parseByte( maximumValue );
value = (byte) Math.min( value, maximum );
}
setSpinnerModel( spinner, value, minimum, maximum, (byte) 1 );
return spinner;
} else if ( short.class.equals( clazz ) ) {
Spinner spinner = new Spinner( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
short value = 0;
short minimum = Short.MIN_VALUE;
short maximum = Short.MAX_VALUE;
if ( minimumValue != null && !"".equals( minimumValue ) ) {
minimum = Short.parseShort( minimumValue );
value = (short) Math.max( value, minimum );
}
if ( maximumValue != null && !"".equals( maximumValue ) ) {
maximum = Short.parseShort( maximumValue );
value = (short) Math.min( value, maximum );
}
setSpinnerModel( spinner, value, minimum, maximum, (short) 1 );
return spinner;
} else if ( int.class.equals( clazz ) ) {
Spinner spinner = new Spinner( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
int value = 0;
int minimum = Integer.MIN_VALUE;
int maximum = Integer.MAX_VALUE;
if ( minimumValue != null && !"".equals( minimumValue ) ) {
minimum = Integer.parseInt( minimumValue );
value = Math.max( value, minimum );
}
if ( maximumValue != null && !"".equals( maximumValue ) ) {
maximum = Integer.parseInt( maximumValue );
value = Math.min( value, maximum );
}
setSpinnerModel( spinner, value, minimum, maximum, 1 );
return spinner;
} else if ( long.class.equals( clazz ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
} else if ( float.class.equals( clazz ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
} else if ( double.class.equals( clazz ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
throw WidgetBuilderException.newException( "Unknown primitive " + clazz );
}
// Strings
if ( String.class.equals( clazz ) ) {
if ( TRUE.equals( attributes.get( MASKED ) ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.PASSWORD | SWT.BORDER );
}
if ( TRUE.equals( attributes.get( LARGE ) ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.MULTI | SWT.BORDER | SWT.V_SCROLL | SWT.WRAP );
}
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
// Characters
if ( Character.class.isAssignableFrom( clazz )) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
// Dates
if ( Date.class.equals( clazz ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
// Numbers
//
// Note: we use a text field, not a Spinner or Scale, because we need to be able to
// convey 'null'
if ( Number.class.isAssignableFrom( clazz ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
// Collections
if ( Collection.class.isAssignableFrom( clazz ) ) {
return new Stub( metawidget.getCurrentLayoutComposite(), SWT.NONE );
}
}
// Not simple, but don't expand
if ( TRUE.equals( attributes.get( DONT_EXPAND ) ) ) {
return new Text( metawidget.getCurrentLayoutComposite(), SWT.BORDER );
}
// Nested Metawidget
return null;
}
//
// Private methods
//
/**
* Sets the JSpinner model.
*
* By default, a JSpinner calls setColumns upon setModel. For numbers
* like Integer.MAX_VALUE and Double.MAX_VALUE, this can be very large
* and mess up the layout. Here, we reset setColumns to 0.
*
* Note it is very important we set the initial value of the JSpinner to the same
* type as the property it maps to (eg. float or double, int or long).
*/
private void setSpinnerModel( Spinner spinner, int selection, int minimum, int maximum, int increment ) {
spinner.setMinimum( minimum );
spinner.setMaximum( maximum );
spinner.setSelection( selection );
spinner.setIncrement( increment );
}
}