/*****************************************************************************
* 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
* Yann Tanguy (CEA LIST) yann.tanguy@cea.fr - customization for CollaborationUse
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.composite.custom.helper;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.eclipse.gef.GraphicalEditPart;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.papyrus.infra.gmfdiag.common.editpolicies.IMaskManagedLabelEditPolicy;
import org.eclipse.papyrus.uml.diagram.common.helper.StereotypedElementLabelHelper;
import org.eclipse.papyrus.uml.tools.utils.CollaborationUseUtil;
import org.eclipse.papyrus.uml.tools.utils.ICustomAppearence;
import org.eclipse.uml2.uml.CollaborationUse;
/**
* Helper for labels displaying {@link CollaborationUse} in Composite Diagram
*/
public class CollaborationUseLabelHelper extends StereotypedElementLabelHelper {
/** Single instance */
private static CollaborationUseLabelHelper labelHelper;
/** Single instance getter */
public static CollaborationUseLabelHelper getInstance() {
if(labelHelper == null) {
labelHelper = new CollaborationUseLabelHelper();
}
return labelHelper;
}
/** Map for masks */
protected final Map<Integer, String> masks = new HashMap<Integer, String>(7);
/**
* Returns the mask name given the value of the mask
*
* @return the mask name or <code>null</code> if no masks has been found
*/
public String getMaskLabel(int value) {
return masks.get(value);
}
/**
* Returns the collection of mask names
*
* @return the collection of mask names
*/
public Collection<String> getMaskLabels() {
return masks.values();
}
/**
* Returns the map of masks used to display a {@link Property}
*
* @return the {@link Map} of masks used to display a {@link Property}
*/
public Map<Integer, String> getMasks() {
return masks;
}
/**
* Returns the collection of mask values
*
* @return the collection of mask values
*/
public Set<Integer> getMaskValues() {
return masks.keySet();
}
/** Disable constructor (private) */
protected CollaborationUseLabelHelper() {
super();
// initialize the map
masks.clear();
masks.put(ICustomAppearence.DISP_VISIBILITY, "Visibility");
masks.put(ICustomAppearence.DISP_NAME, "Name");
masks.put(ICustomAppearence.DISP_TYPE, "Type");
}
/**
* {@inheritDoc}
*/
protected String elementLabel(GraphicalEditPart editPart) {
int displayValue = ICustomAppearence.DEFAULT_UML_PROPERTY;
IMaskManagedLabelEditPolicy policy = (IMaskManagedLabelEditPolicy)editPart.getEditPolicy(IMaskManagedLabelEditPolicy.MASK_MANAGED_LABEL_EDIT_POLICY);
if(policy != null) {
displayValue = policy.getCurrentDisplayValue();
}
CollaborationUse elem = getUMLElement(editPart);
if(elem != null) {
return CollaborationUseUtil.getCustomLabel(elem, displayValue);
}
return "";
}
/**
* {@inheritDoc}
*/
public CollaborationUse getUMLElement(GraphicalEditPart editPart) {
return (CollaborationUse)((View)editPart.getModel()).getElement();
}
}