/* $Id: PropPanelPartition.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) 2004-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.activity_graphs;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.swing.JComponent;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import org.argouml.i18n.Translator;
import org.argouml.model.Model;
import org.argouml.uml.ui.AbstractActionAddModelElement2;
import org.argouml.uml.ui.ActionNavigateContainerElement;
import org.argouml.uml.ui.UMLModelElementListModel2;
import org.argouml.uml.ui.UMLMutableLinkedList;
import org.argouml.uml.ui.foundation.core.PropPanelModelElement;
import org.argouml.uml.ui.foundation.extension_mechanisms.ActionNewStereotype;
/**
* The properties panel for a Partition (Swimlane).
*
* @author mkl
*/
public class PropPanelPartition extends PropPanelModelElement {
private JScrollPane contentsScroll;
private JPanel activityGraphScroll;
private static UMLPartitionContentListModel contentListModel =
new UMLPartitionContentListModel("contents");
/**
* constructor.
*/
public PropPanelPartition() {
super("label.partition-title", lookupIcon("Partition"));
addField(Translator.localize("label.name"), getNameTextField());
activityGraphScroll =
getSingleRowScroll(new UMLPartitionActivityGraphListModel());
addField(Translator.localize("label.activity-graph"),
getActivityGraphField());
addSeparator();
addField(Translator.localize("label.contents"), getContentsField());
addAction(new ActionNavigateContainerElement());
addAction(new ActionNewStereotype());
addAction(getDeleteAction());
}
/**
* This field intentionally allows to do far more things
* than would be possible by dragging elements in or out
* of the FigPartition. <p>
*
* E.g. if you only use dragging, then an element belongs to
* at most one partition, a logical presumption.
* The ActionAddPartitionContent however,
* allows modifying the model in such way that
* elements belong to more than one partition,
* which is not prohibited by the UML standard. <p>
*
* These extra possibilities are needed e.g. to amend
* a model loaded in XMI format.
*
* @return a textfield for the name
*/
protected JComponent getContentsField() {
if (contentsScroll == null) {
JList contentList = new UMLMutableLinkedList(
contentListModel,
new ActionAddPartitionContent(),
null);
contentsScroll = new JScrollPane(contentList);
}
return contentsScroll;
}
protected JPanel getActivityGraphField() {
return activityGraphScroll;
}
class ActionAddPartitionContent extends AbstractActionAddModelElement2 {
public ActionAddPartitionContent() {
super();
setMultiSelect(true);
}
@Override
protected void doIt(Collection selected) {
Object partition = getTarget();
if (Model.getFacade().isAPartition(partition)) {
Model.getActivityGraphsHelper().setContents(
partition, selected);
}
}
protected List getChoices() {
List ret = new ArrayList();
if (Model.getFacade().isAPartition(getTarget())) {
Object partition = getTarget();
Object ag = Model.getFacade().getActivityGraph(partition);
if (ag != null) {
Object top = Model.getFacade().getTop(ag);
/* There are no composite states, so this will work: */
ret.addAll(Model.getFacade().getSubvertices(top));
}
}
return ret;
}
protected String getDialogTitle() {
return Translator.localize("dialog.title.add-contents");
}
protected List getSelected() {
List ret = new ArrayList();
ret.addAll(Model.getFacade().getContents(getTarget()));
return ret;
}
}
}
class UMLPartitionContentListModel extends UMLModelElementListModel2 {
public UMLPartitionContentListModel(String name) {
super(name);
}
protected void buildModelList() {
Object partition = getTarget();
setAllElements(Model.getFacade().getContents(partition));
}
protected boolean isValidElement(Object element) {
if (!Model.getFacade().isAModelElement(element)) {
return false;
}
Object partition = getTarget();
return Model.getFacade().getContents(partition).contains(element);
}
}
class UMLPartitionActivityGraphListModel extends UMLModelElementListModel2
{
/**
* Constructor for UMLStateVertexIncomingListModel.
*/
public UMLPartitionActivityGraphListModel() {
super("activityGraph");
}
/*
* @see org.argouml.uml.ui.UMLModelElementListModel2#buildModelList()
*/
protected void buildModelList() {
removeAllElements();
addElement(Model.getFacade().getActivityGraph(getTarget()));
}
/*
* @see org.argouml.uml.ui.UMLModelElementListModel2#isValidElement(Object)
*/
protected boolean isValidElement(Object element) {
return Model.getFacade().getActivityGraph(getTarget()) == element;
}
}