// $Id: UMLInitialValueComboBox.java,v 1.34 2004/09/14 20:12:16 mvw Exp $
// Copyright (c) 1996-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.uml.ui;
import java.awt.Color;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JComboBox;

import org.argouml.model.ModelFacade;
import org.argouml.model.uml.UmlFactory;

import ru.novosoft.uml.MElementEvent;

/**
 * Handles communication between the initial value JComboBox and the
 * Collection.  This class also causes NSUML to refresh and so keeps
 * the diagram in synch with the model.
 *
 * Method PropertySet listens for MElementEvent events and updates the
 * other elements, such as type, visibility and changeability.
 * Modified psager@tigris.org
 *
 * @deprecated as of ArgoUml 0.13.5 (10-may-2003), to be replaced by
 * something similar to {@link
 * org.argouml.uml.ui.foundation.core.UMLAttributeInitialValueListModel},
 * this class is part of the 'old'(pre 0.13.*) implementation of
 * proppanels that used reflection a lot.
 */
public class UMLInitialValueComboBox extends JComboBox 
             implements ActionListener, UMLUserInterfaceComponent {

    private UMLUserInterfaceContainer theContainer;

    /** Prevent event storms through not generating unnecessary events */
    private boolean isUpdating = false;
    
/** items in the initial value combobox that are available for selection.*/    
    private String[] listItems = {"", "0", "1", "2", "null"};

    /** 
     * Creates new BooleanChangeListener.
     * 
     * @param container the container of UML user interface components
     */
    public UMLInitialValueComboBox(UMLUserInterfaceContainer container) {
        super();
        setBackground(Color.green.brighter());
        theContainer = container;
        
        for (int i = 0; i < listItems.length; i++) {
            addItem(listItems[i]);
        }
	setEditable(true);

/** handles ActionEvents from the combobox. The action listener was not handling
 *  events from the combo box properly, so I moved it up to the constructor, 
 *  where it works fine. I guess the best alternative would be to create an
 *  inner class for the listener. The listener sets the value from the combo
 *  box into the collection, and then calls update() to refresh the drawing so
 *  that it stays in synch with the model.
 * 
 *      Modified psager@tigris.org Aug.6, 2001 to handle method parameter
 *      expressions.
 */
        addActionListener(new ActionListener() {
            public void actionPerformed(final ActionEvent event) {
		if (isUpdating) {
		    return;
		}

                String item = (String) getSelectedItem();
                Object target = theContainer.getTarget();
                if (org.argouml.model.ModelFacade.isAAttribute(target)) {
                    Object/*MExpression*/ itemExpr =
			UmlFactory.getFactory().getDataTypes()
			    .createExpression("Java", item);
                    ModelFacade.setInitialValue(target, itemExpr);
                    update();
                }
                else if (org.argouml.model.ModelFacade.isAParameter(target)) {
                    Object/*MExpression*/ itemExpr =
			UmlFactory.getFactory().getDataTypes()
			    .createExpression("Java", item);
                    ModelFacade.setDefaultValue(target, itemExpr);
                    update();
                }
            }
        }); //...end of action listener...
        
    }   //...end of constructor...
    
    /** 
     * On change of target (when we display the Parameter or Attribute
     * property panel) we set the initial value of the attribute into
     * the UMLInitialValueComboBox.
     *
     * If the attribute or the parameter has no value, then clear the
     * initialValue combobox of residual junk..this is also done to
     * keep from setting residual values into the return parameter.
     *
     * @author psager@tigris.org Aug. 31, 2001. Modified Sept. 05, 2001
     */ 
    public void targetChanged() {
        Object target = theContainer.getTarget();
	isUpdating = true;
        if (org.argouml.model.ModelFacade.isAAttribute(target)) {
            Object/*MExpression*/ initExpr =
		ModelFacade.getInitialValue(target);
            if (initExpr != null) {
                Object init = ModelFacade.getBody(initExpr);
                setSelectedItem(init);
                //update();
            }
            else if (initExpr == null) {
                setSelectedItem(null); // clear residual junk from the
				       // combo box.
            }
        } 
        else if (ModelFacade.isAParameter(target)) {
            Object/*MExpression*/ initExpr =
		ModelFacade.getDefaultValue(target);
            if (initExpr != null) {
                Object init = ModelFacade.getBody(initExpr);
                setSelectedItem(init);
                //update();
            }
            else if (initExpr == null) {
                setSelectedItem(null); // clear the previous value
				       // from the combo box.
            }
        }
	isUpdating = false;
    }
    

    /**
     * @see org.argouml.uml.ui.UMLUserInterfaceComponent#targetReasserted()
     */
    public void targetReasserted() {
    }

    /**
     * @see ru.novosoft.uml.MElementListener#roleAdded(ru.novosoft.uml.MElementEvent)
     */
    public void roleAdded(final MElementEvent p1) {
    }
    
    /**
     * @see ru.novosoft.uml.MElementListener#recovered(ru.novosoft.uml.MElementEvent)
     */
    public void recovered(final MElementEvent p1) {
    }
    
    /**
     * @see ru.novosoft.uml.MElementListener#roleRemoved(ru.novosoft.uml.MElementEvent)
     */
    public void roleRemoved(final MElementEvent p1) {
    }
    
    /**
     * @see ru.novosoft.uml.MElementListener#listRoleItemSet(ru.novosoft.uml.MElementEvent)
     */
    public void listRoleItemSet(final MElementEvent p1) {
    }
    
    /**
     * @see ru.novosoft.uml.MElementListener#removed(ru.novosoft.uml.MElementEvent)
     */
    public void removed(final MElementEvent p1) {
    }

    /**
     * Event handler for MElement events generated by the
     * attribute/parameter property panels and the diagram.

     *
     * The event name is used to identify whether the event should be
     * handled here or not. eventProp "owner" and "name" are handled
     * elsewhere while eventProp "type" and "initValue" are handled
     * here.
     *
     * @param event the event object that identifies the event
     */
    public void propertySet(final MElementEvent event) {
        String eventProp = event.getName();
        if (eventProp.equals("owner") || eventProp.equals("name")) {
            return;
        }
	if ("initialValue".equals(eventProp) 
	    || "defaultValue".equals(eventProp))
	    targetChanged();
//	else
//	    update();
    } 
    
/** updates the diagram. It first has to locate it's target element and then
 *  causes the update to take place so that the diagram stays in synch with
 *  the model. 
 *  @author psager@tigris.org   Aug. 30, 2001
 */    
    private void update() {
        Object target = theContainer.getTarget();
        if (ModelFacade.isAAttribute(target)) {
            Object classifier = ModelFacade.getOwner(target);
            if (classifier == null) {
                return;
            }
            ModelFacade.setFeatures(classifier,
				    ModelFacade.getFeatures(classifier));
        }
        else if (ModelFacade.isAParameter(target)) {
            if (ModelFacade.isACallEvent(target)) {
                return;
            }
            Object feature = ModelFacade.getBehavioralFeature(target);
            if (feature != null) {
                Object classifier = ModelFacade.getOwner(feature);
                if (classifier == null) {
                    return;
                }
                ModelFacade.setFeatures(classifier,
					ModelFacade.getFeatures(classifier));
            }
        }
    }   // ...end of update() method...
    

} //...end of class...