lookAndFeel/plugins/org.eclipse.papyrus.uml.diagram.clazz.lf.associationlabellayout/src/org/eclipse/papyrus/uml/diagram/clazz/lf/associationlabellayout/edit/parts/AccessForLocatorManager.java

/*****************************************************************************
 * Copyright (c) 2019 CEA LIST.
 *
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *  Xavier Le Pallec (for CEA LIST) xlepallec@lilo.org - Bug 558456
 *
 *****************************************************************************/

package org.eclipse.papyrus.uml.diagram.clazz.lf.associationlabellayout.edit.parts;

import org.eclipse.draw2d.Connection;
import org.eclipse.draw2d.geometry.Point;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.gef.EditPart;
import org.eclipse.papyrus.infra.gmfdiag.common.locator.PapyrusLabelLocator;

/**
 * This interface is defined to propose to the locator manager an access to some
 * methods of edit parts: its locator, properties of its element
 * (notation-level), its parent and the initialization of the locator.
 *
 */
public interface AccessForLocatorManager { 

	/**
	 * Access to the locator
	 * 
	 * @return the locator
	 */
	public PapyrusLabelLocator getLocator();

	/**
	 * Sets the locator
	 * 
	 * @param locator the locator
	 */
	public void setLocator(PapyrusLabelLocator locator);

	/**
	 * This method is needed to access to X and Y
	 * 
	 * @param feature object that defines the feature type
	 * @return the value of the feature (on the associated notation-level object)
	 */
	public Object getStructuralFeatureValue(EStructuralFeature feature);

	/**
	 * Get the edit part parent
	 * 
	 * @return edit part parent
	 */
	public EditPart getParent();

	/**
	 * Initializes the locator with the connectionFigure (that gives access to all
	 * figures of the association) and an offset (contact point ?).
	 * 
	 * @param connectionFigure object that gives access to all figures of the
	 *                         association
	 *                         ({@link org.eclipse.papyrus.uml.diagram.clazz.lf.associationlabellayout.figures.SelfLaidOutAssociationFigure}).
	 * @param offset           contact point (?)
	 */
	public void initializeLocator(Connection connectionFigure, Point offset);
}