plugins/org.eclipse.graphiti/src/org/eclipse/graphiti/features/impl/AbstractUpdateFeature.java

/*********************************************************************
* Copyright (c) 2005, 2019 SAP SE
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* Contributors:
*    SAP SE - initial API, implementation and documentation
*    mgorning - Bug 376572 - Generic context buttons name changeable via getName() method
*
* SPDX-License-Identifier: EPL-2.0
**********************************************************************/
package org.eclipse.graphiti.features.impl;

import org.eclipse.graphiti.datatypes.IDimension;
import org.eclipse.graphiti.features.IFeatureProvider;
import org.eclipse.graphiti.features.IReason;
import org.eclipse.graphiti.features.IResizeShapeFeature;
import org.eclipse.graphiti.features.IUpdateFeature;
import org.eclipse.graphiti.features.context.IContext;
import org.eclipse.graphiti.features.context.IUpdateContext;
import org.eclipse.graphiti.features.context.impl.ResizeShapeContext;
import org.eclipse.graphiti.features.context.impl.UpdateContext;
import org.eclipse.graphiti.internal.Messages;
import org.eclipse.graphiti.internal.util.T;
import org.eclipse.graphiti.mm.algorithms.GraphicsAlgorithm;
import org.eclipse.graphiti.mm.pictograms.PictogramElement;
import org.eclipse.graphiti.mm.pictograms.Shape;
import org.eclipse.graphiti.services.Graphiti;

/**
 * The Class AbstractUpdateFeature.
 */
public abstract class AbstractUpdateFeature extends AbstractFeature implements IUpdateFeature {

	private static final String NAME = Messages.AbstractUpdateFeature_2_xfld;
	private static final String DESC = Messages.ContextEntryHelper_1_xfld;

	/**
	 * Create a new {@link AbstractUpdateFeature}.
	 * 
	 * @param fp
	 *            the feature provider
	 */
	public AbstractUpdateFeature(IFeatureProvider fp) {
		super(fp);
	}

	public final boolean canExecute(IContext context) {
		final String SIGNATURE = Messages.AbstractUpdateFeature_0_xfld;
		boolean info = T.racer().info();
		if (info) {
			T.racer().entering(AbstractUpdateFeature.class, SIGNATURE, new Object[] { context });
		}
		boolean ret = false;
		if (context instanceof IUpdateContext) {
			IUpdateContext updateSemanticsContext = (IUpdateContext) context;
			ret = canUpdate(updateSemanticsContext);
		}
		if (info) {
			T.racer().exiting(AbstractUpdateFeature.class, SIGNATURE, ret);
		}
		return ret;
	}

	public void execute(IContext context) {
		final String SIGNATURE = Messages.AbstractUpdateFeature_1_xfld;
		boolean info = T.racer().info();
		if (info) {
			T.racer().entering(AbstractUpdateFeature.class, SIGNATURE, new Object[] { context });
		}
		if (context instanceof IUpdateContext) {
			update((IUpdateContext) context);
		}
		if (info) {
			T.racer().exiting(AbstractUpdateFeature.class, SIGNATURE);
		}
	}

	/**
	 * Can update pictogram element.
	 * 
	 * @param pe
	 *            the pe
	 * @return true, if successful
	 */
	protected boolean canUpdatePictogramElement(PictogramElement pe) {
		return getFeatureProvider().canUpdate(new UpdateContext(pe)).toBoolean();
	}

	/**
	 * Update pictogram element needed.
	 * 
	 * @param pe
	 *            the pe
	 * @return the i reason
	 */
	protected IReason updatePictogramElementNeeded(PictogramElement pe) {
		return getFeatureProvider().updateNeeded(new UpdateContext(pe));
	}

	@Override
	protected void updatePictogramElement(PictogramElement pe) {
		getFeatureProvider().updateIfPossible(new UpdateContext(pe));
	}

	/**
	 * Resize shape.
	 * 
	 * @param shape
	 *            the shape
	 */
	protected void resizeShape(Shape shape) {
		final ResizeShapeContext resizeShapeContext = new ResizeShapeContext(shape);
		GraphicsAlgorithm ga = shape.getGraphicsAlgorithm();
		IDimension gaSize = Graphiti.getGaService().calculateSize(ga, false);
		resizeShapeContext.setWidth(gaSize.getWidth());
		resizeShapeContext.setHeight(gaSize.getHeight());

		final IResizeShapeFeature resizeShapeFeature = getFeatureProvider().getResizeShapeFeature(resizeShapeContext);
		if (resizeShapeFeature != null) {
			if (resizeShapeFeature.canResizeShape(resizeShapeContext)) {
				resizeShapeFeature.resizeShape(resizeShapeContext);
			}
		}
	}

	@Override
	public String getName() {
		return NAME;
	}

	@Override
	public String getDescription() {
		return DESC;
	}
}