/* $Id: PropPanelModelElement.java 18022 2010-02-16 08:24:42Z 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-2008 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.foundation.core;
import java.awt.Component;
import java.util.ArrayList;
import java.util.List;
import javax.swing.Action;
import javax.swing.ImageIcon;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextField;
import org.argouml.i18n.Translator;
import org.argouml.kernel.UmlModelMutator;
import org.argouml.model.InvalidElementException;
import org.argouml.model.Model;
import org.argouml.ui.TabModelTarget;
import org.argouml.ui.targetmanager.TargetManager;
import org.argouml.uml.ui.PropPanel;
import org.argouml.uml.ui.ScrollList;
import org.argouml.uml.ui.UMLComboBoxNavigator;
import org.argouml.uml.ui.UMLDerivedCheckBox;
import org.argouml.uml.ui.UMLMutableLinkedList;
import org.argouml.uml.ui.UMLPlainTextDocument;
import org.argouml.uml.ui.UMLSearchableComboBox;
import org.argouml.uml.ui.UMLTextField2;
/**
* The properties panel for a modelelement.
* @deprecated By Bob Tarling in 0.29.2. All property panels are now to be
* built using the UML panels.
* subsystem.
*/
@Deprecated
public abstract class PropPanelModelElement extends PropPanel implements TabModelTarget {
private JComboBox namespaceSelector;
private JScrollPane supplierDependencyScroll;
private JScrollPane clientDependencyScroll;
private JScrollPane targetFlowScroll;
private JScrollPane sourceFlowScroll;
private JScrollPane constraintScroll;
private JPanel visibilityPanel;
private JScrollPane elementResidenceScroll;
private JTextField nameTextField;
private UMLModelElementNamespaceComboBoxModel namespaceComboBoxModel =
new UMLModelElementNamespaceComboBoxModel();
private static UMLModelElementClientDependencyListModel
clientDependencyListModel =
new UMLModelElementClientDependencyListModel();
private static UMLModelElementConstraintListModel constraintListModel =
new UMLModelElementConstraintListModel();
private static UMLModelElementElementResidenceListModel
elementResidenceListModel =
new UMLModelElementElementResidenceListModel();
private static UMLModelElementNameDocument nameDocument =
new UMLModelElementNameDocument();
private static UMLModelElementSourceFlowListModel sourceFlowListModel =
new UMLModelElementSourceFlowListModel();
private static UMLModelElementTargetFlowListModel targetFlowListModel =
new UMLModelElementTargetFlowListModel();
// private JScrollPane templateParameterScroll;
//
// private UMLModelElementTemplateParameterListModel templateParameterListModel
// = new UMLModelElementTemplateParameterListModel();
//
// private UMLModelElementTemplateBindingComboBoxModel
// templateBindingComboBoxModel;
//
// private JComboBox templateBindingSelector;
/**
* The constructor.
*
* @param name the name of the properties panel
* @param icon the icon
*/
public PropPanelModelElement(String name, ImageIcon icon) {
super(name, icon);
}
/**
* Constructor that is used if no other proppanel can be found for a
* modelelement of some kind. Since this is the default
*/
public PropPanelModelElement() {
this("label.model-element-title", (ImageIcon) null);
addField("label.name",
getNameTextField());
addField("label.namespace",
getNamespaceSelector());
addSeparator();
addField("label.supplier-dependencies",
getSupplierDependencyScroll());
addField("label.client-dependencies",
getClientDependencyScroll());
addField("label.source-flows",
getSourceFlowScroll());
addField("label.target-flows",
getTargetFlowScroll());
addSeparator();
addField("label.constraints",
getConstraintScroll());
add(getVisibilityPanel());
addField("label.derived",
new UMLDerivedCheckBox());
}
/*
* @see org.argouml.uml.ui.PropPanel#setTarget(java.lang.Object)
*/
@Override
public void setTarget(Object target) {
super.setTarget(target);
/* This for e.g. a CommentEdge: */
if (Model.getFacade().isAUMLElement(target)) {
boolean enable = false;
try {
enable = !Model.getModelManagementHelper().isReadOnly(target);
} catch (InvalidElementException e) {
// enable remains false if this element was deleted
}
for (final Component component : getComponents()) {
if (component instanceof JScrollPane) {
Component c =
((JScrollPane) component).getViewport().getView();
if (c.getClass().isAnnotationPresent(
UmlModelMutator.class)) {
c.setEnabled(enable);
}
} else if (!(component instanceof JLabel)
&& component.isEnabled() != enable) {
/* See issue 5289. */
component.setEnabled(enable);
}
}
}
}
/**
* This overrides the behaviour of the base class to filter out any
* actions that could be used to attempt to modify the UML model on
* a readonly element.
* @return The list of actions to show for this panel.
*/
@Override
protected final List getActions() {
List actions = super.getActions();
if (Model.getFacade().isAUMLElement(getTarget())
&& Model.getModelManagementHelper().isReadOnly(getTarget())) {
final List<Action> filteredActions = new ArrayList<Action>(2);
for (Object o : actions) {
if (o instanceof Action && !o.getClass().isAnnotationPresent(
UmlModelMutator.class)) {
filteredActions.add((Action) o);
}
}
return filteredActions;
} else {
return actions;
}
}
/**
* Calling this method navigates the target one level up, to the owner of
* the current target. In most cases this navigates to the owning namespace.
* In some cases it navigates to, for example, the owning composite state
* for some simple state.
*/
public void navigateUp() {
TargetManager.getInstance().setTarget(
Model.getFacade().getModelElementContainer(getTarget()));
}
/**
* Returns the namespace selector. 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 getNamespaceSelector() {
if (namespaceSelector == null) {
namespaceSelector = new UMLSearchableComboBox(
namespaceComboBoxModel,
new ActionSetModelElementNamespace(), true);
}
return new UMLComboBoxNavigator(
Translator.localize("label.namespace.navigate.tooltip"),
namespaceSelector);
}
/**
* @return a scrollpane for supplier dependency
*/
protected JComponent getSupplierDependencyScroll() {
if (supplierDependencyScroll == null) {
JList list = new UMLMutableLinkedList(
new UMLModelElementSupplierDependencyListModel(),
new ActionAddSupplierDependencyAction(),
null,
null,
true);
supplierDependencyScroll = new JScrollPane(list);
}
return supplierDependencyScroll;
}
/**
* @return a scrollpane for client dependency
*/
protected JComponent getClientDependencyScroll() {
if (clientDependencyScroll == null) {
JList list = new UMLMutableLinkedList(
clientDependencyListModel,
new ActionAddClientDependencyAction(),
null,
null,
true);
clientDependencyScroll = new JScrollPane(list);
}
return clientDependencyScroll;
}
/**
* @return a scrollpane for target flow
*/
protected JComponent getTargetFlowScroll() {
if (targetFlowScroll == null) {
targetFlowScroll = new ScrollList(targetFlowListModel);
}
return targetFlowScroll;
}
/**
* @return a scrollpane for source flow
*/
protected JComponent getSourceFlowScroll() {
if (sourceFlowScroll == null) {
sourceFlowScroll = new ScrollList(sourceFlowListModel);
}
return sourceFlowScroll;
}
/**
* @return a scrollpane for constraints
*/
protected JComponent getConstraintScroll() {
if (constraintScroll == null) {
JList constraintList = new UMLMutableLinkedList(
constraintListModel, null,
ActionNewModelElementConstraint.getInstance());
constraintScroll = new JScrollPane(constraintList);
}
return constraintScroll;
}
/**
* @return a panel for the visibility
*/
protected JComponent getVisibilityPanel() {
if (visibilityPanel == null) {
visibilityPanel =
new UMLModelElementVisibilityRadioButtonPanel(
Translator.localize("label.visibility"), true);
}
return visibilityPanel;
}
/**
* @return a scrollpane for residence
*/
protected JComponent getElementResidenceScroll() {
if (elementResidenceScroll == null) {
elementResidenceScroll = new ScrollList(elementResidenceListModel);
}
return elementResidenceScroll;
}
/**
* @return a textfield for the name
*/
protected JComponent getNameTextField() {
if (nameTextField == null) {
nameTextField = new UMLTextField2(nameDocument);
}
return nameTextField;
}
/**
* Returns the document (model) for the name. Only used for the
* PropPanelComment.
*
* @return Document
*/
protected UMLPlainTextDocument getNameDocument() {
return nameDocument;
}
/**
* @return a scrollpane for template parameters
*/
// protected JComponent getTemplateParameterScroll() {
// if (templateParameterScroll == null) {
//
// templateParameterScroll = new ScrollList(
// templateParameterListModel, false, false);
//
// // TODO: Use some kind of list to allow user to select type for
// // new parameters to be added
//// JList list = new UMLMutableLinkedList(
//// templateParameterListModel,
//// new ActionAddClientDependencyAction(),
//// null,
//// null,
//// true);
//// templateParameterScroll = new JScrollPane(list);
// }
// return templateParameterScroll;
// }
/**
* Returns the template selector. This is a component which allows the
* user to select a single item as the template to be used.
*
* @return a component for selecting the template binding
*/
// protected JComponent getTemplateBindingSelector() {
// if (templateBindingSelector == null) {
// templateBindingSelector = new UMLSearchableComboBox(
// templateBindingComboBoxModel,
// new ActionSetModelElementTemplateBinding(), true);
// }
// return new UMLComboBoxNavigator(
// Translator.localize("label.namespace.navigate.tooltip"),
// templateBindingSelector);
// }
}