/**

  * Copyright (C) 2006 Philipp Mpalampanis

  *

  * License: MPL 1.1/GPL 2.0/LGPL 2.1

  *

  * The contents of this file are subject to the Mozilla Public License Version

  * 1.1 (the "License"); you may not use this file except in compliance with

  * the License. You may obtain a copy of the License at

  * http://www.mozilla.org/MPL/

  *

  * Software distributed under the License is distributed on an "AS IS" basis,

  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License

  * for the specific language governing rights and limitations under the

  * License.

  *

  * Alternatively, the contents of this file may be used under the terms of

  * either the GNU General Public License Version 2 or later (the "GPL"), or

  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),

  * in which case the provisions of the GPL or the LGPL are applicable instead

  * of those above. If you wish to allow use of your version of this file only

  * under the terms of either the GPL or the LGPL, and not to allow others to

  * use your version of this file under the terms of the MPL, indicate your

  * decision by deleting the provisions above and replace them with the notice

  * and other provisions required by the GPL or the LGPL. If you do not delete

  * the provisions above, a recipient may use your version of this file under

  * the terms of any one of the MPL, the GPL or the LGPL.

  */

 package net.sf.echobinding.controls;

 import java.beans.PropertyChangeEvent;

 import java.beans.PropertyChangeListener;

 import java.util.ArrayList;

 import java.util.Collection;

 import net.sf.echobinding.BoundControl;

 import net.sf.echobinding.binding.BindingContext;

 import net.sf.echobinding.decorator.Decorator;

 import net.sf.echobinding.validation.*;

 import nextapp.echo2.app.event.*;

 import nextapp.echo2.app.list.ListModel;

 /**

  * 

  */

 public class SelectField extends nextapp.echo2.app.SelectField implements

                 BoundControl, ActionListener, PropertyChangeListener {

         private static final long serialVersionUID = -3593733868533261539L;

         private BindingContext _ctx;

         private String _id;

         private String _itemsAdapterId;

         private ArrayList<Object> _listItems;

         private Collection<Object> _items;

         private ValidationHandler _validationHandler;

         /**

          * creates a data bound select field

          * 

          * @param adapterId

          * @param context

          */

         public SelectField(String adapterId, Object[] items, BindingContext context) {

                 super(items);

                 _id = adapterId;

                 setBindingConext(context);

                 setActionCommand( adapterId );

         }

         /**

          * Creates a data bound select field

          * 

          * @param bindingId

          * @param context

          */

         public SelectField(String bindingId, ListModel model, BindingContext context) {

                 super(model);

                 _id = bindingId;

                 _ctx = context;

         }

         /**

          * creates a data bound select field

          * 

          * @param adapterId

          * @param itemsAdapterId

          * @param context

          */

         public SelectField(String adapterId, String itemsAdapterId,

                         BindingContext context) {

                 super();

                 _id = adapterId;

                 _itemsAdapterId = itemsAdapterId;

                 setActionCommand( adapterId );

                 addActionListener(this);

                 addPropertyChangeListener(this);

                 context.addPropertyChangeListener(SELECTION_CHANGED_PROPERTY, this);

                 setBindingConext(context);

         }

         /* (non-Javadoc)

          * @see echobinding.BoundControl#setBindingConext(echobinding.BindingContext)

          */

         public void setBindingConext(BindingContext context) {

                 if(context == null)        return;

                 if( _ctx != null) _ctx.removeControl(this);

                 context.registerControl( _id, this);

                 _ctx = context;

                 update();

         }

         /*

          * (non-Javadoc)

          * 

          * @see echobinding.BoundControl#setBindingId(java.lang.String)

          */

         public void setAdapterId(String adapterId) {

                 _id = adapterId;

         }

         /*

          * (non-Javadoc)

          * 

          * @see echobinding.BoundControl#loadValues()

          */

         @SuppressWarnings("unchecked")

         public void update() {

                 assert(_ctx != null);

                 // load the selected value 

                 Object value = _ctx.getValue(_id);

                 // load the items collection 

                 _items = (Collection<Object>) _ctx

                                                 .getValue(_itemsAdapterId);

                 if (_items == null) { 

                         // in case of list dependency, items may be null

                         _items = new ArrayList<Object>();

                 }

                 //_listItems = new ArrayList<Object>(_items);

                 _listItems = new ArrayList<Object>();

                 _listItems.add("");        // explicitly add an empty option (workaround for bug in Mozilla/FireFox) 

                 _listItems.addAll(_items);

                 // get the selected item

                 Object selectedItem = null;

                 for (Object item : _listItems) {

                         if (item.equals(value))

                                 selectedItem = item;

                 }

                 if (selectedItem != null) {

                         int index = _listItems.indexOf(selectedItem);

                         if( getSelectedIndex() != index )

                                 setSelectedIndex( index );

                 }

                 final Decorator decorator = _ctx.getDecorator(_itemsAdapterId);

                 ListModel model = new ListModel() {

                         private static final long serialVersionUID = -6693815714661801487L;

                         public void removeListDataListener(ListDataListener arg0) {

                         }

                         public int size() {

                                 return _listItems.size();

                         }

                         public Object get(int i) {

                                 return decorator.decorate(_listItems.get(i));

                         }

                         public void addListDataListener(ListDataListener arg0) {

                         }

                 };

                 setModel(model);

         }

         /*

          * (non-Javadoc)

          * 

          * @see echobinding.BoundControl#saveValues()

          */

         public void save() {

                 if(getSelectedIndex() == -1)

                         _ctx.setValue(_id, null);

                 else

                         _ctx.setValue(_id, _listItems.get(getSelectedIndex()));

         }        

         /*

          * (non-Javadoc)

          * 

          * @see echobinding.BoundControl#isValid()

          */

         public boolean isValid() {

                 return createValidationReport().isValid();

         }

         /*

          * (non-Javadoc)

          * 

          * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)

          */

         public void propertyChange(PropertyChangeEvent event) {

                 if (SELECTION_CHANGED_PROPERTY.equals(event.getPropertyName())) {

                         Object value = _ctx.getValue( _itemsAdapterId );

                         if( value != null && ! value.equals( _items ) ) {

                                 update();

                         }

                 }

         }

         /*

          * (non-Javadoc)

          * 

          * @see nextapp.echo2.app.event.ActionListener#actionPerformed(nextapp.echo2.app.event.ActionEvent)

          */

         public void actionPerformed(ActionEvent event) {

                 fireSelectionChange();

         }

         /**

          * 

          */

         private void fireSelectionChange() {

                 int selectedIndex = getSelectedIndex();

                 int minListIndex = 1;        // due to bug in firefox/mozilla (added empty item on position 0)

                 if (selectedIndex >= minListIndex) {

                         PropertyChangeEvent selectionChangeEvent = new PropertyChangeEvent(

                                         this, SELECTION_CHANGED_PROPERTY, null, _listItems

                                                         .get(selectedIndex));

                         _ctx.propertyChange(selectionChangeEvent);

                 }

         }

         @Override

         public String toString() {

                 return super.toString()+"#"+_id;

         }

         @Override

         public void setSelectedIndex(int index) {

                 super.setSelectedIndex(index);

                 fireSelectionChange();

         }

         /* 

          * Validates the control's input and invokes the validation handler.

          * 

          * @see echobinding.BoundControl#validateInput()

          */

         public void validateInput() {

                 ValidationReport validationReport = createValidationReport();

                 setToolTipText(validationReport.getMessage());

                 invokeValidationHandler(validationReport);

         }

         /**

          * @return

          */

         private ValidationReport createValidationReport() {

                 ValidationReport validationReport;

                 Object value = getSelectedIndex() == -1 ? null : _listItems.get(getSelectedIndex());

                 validationReport = _ctx.validate(_id, value);

                 return validationReport;

         }

         /**

          * @param validationReport

          */

         private void invokeValidationHandler(ValidationReport validationReport) {

                 initValidationHandler();

                 if(validationReport.isValid())

                         _validationHandler.markValid(this);

                 else

                         _validationHandler.markInvalid(this);

         }

         /**

          * Initializes the validation handler 

          *

          */

         private void initValidationHandler() {

                 if( _validationHandler == null ) {

                         _validationHandler = _ctx.getValidationHandler(_id);

                         if( _validationHandler == null )

                                 _validationHandler = new DefaultValidationHandler(this);

                 }

         }

         /* (non-Javadoc)

          * @see echobinding.BoundControl#isDirty()

          */

         public boolean isDirty() {

                 if(getSelectedIndex() == -1)

                         return _ctx.isDirty(_id, null);

                 else

                         return _ctx.isDirty(_id, _listItems.get(getSelectedIndex()));

         }

         /* (non-Javadoc)

          * @see echobinding.BoundControl#getValue()

          */

         public Object getValue() {

                 if(getSelectedIndex() < 0)

                         return null;

                 return _listItems.get(getSelectedIndex());

         }

         /* (non-Javadoc)

          * @see echobinding.BoundControl#setValue(java.lang.Object)

          */

         public void setValue(Object value) {

                 if( value==null ) { 

                         setSelectedIndex( 0 );

                         return;

                 }

                 setSelectedIndex( _listItems.indexOf( value ) );

         }

 }