/* $Id: PropPanelLink.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.beans.PropertyChangeEvent;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import javax.swing.Action;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JList;
import javax.swing.JScrollPane;
import org.argouml.i18n.Translator;
import org.argouml.model.Model;
import org.argouml.model.UmlChangeEvent;
import org.argouml.uml.ui.ActionNavigateNamespace;
import org.argouml.uml.ui.UMLComboBox2;
import org.argouml.uml.ui.UMLComboBoxModel2;
import org.argouml.uml.ui.UMLComboBoxNavigator;
import org.argouml.uml.ui.UMLLinkedList;
import org.argouml.uml.ui.UMLSearchableComboBox;
import org.argouml.uml.ui.foundation.core.PropPanelModelElement;
import org.argouml.uml.ui.foundation.extension_mechanisms.ActionNewStereotype;
import org.argouml.ui.UndoableAction;
/**
* The properties panel for a Link.
* @deprecated in 0.31.2 by Bob Tarling This is replaced by the XML property
* panels module
*/
@Deprecated
public class PropPanelLink extends PropPanelModelElement {
private JComboBox associationSelector;
private UMLLinkAssociationComboBoxModel associationComboBoxModel =
new UMLLinkAssociationComboBoxModel();
/**
* Construct a property panel for a Link element.
*/
public PropPanelLink() {
super("label.link", lookupIcon("Link"));
addField(Translator.localize("label.name"),
getNameTextField());
addField(Translator.localize("label.namespace"),
getNamespaceSelector());
addField(Translator.localize("label.association"),
getAssociationSelector());
addSeparator();
JList connectionList =
new UMLLinkedList(new UMLLinkConnectionListModel());
JScrollPane connectionScroll = new JScrollPane(connectionList);
addField(Translator.localize("label.connections"),
connectionScroll);
addAction(new ActionNavigateNamespace());
addAction(new ActionNewStereotype());
addAction(getDeleteAction());
}
/**
* Returns the namespace selecter. This is a component which allows the
* user to select a single item as the namespace.
*
* @return a component for selecting the namespace
*/
protected JComponent getAssociationSelector() {
if (associationSelector == null) {
associationSelector =
new UMLSearchableComboBox(
associationComboBoxModel,
new ActionSetLinkAssociation(), true);
}
return new UMLComboBoxNavigator(
Translator.localize("label.association.navigate.tooltip"),
associationSelector);
}
/**
* The UID.
*/
private static final long serialVersionUID = 8861148331491989705L;
} /* end class PropPanelLink */
/**
* The model for the combobox to show the Association of the Link.
*
* @author Michiel
*/
class UMLLinkAssociationComboBoxModel extends UMLComboBoxModel2 {
/**
* Constructor for UMLModelElementNamespaceComboBoxModel.
*/
public UMLLinkAssociationComboBoxModel() {
super("assocation", true);
}
/*
* @see org.argouml.uml.ui.UMLComboBoxModel2#isValidElement(Object)
*/
protected boolean isValidElement(Object o) {
return Model.getFacade().isAAssociation(o);
}
/**
* To simplify implementation, we list all associations
* found with any of the Classifiers
* represented by the linked Instances. <p>
*
* TODO: Make a foolproof algorithm that only allows selecting associations
* that create a correct model. Also take into account n-ary associations
* and associationclasses. This algo best goes in the model subsystem, e.g.
* in a method getAllPossibleAssociationsForALink().
*
* @see org.argouml.uml.ui.UMLComboBoxModel2#buildModelList()
*/
protected void buildModelList() {
Collection linkEnds;
Collection associations = new HashSet();
Object t = getTarget();
if (Model.getFacade().isALink(t)) {
linkEnds = Model.getFacade().getConnections(t);
Iterator ile = linkEnds.iterator();
while (ile.hasNext()) {
Object instance = Model.getFacade().getInstance(ile.next());
Collection c = Model.getFacade().getClassifiers(instance);
Iterator ic = c.iterator();
while (ic.hasNext()) {
Object classifier = ic.next();
Collection ae =
Model.getFacade().getAssociationEnds(classifier);
Iterator iae = ae.iterator();
while (iae.hasNext()) {
Object associationEnd = iae.next();
Object association =
Model.getFacade().getAssociation(associationEnd);
associations.add(association);
}
}
}
}
setElements(associations);
}
/*
* @see org.argouml.uml.ui.UMLComboBoxModel2#getSelectedModelElement()
*/
protected Object getSelectedModelElement() {
if (Model.getFacade().isALink(getTarget())) {
return Model.getFacade().getAssociation(getTarget());
}
return null;
}
/*
* @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
*/
@Override
public void modelChanged(UmlChangeEvent evt) {
/*
* Rebuild the list from scratch to be sure it's correct.
*/
Object t = getTarget();
if (t != null
&& evt.getSource() == t
&& evt.getNewValue() != null) {
buildModelList();
/* In some cases (se issue 3780) the list remains the same, but
* the selected item differs. Without the next step,
* the combo would not be refreshed.
*/
setSelectedItem(getSelectedModelElement());
}
}
/**
* The UID.
*/
private static final long serialVersionUID = 3232437122889409351L;
}
class ActionSetLinkAssociation extends UndoableAction {
/**
* Constructor for ActionSetModelElementNamespace.
*/
public ActionSetLinkAssociation() {
super(Translator.localize("Set"), null);
// Set the tooltip string:
putValue(Action.SHORT_DESCRIPTION, Translator.localize("Set"));
}
/*
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent e) {
super.actionPerformed(e);
Object source = e.getSource();
Object oldAssoc = null;
Object newAssoc = null;
Object link = null;
if (source instanceof UMLComboBox2) {
UMLComboBox2 box = (UMLComboBox2) source;
Object o = box.getTarget();
if (Model.getFacade().isALink(o)) {
link = o;
oldAssoc = Model.getFacade().getAssociation(o);
}
Object n = box.getSelectedItem();
if (Model.getFacade().isAAssociation(n)) {
newAssoc = n;
}
}
if (newAssoc != oldAssoc && link != null && newAssoc != null) {
Model.getCoreHelper().setAssociation(link, newAssoc);
}
}
/**
* The UID.
*/
private static final long serialVersionUID = 6168167355078835252L;
}