/* $Id: UMLObjectFlowStateClassifierComboBoxModel.java 17883 2010-01-12 21:11:38Z linus $

  *****************************************************************************

  * Copyright (c) 2009 Contributors - see below

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *    bobtarling

  *****************************************************************************

  *

  * Some portions of this file was previously release using the BSD License:

  */

 // Copyright (c) 1996-2006 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.activity_graphs;

 import java.beans.PropertyChangeEvent;

 import java.util.ArrayList;

 import java.util.Collection;

 import org.argouml.kernel.ProjectManager;

 import org.argouml.model.Model;

 import org.argouml.model.UmlChangeEvent;

 import org.argouml.uml.ui.UMLComboBoxModel2;

 /**

  * A model for the type of an ObjectFlowState.

  * This combo shows the Classifier or the ClassifierInState! 

  * 

  * @since Oct 10, 2002

  * @author jaap.branderhorst@xs4all.nl, alexb

  */

 public class UMLObjectFlowStateClassifierComboBoxModel

     extends UMLComboBoxModel2 {

     /**

      * Constructor.

      */

     public UMLObjectFlowStateClassifierComboBoxModel() {

         super("type", false);

     }

     /*

      * @see org.argouml.uml.ui.UMLComboBoxModel2#isValidElement(Object)

      */

     protected boolean isValidElement(Object o) {

         return Model.getFacade().isAClassifier(o);

     }

     /**

      * Get all Classifiers that are not ClassifierInState.

      * 

      * @see org.argouml.uml.ui.UMLComboBoxModel2#buildModelList()

      */

     protected void buildModelList() {

         Object model =

             ProjectManager.getManager().getCurrentProject().getModel();

         Collection newList = 

             new ArrayList(Model.getCoreHelper().getAllClassifiers(model));

         // get the current type - normally we won't need this, but who knows?

         if (getTarget() != null) {

             Object type = Model.getFacade().getType(getTarget());

             if (type != null)

                 if (!newList.contains(type)) newList.add(type);

         }

         setElements(newList);

     }

     /**

      * Returns a Classifier that may be a ClassifierInState.

      * 

      * {@inheritDoc}

      */

     protected Object getSelectedModelElement() {

         if (getTarget() != null) {

             return Model.getFacade().getType(getTarget());

         }

         return null;

     }

     /**

      * The function in the parent removes items from the list when deselected.

      * We do not need that here.

      * 

      * @param evt

      *            A PropertyChangeEvent object describing the event source and

      *            the property that has changed.

      */

     public void modelChanged(UmlChangeEvent evt) {

         buildingModel = true;

         buildModelList();

         buildingModel = false;

         setSelectedItem(getSelectedModelElement());

     }

 }