RHTestBotViewer.java

/*******************************************************************************
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 *
 * This file is part of REDHAWK IDE.
 *
 * 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
 *******************************************************************************/
package gov.redhawk.ide.swtbot.diagram;

import java.util.Arrays;
import java.util.List;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.draw2d.FigureCanvas;
import org.eclipse.draw2d.LightweightSystem;
import org.eclipse.gef.EditDomain;
import org.eclipse.gef.EditPart;
import org.eclipse.gef.GraphicalViewer;
import org.eclipse.gef.palette.PaletteEntry;
import org.eclipse.gef.palette.ToolEntry;
import org.eclipse.swt.widgets.Canvas;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swtbot.eclipse.gef.finder.finders.PaletteFinder;
import org.eclipse.swtbot.eclipse.gef.finder.widgets.SWTBotGefEditPart;
import org.eclipse.swtbot.eclipse.gef.finder.widgets.SWTBotGefViewer;
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
import org.eclipse.swtbot.swt.finder.results.ListResult;
import org.eclipse.swtbot.swt.finder.results.VoidResult;
import org.hamcrest.Matcher;

import gov.redhawk.ide.swtbot.matchers.NamespacedToolEntryMatcher;

/**
 * Viewer class to use RHTestBotCanvas for better dragging functionality with Graphiti diagrams.
 */
public class RHTestBotViewer extends SWTBotGefViewer {

	private SWTBotGefEditPart palettePart = null;

	/**
	 * @param graphicalViewer
	 * @throws WidgetNotFoundException
	 */
	public RHTestBotViewer(GraphicalViewer graphicalViewer) throws WidgetNotFoundException {
		super(graphicalViewer);
	}

	@Override
	protected void init() throws WidgetNotFoundException {
		UIThreadRunnable.syncExec(new VoidResult() {
			public void run() {
				final Control control = graphicalViewer.getControl();
				if (control instanceof FigureCanvas) {
					canvas = new RHTestBotCanvas((FigureCanvas) control);
				} else if (control instanceof Canvas) {
					if (control instanceof IAdaptable) {
						IAdaptable adaptable = (IAdaptable) control;
						Object adapter = adaptable.getAdapter(LightweightSystem.class);
						if (adapter instanceof LightweightSystem) {
							canvas = new RHTestBotCanvas((Canvas) control, (LightweightSystem) adapter);
						}
					}
				}
				editDomain = graphicalViewer.getEditDomain();
			}
		});

		if (graphicalViewer == null) {
			throw new WidgetNotFoundException("Editor does not adapt to a GraphicalViewer");
		}
	}

	public RHTestBotCanvas getCanvas() {
		return (RHTestBotCanvas) canvas;
	}

	private SWTBotGefEditPart getPalettePart() {
		if (palettePart == null) {
			palettePart = createEditPart(editDomain.getPaletteViewer().getRootEditPart());
		}
		return palettePart;
	}

	private EditDomain getEditDomain() {
		return editDomain;
	}

	/**
	 * Finds {@link org.eclipse.gef.EditPart}s in the palette.
	 * @param matcher the matcher that matches on {@link org.eclipse.gef.EditPart}
	 * @return a collection of {@link SWTBotGefEditPart}
	 * @throws WidgetNotFoundException
	 */
	public List<SWTBotGefEditPart> editPartsPalette(Matcher< ? extends EditPart> matcher) throws WidgetNotFoundException {
		return getPalettePart().descendants(matcher);
	}

	public RHTestBotViewer activateNamespacedTool(final String[] labels) {
		activateNamespacedTool(labels, 0);
		return this;
	}

	public RHTestBotViewer activateNamespacedTool(final String[] labels, final int index) {
		List<PaletteEntry> entries = UIThreadRunnable.syncExec(new ListResult<PaletteEntry>() {
			@Override
			public List<PaletteEntry> run() {
				final EditDomain editDomain = getEditDomain();
				return new PaletteFinder(editDomain).findEntries(new NamespacedToolEntryMatcher(labels));
			}
		});

		if (entries.isEmpty()) {
			String errorMsg = String.format("%s was not found", Arrays.toString(labels));
			throw new WidgetNotFoundException(errorMsg);
		}
		final PaletteEntry paletteEntry = entries.get(index);
		if (!(paletteEntry instanceof ToolEntry)) {
			String errorMsg = String.format("%s is not a tool entry, it's a %s", Arrays.toString(labels).toString(), paletteEntry.getClass().getName());
			throw new WidgetNotFoundException(errorMsg);
		} else if (!paletteEntry.isVisible()) {
			String errorMsg = String.format("%s was found, but is not visible", Arrays.toString(labels).toString());
			throw new WidgetNotFoundException(errorMsg);
		} else {
			UIThreadRunnable.syncExec(new VoidResult() {
				@Override
				public void run() {
					editDomain.getPaletteViewer().setActiveTool((ToolEntry) paletteEntry);
				}
			});
		}

		return this;
	}
}