org.eclipse.viatra2.visualisation/src/org/eclipse/viatra2/visualisation/common/labelproviders/natives/ClearHighlightsFunction.java

/*******************************************************************************
 * Copyright (c) 2010 Zoltan Ujhelyi and Istvan Rath and Daniel Varro.
 * 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:
 *    Istvan Rath - initial API and implementation
 *******************************************************************************/
package org.eclipse.viatra2.visualisation.common.labelproviders.natives;

import org.eclipse.viatra2.core.IModelSpace;
import org.eclipse.viatra2.errors.VPMRuntimeException;
import org.eclipse.viatra2.visualisation.common.labelproviders.HighlightableSmartLabelProvider;

/**
 * Native function to remove all previously existing highlights from viz.
 * @author istvan rath
 *
 */
public class ClearHighlightsFunction extends AbstractVisualisationFunction {

	public Object run(IModelSpace msp, Object[] params) throws VPMRuntimeException {
		HighlightableSmartLabelProvider.clearHighlights(msp);
		return Boolean.TRUE;
	}

	public String getName() {
		return "viz.clearhighlights";
	}

	public String getID() {
		return getName();
	}

	public String getDescription() {
		return "removes all highlights from viz";
	}

}