| /****************************************************************************** |
| * Copyright (c) 2002, 2006 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.editparts; |
| |
| import org.eclipse.emf.ecore.EObject; |
| import org.eclipse.emf.ecore.EStructuralFeature; |
| import org.eclipse.emf.transaction.TransactionalEditingDomain; |
| import org.eclipse.gef.EditPart; |
| import org.eclipse.gmf.runtime.diagram.core.preferences.PreferencesHint; |
| import org.eclipse.gmf.runtime.diagram.ui.internal.editparts.IEditableEditPart; |
| import org.eclipse.gmf.runtime.diagram.ui.parts.IDiagramEditDomain; |
| import org.eclipse.gmf.runtime.notation.View; |
| |
| /** |
| * @author melaasar |
| * |
| * The interface of all editparts with <code>EObject</code> as a model |
| * <B>Not indended to be implemented by clients</B>, Clients should extends GraphicalEditPart |
| */ |
| public interface IGraphicalEditPart |
| extends org.eclipse.gef.GraphicalEditPart, IEditableEditPart { |
| |
| /** |
| * Return the editpart's associated Notation View. |
| * @return <code>View</code>, the associated view or null if there is no associated Notation View |
| */ |
| public View getNotationView(); |
| |
| /** |
| * Gets the associated DiagramEditDomain to the edit part |
| * @return IDiagramEditDomain |
| */ |
| public IDiagramEditDomain getDiagramEditDomain(); |
| |
| /** |
| * Returns the first child inside this edit part that owns a view |
| * with the same type as the passed hint |
| * @param semanticHint |
| * @return IGraphicalEditPart |
| */ |
| public IGraphicalEditPart getChildBySemanticHint(String semanticHint); |
| |
| /** |
| * Method getTopGraphicEditPart. |
| * @return TopGraphicEditPart |
| */ |
| public TopGraphicEditPart getTopGraphicEditPart(); |
| |
| /** |
| * Convenience method to retreive the value for the supplied feature |
| * from the editpart's associated view element. |
| * @param feature the feature to use |
| * @return Object the value |
| */ |
| public Object getStructuralFeatureValue(EStructuralFeature id); |
| |
| /** |
| * Convenience method to set a feature value. |
| * @param feature |
| * @param value |
| */ |
| public void setStructuralFeatureValue(EStructuralFeature feature, Object value); |
| |
| /** |
| * finds an editpart given a starting editpart and an EObject |
| * @param epBegin starting edit part |
| * @param theElement eObject to use |
| * @return the found edit part if there is any |
| */ |
| public EditPart findEditPart(EditPart epBegin, EObject theElement); |
| |
| /** |
| * Convenience method returns the editpart's primary view. |
| * @return the primary view |
| */ |
| public View getPrimaryView(); |
| |
| /** |
| * this method will return the primary child view inside this edit part |
| * @return the primary child view inside this edit part |
| */ |
| public EditPart getPrimaryChildEditPart(); |
| |
| /** |
| * Gets the preferences hint that is to be used to find the appropriate |
| * preference store from which to retrieve diagram preference values. The |
| * preference hint is mapped to a preference store in the preference |
| * registry <@link DiagramPreferencesRegistry>. |
| * |
| * @return the preferences hint |
| */ |
| public PreferencesHint getDiagramPreferencesHint(); |
| |
| /** |
| * Gets the semantic element associated to this editpart's view. |
| * @return the semantic element or <code>null</code> if the semantic element was |
| * <code>null</code> or unresolvable |
| */ |
| public EObject resolveSemanticElement(); |
| |
| /** |
| * Gets my transactional EMF editing domain. |
| * |
| * @return my transactional EMF editing domain |
| */ |
| public TransactionalEditingDomain getEditingDomain(); |
| |
| /** |
| * Retrieves the preferred value for the supplied feature. This value could |
| * be the current value set in the preference store. Clients may override |
| * this to supply their own preferred values. The type of the return value |
| * will vary depending on the feature. |
| * |
| * @param feature |
| * the feature to use |
| * @return Object The preferred value for the supplied feature. The object |
| * is of the same type as if the value of the feature were retrieved |
| * directly from the view. |
| */ |
| public Object getPreferredValue(EStructuralFeature feature); |
| |
| } |