org.eclipse.gmf.runtime.diagram.ui/src/org/eclipse/gmf/runtime/diagram/ui/internal/editparts/DiagramNameCompartmentEditPart.java

/******************************************************************************
 * Copyright (c) 2004, 2007 IBM Corporation and others.
 * 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:
 *    IBM Corporation - initial API and implementation 
 ****************************************************************************/

package org.eclipse.gmf.runtime.diagram.ui.internal.editparts;

import org.eclipse.draw2d.PositionConstants;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.transaction.RunnableWithResult;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.gef.EditPolicy;
import org.eclipse.gef.commands.Command;
import org.eclipse.gef.requests.GroupRequest;
import org.eclipse.gmf.runtime.common.core.util.Log;
import org.eclipse.gmf.runtime.common.core.util.Trace;
import org.eclipse.gmf.runtime.common.ui.services.icon.IconOptions;
import org.eclipse.gmf.runtime.common.ui.services.icon.IconService;
import org.eclipse.gmf.runtime.diagram.core.internal.commands.CreateDiagramLinkCommand;
import org.eclipse.gmf.runtime.diagram.core.util.ViewUtil;
import org.eclipse.gmf.runtime.diagram.ui.commands.ICommandProxy;
import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
import org.eclipse.gmf.runtime.diagram.ui.editparts.TextCompartmentEditPart;
import org.eclipse.gmf.runtime.diagram.ui.editpolicies.ComponentEditPolicy;
import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIDebugOptions;
import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIPlugin;
import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIStatusCodes;
import org.eclipse.gmf.runtime.diagram.ui.l10n.DiagramUIMessages;
import org.eclipse.gmf.runtime.diagram.ui.label.ILabelDelegate;
import org.eclipse.gmf.runtime.emf.core.util.EMFCoreUtil;
import org.eclipse.gmf.runtime.emf.core.util.EObjectAdapter;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.swt.graphics.Image;

/**
 * Name compartment for NalDiagramView elements.  
 * This compartment is not editable. 
 * 
 * @author jcorchis
 */
public class DiagramNameCompartmentEditPart extends TextCompartmentEditPart {
	
	private IconOptions iconOptions;
	protected static final int ICON_INDEX = 0;
	protected static final int NUM_ICONS = 1;	

	/**
	 * @param view
	 */
	public DiagramNameCompartmentEditPart(View view) {
		super(view);
		iconOptions = new IconOptions();
		iconOptions.set(IconOptions.GET_STEREOTYPE_IMAGE_FOR_ELEMENT);
		iconOptions.set(IconOptions.NO_DEFAULT_STEREOTYPE_IMAGE);
		setNumIcons(NUM_ICONS);
	}
    
    protected ILabelDelegate createLabelDelegate() {
        ILabelDelegate labelDelegate = super.createLabelDelegate();
        labelDelegate.setIconAlignment(PositionConstants.TOP);
        labelDelegate.setTextAlignment(PositionConstants.TOP);
        labelDelegate.setAlignment(PositionConstants.TOP);
        labelDelegate.setTextWrapOn(true);
        labelDelegate.setTextJustification(PositionConstants.CENTER);
        return labelDelegate;
    }
        
    public void activate() {
        super.activate();
        EObject semanticProxy = getElement();
        if (semanticProxy != null && !semanticProxy.eIsProxy()) {
            addSemanticListeners();
        }
    }

    /** Return the semantic element associated to this editpart. */
    public EObject resolveSemanticElement() {
        try {
            return (EObject) getEditingDomain().runExclusive(
                new RunnableWithResult.Impl() {

                public void run() {
                    View primary = getPrimaryView();
                    if (primary != null)
                        setResult(ViewUtil.resolveSemanticElement(primary));
                }
            });
        } catch (InterruptedException e) {
               Trace.catching(DiagramUIPlugin.getInstance(),
                DiagramUIDebugOptions.EXCEPTIONS_CATCHING, getClass(),
                "resolveSemanticElement", e); //$NON-NLS-1$
                Log.error(DiagramUIPlugin.getInstance(),
                    DiagramUIStatusCodes.IGNORED_EXCEPTION_WARNING,
                    "resolveSemanticElement", e); //$NON-NLS-1$
            return null;
        }
    }
    
    /**
     * Helper method to get the element of this view. 
     * 
     * @return
     */
    private EObject getElement() {
        // This uses the primary view only because that is what
        // {@link #resolveSemanticElement()} uses and I am
        // assuming this was done for some reason.
        View primary = getPrimaryView();
        if (primary != null) {
            return primary.getElement();
        }
        return null;
    }

    /**
     * Returns the icon image associated with the diagram.
     * @param the 
     * @return Image
     */
    protected Image getLabelIcon(int i) {
        EObject element = getElement();
        if (element != null)
            return IconService.getInstance().getIcon(
                new EObjectAdapter(element));
        return null;
    }
    
    /**
     * @return <tt>false</tt> 
     */
    protected boolean isEditable() { 
        return false; 
    }
    
    /**
     * Selectable if the parent edit part is not a DiagramLinkEditPart.
     *  @return <tt>false</tt> if the parent is a DiagramLinkEditPart.
     */
    public boolean isSelectable() {
        return false;
    }
    
    public void createDefaultEditPolicies() {
        super.createDefaultEditPolicies();
        installEditPolicy(EditPolicy.COMPONENT_ROLE,
                new DiagramLinkComponentEditPolicy());  
    }
    
    protected void setVisibility(boolean vis) {
        super.setVisibility(vis && getElement() != null);
    }

    private class DiagramLinkComponentEditPolicy extends ComponentEditPolicy {
        
        /**
         * Returns a command to set the model to null. 
         */
        public Command createDeleteViewCommand(GroupRequest request) {
            
            TransactionalEditingDomain editingDomain = ((IGraphicalEditPart) getHost())
                .getEditingDomain();
            
            CreateDiagramLinkCommand com = new CreateDiagramLinkCommand(editingDomain,
                DiagramUIMessages.Command_CreateDiagramLink,
                    (View)getHost().getParent().getModel(), 
                    null);
            return new ICommandProxy(com);
        }
    }
    
    /**
     * Overridden so that the name of the diagram will still be displayed even
     * if the element is unresolved.
     */
    protected String getLabelText() {
        String label = super.getLabelText();
        if (label == null) {
            EObject element = getElement();
            if (element != null) {
                return EMFCoreUtil.getName(element);
            }
        }
        return label;
    }
}