// $Id: UMLMessageActivatorComboBoxModel.java,v 1.19 2004/09/07 18:50:07 mvw Exp $
// Copyright (c) 1996-2003 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.behavior.collaborations;

import org.argouml.model.ModelFacade;
import org.argouml.model.uml.UmlModelEventPump;
import org.argouml.model.uml.behavioralelements.collaborations.CollaborationsHelper;
import org.argouml.uml.ui.UMLComboBoxModel2;

/**
 * The model behind the UMLMessageActivatorComboBox. 
 * I don't use the UMLComboBoxModel
 * since this mixes the GUI and the model 
 * too much and is much more maintainance 
 * intensive then this implementation.
 */
public class UMLMessageActivatorComboBoxModel extends UMLComboBoxModel2 {
		


    /**
     * Constructor for UMLMessageActivatorComboBoxModel.
     */
    public UMLMessageActivatorComboBoxModel() {
        super("activator", false);
    }

    /**
     * @see org.argouml.uml.ui.UMLComboBoxModel2#buildModelList()
     */
    protected void buildModelList() {
        Object target = getTarget();
        if (org.argouml.model.ModelFacade.isAMessage(target)) {
            Object mes = /*(MMessage)*/ target;
            removeAllElements();
            // fill the list with items
            setElements(CollaborationsHelper.getHelper()
                    .getAllPossibleActivators(mes));
        }
    }

    
    /**
     * @see org.argouml.uml.ui.UMLComboBoxModel2#isValidElement(Object)
     */
    protected boolean isValidElement(Object m) {
        return ((org.argouml.model.ModelFacade.isAMessage(m))  
                && m != getTarget() 
                && !ModelFacade.getPredecessors((getTarget())).contains(m) 
                && ModelFacade.getInteraction(m) 
                    == ModelFacade.getInteraction((getTarget())));
    }

    /**
     * @see org.argouml.uml.ui.UMLComboBoxModel2#getSelectedModelElement()
     */
    protected Object getSelectedModelElement() {
        if (getTarget() != null) {
            return ModelFacade.getActivator(getTarget());
        }
        return null;
    }

    /**
     * @see org.argouml.uml.ui.UMLComboBoxModel2#setTarget(java.lang.Object)
     */
    protected void setTarget(Object target) {
        if (ModelFacade.isAMessage(getTarget())) {
            Object inter = ModelFacade.getInteraction(getTarget());
            if (inter != null)
                UmlModelEventPump.getPump().removeModelEventListener(this, 
                        inter, "message");
        }
        super.setTarget(target);
        if (ModelFacade.isAMessage(target)) {
            Object inter = ModelFacade.getInteraction(target);
            if (inter != null)
                UmlModelEventPump.getPump().addModelEventListener(this, 
                        inter, "message");
        }
    }

}