/* $Id: PropPanelCallAction.java 18591 2010-07-29 00:36:56Z bobtarling $
*****************************************************************************
* 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-2007 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.common_behavior;
import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import org.argouml.i18n.Translator;
import org.argouml.model.AttributeChangeEvent;
import org.argouml.model.Model;
import org.argouml.model.UmlChangeEvent;
import org.argouml.ui.targetmanager.TargetManager;
import org.argouml.uml.ui.UMLComboBox2;
import org.argouml.uml.ui.UMLComboBoxModel2;
import org.argouml.uml.ui.UMLComboBoxNavigator;
import org.argouml.uml.ui.UMLSearchableComboBox;
import org.argouml.ui.UndoableAction;
/**
* The properties panel for a CallAction.
* @deprecated in 0.31.2 by Bob Tarling This is replaced by the XML property
* panels module
*/
@Deprecated
public class PropPanelCallAction extends PropPanelAction {
/**
* Construct a property panel for a CallAction element.
*/
public PropPanelCallAction() {
super("label.call-action", lookupIcon("CallAction"));
}
/*
* @see org.argouml.uml.ui.behavior.common_behavior.PropPanelAction#initialize()
*/
@Override
public void initialize() {
super.initialize();
UMLSearchableComboBox operationComboBox =
new UMLCallActionOperationComboBox2(
new UMLCallActionOperationComboBoxModel());
addFieldBefore(Translator.localize("label.operation"),
new UMLComboBoxNavigator(
Translator.localize("label.operation.navigate.tooltip"),
operationComboBox),
argumentsScroll);
}
private static class UMLCallActionOperationComboBox2
extends UMLSearchableComboBox {
/**
* The constructor.
*
* @param arg0 the model
*/
public UMLCallActionOperationComboBox2(UMLComboBoxModel2 arg0) {
super(arg0, new SetActionOperationAction());
setEditable(false);
}
/**
* The UID.
*/
private static final long serialVersionUID = 1453984990567492914L;
}
private static class SetActionOperationAction extends UndoableAction {
/**
* The constructor.
*/
public SetActionOperationAction() {
super("");
}
/*
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
public void actionPerformed(ActionEvent e) {
super.actionPerformed(e);
Object source = e.getSource();
if (source instanceof UMLComboBox2) {
Object selected = ((UMLComboBox2) source).getSelectedItem();
Object target = ((UMLComboBox2) source).getTarget();
if (Model.getFacade().isACallAction(target)
&& Model.getFacade().isAOperation(selected)) {
if (Model.getFacade().getOperation(target) != selected) {
Model.getCommonBehaviorHelper()
.setOperation(target, selected);
}
}
}
}
/**
* The UID.
*/
private static final long serialVersionUID = -3574312020866131632L;
}
private static class UMLCallActionOperationComboBoxModel
extends UMLComboBoxModel2 {
/**
* The constructor.
*/
public UMLCallActionOperationComboBoxModel() {
super("operation", true);
}
/**
* The list of operations shall contain
* all operations of all classifiers
* contained in the same package as the callaction itself. <p>
*
* TODO: In fact, we also should include operations of imported
* clasifiers.
*
* @see org.argouml.uml.ui.UMLComboBoxModel2#buildModelList()
*/
protected void buildModelList() {
Object target = TargetManager.getInstance().getModelTarget();
Collection ops = new ArrayList();
if (Model.getFacade().isACallAction(target)) {
Object ns = Model.getFacade().getModelElementContainer(target);
while (!Model.getFacade().isAPackage(ns)) {
ns = Model.getFacade().getModelElementContainer(ns);
if (ns == null) {
break;
}
}
if (Model.getFacade().isANamespace(ns)) {
Collection c =
Model.getModelManagementHelper()
.getAllModelElementsOfKind(
ns,
Model.getMetaTypes().getClassifier());
Iterator i = c.iterator();
while (i.hasNext()) {
ops.addAll(Model.getFacade().getOperations(i.next()));
}
}
/* To be really sure, let's add the operation
* that is linked to the action in the model,
* too - if it is not listed yet.
* We need this, incase an operation is moved
* out of the package,
* or maybe with imported XMI...
*/
Object current = Model.getFacade().getOperation(target);
if (Model.getFacade().isAOperation(current)) {
if (!ops.contains(current)) {
ops.add(current);
}
}
}
setElements(ops);
}
/*
* @see org.argouml.uml.ui.UMLComboBoxModel2#getSelectedModelElement()
*/
protected Object getSelectedModelElement() {
Object target = TargetManager.getInstance().getModelTarget();
if (Model.getFacade().isACallAction(target)) {
return Model.getFacade().getOperation(target);
}
return null;
}
/*
* @see org.argouml.uml.ui.UMLComboBoxModel2#isValidElement(java.lang.Object)
*/
protected boolean isValidElement(Object element) {
Object target = TargetManager.getInstance().getModelTarget();
if (Model.getFacade().isACallAction(target)) {
return element == Model.getFacade().getOperation(target);
}
return false;
}
/**
* The function in the parent removes items from the list
* when deselected. We do not need that here. <p>
*
* This function is only needed when another operation is connected to
* the action in the model, to select it in the combo. <p>
*
* It is e.g. not usefull to update the combo for removed operations,
* since you can only remove operations by changing the target,
* and selecting the action again re-generates the complete list.
*/
@Override
public void modelChanged(UmlChangeEvent evt) {
if (evt instanceof AttributeChangeEvent) {
if (evt.getPropertyName().equals("operation")) {
if (evt.getSource() == getTarget()
&& (getChangedElement(evt) != null)) {
Object elem = getChangedElement(evt);
setSelectedItem(elem);
}
}
}
}
/**
* The UID.
*/
private static final long serialVersionUID = 7752478921939209157L;
}
/**
* The UID.
*/
private static final long serialVersionUID = 6998109319912301992L;
}