/*****************************************************************************
* Copyright (c) 2009 CEA LIST.
*
* 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:
* Remi Schnekenburger (CEA LIST) remi.schnekenburger@cea.fr - Initial API and implementation
* Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - Adapted code from the class diagram
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.profile.custom.policies;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.ecore.EAnnotation;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.gef.GraphicalEditPart;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.papyrus.infra.emf.appearance.helper.VisualInformationPapyrusConstants;
import org.eclipse.papyrus.uml.diagram.common.editpolicies.AbstractMaskManagedEditPolicy;
import org.eclipse.papyrus.uml.diagram.common.helper.PropertyLabelHelper;
import org.eclipse.papyrus.uml.diagram.profile.custom.preferences.IPapyrusPropertyPreferencesConstant;
import org.eclipse.papyrus.uml.diagram.profile.part.UMLDiagramEditorPlugin;
import org.eclipse.papyrus.uml.tools.utils.ICustomAppearence;
import org.eclipse.uml2.uml.Property;
import org.eclipse.uml2.uml.Type;
import org.eclipse.uml2.uml.UMLPackage;
/**
* Specific edit policy for label displaying stereotypes and their properties for edges representing
* UML elements.
*/
public class PropertyLabelEditPolicy extends AbstractMaskManagedEditPolicy {
/**
* Creates a new PropertyLabelEditPolicy
*/
public PropertyLabelEditPolicy() {
super();
}
/**
* {@inheritDoc}
*/
@Override
public void addAdditionalListeners() {
super.addAdditionalListeners();
Property property = getUMLElement();
// check host semantic element is not null
if(property == null) {
return;
}
// adds a listener to the element itself, and to linked elements, like Type
if(property.getType() != null) {
getDiagramEventBroker().addNotificationListener(property.getType(), this);
}
getDiagramEventBroker().addNotificationListener(property.getUpperValue(), this);
getDiagramEventBroker().addNotificationListener(property.getLowerValue(), this);
}
/**
* {@inheritDoc}
*/
public int getCurrentDisplayValue() {
EAnnotation propertyDisplay = ((View)getHost().getModel()).getEAnnotation(VisualInformationPapyrusConstants.CUSTOM_APPEARENCE_ANNOTATION);
int displayValue = getDefaultDisplayValue();
if(propertyDisplay != null) {
displayValue = Integer.parseInt(propertyDisplay.getDetails().get(VisualInformationPapyrusConstants.CUSTOM_APPEARANCE_MASK_VALUE));
} else {
// no specific information => look in preferences
IPreferenceStore store = UMLDiagramEditorPlugin.getInstance().getPreferenceStore();
int displayValueTemp = store.getInt(IPapyrusPropertyPreferencesConstant.PROPERTY_LABEL_DISPLAY_PREFERENCE);
if(displayValueTemp != 0) {
displayValue = displayValueTemp;
}
}
return displayValue;
}
/**
* {@inheritDoc}
*/
public int getDefaultDisplayValue() {
return ICustomAppearence.DEFAULT_UML_PROPERTY;
}
/**
* {@inheritDoc}
*/
public String getMaskLabel(int value) {
return PropertyLabelHelper.getInstance().getMaskLabel(value);
}
/**
* {@inheritDoc}
*/
public Collection<String> getMaskLabels() {
return PropertyLabelHelper.getInstance().getMaskLabels();
}
/**
* {@inheritDoc}
*/
public Map<Integer, String> getMasks() {
return PropertyLabelHelper.getInstance().getMasks();
}
/**
* {@inheritDoc}
*/
public Collection<Integer> getMaskValues() {
return PropertyLabelHelper.getInstance().getMaskValues();
}
public String getPreferencePageID() {
return "org.eclipse.papyrus.uml.diagram.profile.custom.preferences.PropertyPreferencePage"; //$NON-NLS-1$
}
/**
* {@inheritDoc}
*/
@Override
public Property getUMLElement() {
return (Property)super.getUMLElement();
}
/**
* {@inheritedDoc}
*/
@Override
public void notifyChanged(Notification notification) {
super.notifyChanged(notification);
// change the label of the figure managed by the host edit part (managed by the parent edit
// part in general...)
// it must be changed only if:
// - the annotation corresponding to the display of the stereotype changes
// - the stereotype application list has changed
Object object = notification.getNotifier();
Property property = getUMLElement();
if(object == null || property == null) {
return;
}
if(notification.getFeature().equals(UMLPackage.eINSTANCE.getLiteralInteger_Value())) {
refreshDisplay();
} else if(notification.getFeature().equals(UMLPackage.eINSTANCE.getLiteralUnlimitedNatural_Value())) {
refreshDisplay();
}
if(object.equals(property)) {
notifyPropertyChanged(property, notification);
} else if(object.equals(property.getType())) {
notifyPropertyTypeChanged(property.getType(), notification);
}
if(isMaskManagedAnnotation(object)) {
refreshDisplay();
}
if(isRemovedMaskManagedLabelAnnotation(object, notification)) {
refreshDisplay();
}
}
/**
* notifies that the the property has changed.
*
* @param property
* the property that has changed
* @param notification
* the notification send when the element has been changed
*/
protected void notifyPropertyChanged(Property property, Notification notification) {
switch(notification.getFeatureID(Property.class)) {
case UMLPackage.PROPERTY__NAME:
case UMLPackage.PROPERTY__VISIBILITY:
case UMLPackage.PROPERTY__IS_DERIVED:
case UMLPackage.PROPERTY__DEFAULT_VALUE:
case UMLPackage.PROPERTY__SUBSETTED_PROPERTY:
case UMLPackage.PROPERTY__REDEFINED_PROPERTY:
case UMLPackage.PROPERTY__IS_ORDERED:
case UMLPackage.PROPERTY__IS_UNIQUE:
case UMLPackage.PROPERTY__IS_READ_ONLY:
refreshDisplay();
break;
case UMLPackage.PROPERTY__TYPE:
case UMLPackage.PROPERTY__LOWER:
case UMLPackage.PROPERTY__LOWER_VALUE:
case UMLPackage.PROPERTY__UPPER:
case UMLPackage.PROPERTY__UPPER_VALUE:
switch(notification.getEventType()) {
// if it is added => adds listener to the type element
case Notification.ADD:
getDiagramEventBroker().addNotificationListener((EObject)notification.getNewValue(), this);
refreshDisplay();
// if it is removed => removes listener from the type element
break;
case Notification.ADD_MANY: // should never happen
if(notification.getNewValue() instanceof List<?>) {
List<?> addedElements = (List<?>)notification.getNewValue();
for(Object addedElement : addedElements) {
if(addedElement instanceof EObject) {
getDiagramEventBroker().addNotificationListener((EObject)addedElement, this);
}
}
}
refreshDisplay();
break;
case Notification.REMOVE:
getDiagramEventBroker().removeNotificationListener((EObject)notification.getOldValue(), this);
refreshDisplay();
break;
case Notification.REMOVE_MANY: // should never happen
if(notification.getOldValue() instanceof List<?>) {
List<?> removedElements = (List<?>)notification.getOldValue();
for(Object removedElement : removedElements) {
if(removedElement instanceof EObject) {
getDiagramEventBroker().removeNotificationListener((EObject)removedElement, this);
}
}
}
refreshDisplay();
break;
// if it is set, remove the old one and adds the new one. this is the method use when
// the type is set or removed...
case Notification.SET:
if(notification.getOldValue() != null) {
getDiagramEventBroker().removeNotificationListener((EObject)notification.getOldValue(), this);
}
if(notification.getNewValue() != null) {
getDiagramEventBroker().addNotificationListener((EObject)notification.getNewValue(), this);
}
refreshDisplay();
default:
break;
}
break;
default:
// does nothing in other cases
break;
}
}
/**
* notifies that the type of the property has changed.
*
* @param type
* the type of the property that has changed
* @param notification
* the notification send when the element has been changed
*/
protected void notifyPropertyTypeChanged(Type type, Notification notification) {
switch(notification.getFeatureID(Property.class)) {
case UMLPackage.TYPE__NAME:
refreshDisplay(); // type name has changed => refresh the property display
break;
default:
// does nothing by default
break;
}
}
/**
* Refreshes the display of the edit part
*/
@Override
public void refreshDisplay() {
// calls the helper for this edit Part
PropertyLabelHelper.getInstance().refreshEditPartDisplay((GraphicalEditPart)getHost());
}
/**
* {@inheritDoc}
*/
@Override
protected void removeAdditionalListeners() {
super.removeAdditionalListeners();
Property property = getUMLElement();
if(property == null) {
// check semantic element is not null and this is really an instance of Property
return;
}
if(property.getType() != null) {
getDiagramEventBroker().removeNotificationListener(property.getType(), this);
}
getDiagramEventBroker().removeNotificationListener(property.getUpperValue(), this);
getDiagramEventBroker().removeNotificationListener(property.getLowerValue(), this);
}
}