SWTDropDownListWidget.java

package org.atdl4j.ui.swt.widget;

import java.util.ArrayList;
import java.util.List;

import org.atdl4j.fixatdl.layout.DropDownListT;
import org.atdl4j.fixatdl.layout.EditableDropDownListT;
import org.atdl4j.fixatdl.layout.ListItemT;
import org.atdl4j.ui.impl.ControlHelper;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Widget;

public class SWTDropDownListWidget
		extends AbstractSWTWidget<String>
{

	private Combo dropDownList;
	private Label label;

	public Widget createWidget(Composite parent, int style)
	{
		String tooltip = getTooltip();
		GridData controlGD = new GridData( SWT.FILL, SWT.CENTER, false, false );
		
		// label
		if ( control.getLabel() != null ) {
			label = new Label( parent, SWT.NONE );
			label.setText( control.getLabel() );
			if ( tooltip != null ) label.setToolTipText( tooltip );
			controlGD.horizontalSpan = 1;
		} else {
			controlGD.horizontalSpan = 2;
		}
		
		// dropDownList
		style = style | SWT.BORDER;
		if ( control instanceof DropDownListT )
		{
			style |= SWT.READ_ONLY;
		}
		dropDownList = new Combo( parent, style );
		dropDownList.setLayoutData( controlGD );

		// dropDownList items
		java.util.List<ListItemT> listItems = ( control instanceof EditableDropDownListT ) ? ( (EditableDropDownListT) control ).getListItem()
				: ( (DropDownListT) control ).getListItem();
		// TODO: throw error if there are no list items
		for ( ListItemT listItem : listItems ) dropDownList.add( listItem.getUiRep() );

		// tooltip
		if ( tooltip != null ) dropDownList.setToolTipText( tooltip );

		// default initializer
		dropDownList.select( 0 );

		// select initValue if available
		String initValue = (String) ControlHelper.getInitValue( control, getAtdl4jOptions() );
		if ( initValue != null )
			setValue( initValue, true );

		return parent;
	}

	// Helper to get list items
	protected List<ListItemT> getListItems()
	{
		return ( control instanceof EditableDropDownListT ) ? ( (EditableDropDownListT) control ).getListItem() : ( (DropDownListT) control )
				.getListItem();
	}


	public String getControlValueRaw()
	{
		int selection = dropDownList.getSelectionIndex();
		if ( selection >= 0 )
		{
			return getListItems().get( selection ).getEnumID();
		}
		else if ( control instanceof EditableDropDownListT && dropDownList.getText() != null && dropDownList.getText() != "" )
		{
			// use the enumID if the text matches a combo box item,
			// even if the dropdown was not used to select it
			for ( int i = 0; i < dropDownList.getItems().length; i++ )
			{
				if ( dropDownList.getItems()[ i ].equals( dropDownList.getText() ) )
					return getListItems().get( i + 1 ).getEnumID();
			}
			// else use the manually entered text string
			return dropDownList.getText();
		}
		return null;
	}

	public String getParameterValue()
	{
		int selection = dropDownList.getSelectionIndex();
		if ( selection >= 0 )
			return getParameterValueAsEnumWireValue();
		if ( control instanceof EditableDropDownListT && dropDownList.getText() != null && dropDownList.getText() != "" )
		{
			// use the Parameter's Enum wireValue if the text matches a combo box
			// item, even if the dropdown was not used to select it
			for ( int i = 0; i < dropDownList.getItems().length; i++ )
			{
				if ( dropDownList.getItems()[ i ].equals( dropDownList.getText() ) )
					return getEnumWireValue( getListItems().get( i + 1 ).getEnumID() );
			}
			// else use the manually entered text string
			return dropDownList.getText();
		}
		return null;

	}

	public void setValue(String value)
	{
		this.setValue( value, false );
	}

	public void setValue(String value, boolean setValueAsControl)
	{
		for ( int i = 0; i < getListItems().size(); i++ )
		{
			if ( setValueAsControl || parameter == null )
			{
				if ( getListItems().get( i ).getEnumID().equals( value ) )
				{
					dropDownList.select( i );
					break;
				}
			}
			else
			{
				if ( parameter.getEnumPair().get( i ).getWireValue().equals( value ) )
				{
					dropDownList.select( i );
					break;
				}
			}
		}
		// TODO: needs to handle case of editable dropdown list;
	}

	public List<Control> getControls()
	{
		List<Control> widgets = new ArrayList<Control>();
		if (label != null) widgets.add( label );
		widgets.add( dropDownList );
		return widgets;
	}

	public List<Control> getControlsExcludingLabel()
	{
		List<Control> widgets = new ArrayList<Control>();
		widgets.add( dropDownList );
		return widgets;
	}

	public void addListener(Listener listener)
	{
		dropDownList.addListener( SWT.Modify, listener );
		dropDownList.addListener( SWT.Selection, listener );
	}

	public void removeListener(Listener listener)
	{
		dropDownList.removeListener( SWT.Modify, listener );
		dropDownList.removeListener( SWT.Selection, listener );
	}
	
	/* (non-Javadoc)
	 * @see org.atdl4j.ui.Atdl4jWidget#reinit()
	 */
	@Override
	public void processReinit( Object aControlInitValue )
	{
		if ( ( dropDownList != null ) && ( ! dropDownList.isDisposed() ) )
		{
			if ( aControlInitValue != null )
			{
				// -- apply initValue if one has been specified --
				setValue( (String) aControlInitValue, true );
			}
			else
			{
				// -- set to first when no initValue exists --
				if ( dropDownList.getItemCount() > 0 )
				{
					dropDownList.select( 0 );
				}
			}
		}
	}

	/* 
	 * 
	 */
	protected void processNullValueIndicatorChange(Boolean aOldNullValueInd, Boolean aNewNullValueInd)
	{
		// TODO ?? adjust the visual appearance of the control ??
	}
}