org.eclipse.gmf.runtime.diagram.ui.printing/src/org/eclipse/gmf/runtime/diagram/ui/printing/internal/util/SWTDiagramPrinterHelper.java

/******************************************************************************
 * Copyright (c) 2008, 2009 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.printing.internal.util;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.eclipse.gmf.runtime.common.core.util.Log;
import org.eclipse.gmf.runtime.common.core.util.Trace;
import org.eclipse.gmf.runtime.common.ui.printing.IPrintHelper;
import org.eclipse.gmf.runtime.common.ui.util.DisplayUtils;
import org.eclipse.gmf.runtime.diagram.ui.editparts.DiagramEditPart;
import org.eclipse.gmf.runtime.diagram.ui.parts.IDiagramWorkbenchPart;
import org.eclipse.gmf.runtime.diagram.ui.printing.actions.DefaultPrintActionHelper;
import org.eclipse.gmf.runtime.diagram.ui.printing.internal.DiagramPrintingDebugOptions;
import org.eclipse.gmf.runtime.diagram.ui.printing.internal.DiagramPrintingPlugin;
import org.eclipse.gmf.runtime.diagram.ui.printing.internal.DiagramPrintingStatusCodes;
import org.eclipse.gmf.runtime.diagram.ui.printing.internal.l10n.DiagramUIPrintingMessages;
import org.eclipse.gmf.runtime.diagram.ui.printing.util.DiagramPrinterUtil;
import org.eclipse.gmf.runtime.notation.Diagram;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.printing.Printer;
import org.eclipse.swt.printing.PrinterData;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.IEditorPart;

/**
 * Utility for using the DiagramPrinter to print diagrams after displaying a
 * print dialog box to the user. Diagrams are printed using the DiagramPrinter
 * and respect the settings chosen by the user in the print dialog.
 * 
 * This class uses the SWT printing to accomplish its task. This class was
 * derived from 
 * @see org.eclipse.gmf.runtime.diagram.ui.printing.util.DiagramPrinterUtil
 *  
 * @author James Bruck (jbruck)
 */
public class SWTDiagramPrinterHelper extends DiagramPrinterHelper {

	private static SWTDiagramPrinterHelper diagramPrinterHelper;

	public static SWTDiagramPrinterHelper getDiagramPrinterHelper() {
		if (diagramPrinterHelper == null) {
			diagramPrinterHelper = new SWTDiagramPrinterHelper();
		}
		return diagramPrinterHelper;
	}

	/**
	 * Prevent instantiation.
	 */
	private SWTDiagramPrinterHelper() {
	}

	/**
	 * Opens up the print diagrams dialog, allows the user to choose the
	 * settings, and prints.
	 * 
	 * @param editorPart
	 *            current editor part
	 * @param diagramMap
	 *            map of String names to Diagram objects. Should be initialized
	 *            by caller of this method. String names will show up in the
	 *            print dialog that allows the user to choose which diagrams to
	 *            print from a list.
	 * @param diagramPrinter
	 *            the diagram printer that does the work of actually printing
	 *            the diagrams
	 */
	public void printWithSettings(IEditorPart editorPart, Map<String, Diagram> diagramMap,
			SWTDiagramPrinter diagramPrinter) {

		List diagramNames;
		PrinterData printerData;
		IPrintHelper helper;

		Display display = DisplayUtils.getDisplay();
		
		try {
			Class printhelperClass = Class
					.forName(IPrintHelper.PRINT_HELPER_CLASS_NAME);
			helper = (IPrintHelper) printhelperClass.newInstance();
			diagramNames = new ArrayList(diagramMap.keySet());

			printerData = collectPrintInformation(diagramPrinter, helper,
					diagramNames, editorPart, diagramMap);

			if (printerData != null) {
				
				final Printer printer = new Printer(printerData);

				diagramPrinter.setPrinter(printer);
				diagramPrinter.setDisplayDPI(display.getDPI());

				if (helper.getDlgDiagramPrintRangeCurrent()) {
					DiagramEditPart dgrmEP = ((IDiagramWorkbenchPart) editorPart)
							.getDiagramEditPart();
					assert dgrmEP != null;
					diagramPrinter.setDiagrams(Collections.singletonList(dgrmEP
							.getDiagramView().getDiagram()));
				} else if (helper.getDlgDiagramPrintRangeAll()) {
					diagramPrinter.setDiagrams(diagramMap.values());
				} else if (helper.getDlgDiagramPrintRangeSelection()) {
					Object obj;
					List list = new ArrayList();
					for (int i = 0; i < diagramNames.size(); i++) {
						// is the diagram selected?
						// we are only printing the selected ones
						if (helper.isDlgDiagramSelected(i)) {

							obj = diagramMap.get(diagramNames.get(i));
							if (obj instanceof Diagram) {

								list.add(obj);
							}
						}
					}
					diagramPrinter.setDiagrams(list);
				}

				printDiagrams(diagramPrinter, helper);

				printer.dispose();
			}
		} catch (Throwable e) {
			// if there's a problem with the fragment, try doing the default
			// this is better than nothing
			Trace.catching(DiagramPrintingPlugin.getInstance(),
					DiagramPrintingDebugOptions.EXCEPTIONS_CATCHING,
					DiagramPrinterUtil.class, e.getMessage(), e);
			Log.warning(DiagramPrintingPlugin.getInstance(),
					DiagramPrintingStatusCodes.RESOURCE_FAILURE,
					e.getMessage(), e);

			if (MessageDialog
					.openQuestion(
							display.getActiveShell(),
							DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorTitle,
							DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part1
									+ "\n" //$NON-NLS-1$
									+ DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part2
									+ "\n" //$NON-NLS-1$
									+ DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part3
									+ "\n\n" //$NON-NLS-1$
									+ DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part4)) {
				DefaultPrintActionHelper.doRun(editorPart, diagramPrinter);
			}

			return;
		}

	}

	/**
	 * A helper that simply collects printing information.
	 * 
	 * @param diagramPrinter
	 * @param helper
	 * @param diagramNames
	 * @param editorPart
	 * @param diagramMap
	 * @return
	 */
	private PrinterData collectPrintInformation(
			SWTDiagramPrinter diagramPrinter, IPrintHelper helper,
			List diagramNames, IEditorPart editorPart, Map diagramMap) {

		PrinterData printerData = null;
		try {
			printerData = super.collectPrintInformation(diagramPrinter, helper,
					diagramNames, editorPart, diagramMap);
		} catch (Throwable e) {
			// if there's a problem with the fragment, try doing the default
			// this is better than nothing
			Trace.catching(DiagramPrintingPlugin.getInstance(),
					DiagramPrintingDebugOptions.EXCEPTIONS_CATCHING,
					DiagramPrinterUtil.class, e.getMessage(), e);
			Log.warning(DiagramPrintingPlugin.getInstance(),
					DiagramPrintingStatusCodes.RESOURCE_FAILURE,
					e.getMessage(), e);

			if (MessageDialog
					.openQuestion(
							DisplayUtils.getDisplay().getActiveShell(),
							DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorTitle,
							DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part1
									+ "\n" //$NON-NLS-1$
									+ DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part2
									+ "\n" //$NON-NLS-1$
									+ DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part3
									+ "\n\n" //$NON-NLS-1$
									+ DiagramUIPrintingMessages.DiagramPrinterUtil_DLLErrorMessage_part4)) {
				DefaultPrintActionHelper.doRun(editorPart, diagramPrinter);
			}
		}
		return printerData;
	}
}