Attachment #34575 for bug #19602

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 13-18 Link Here

(-)src/org/eclipse/jface/text/source/SourceViewer.java (+9 lines)
13	import java.util.Stack;	13	import java.util.Stack;
14		14
15	import org.eclipse.swt.SWT;	15	import org.eclipse.swt.SWT;
		16	import org.eclipse.swt.custom.StyledTextPrintMarginDecorator;
16	import org.eclipse.swt.graphics.Point;	17	import org.eclipse.swt.graphics.Point;
17	import org.eclipse.swt.graphics.Rectangle;	18	import org.eclipse.swt.graphics.Rectangle;
18	import org.eclipse.swt.widgets.Canvas;	19	import org.eclipse.swt.widgets.Canvas;
Lines 1011-1014 Link Here
1011	}	1012	}
1012	}	1013	}
1013	}	1014	}
		1015
		1016	/* (non-Javadoc)
		1017	* @see org.eclipse.jface.text.TextViewer#getPreferredLineNumberDecorator(int)
		1018	*/
		1019	public StyledTextPrintMarginDecorator getPreferredLineNumberDecorator() {
		1020	return new SourceLineNumberMarginDecorator(this);
		1021	}
		1022
1014	}	1023	}

Lines 28-33 Link Here

(-)src/org/eclipse/jface/text/TextViewer.java (-2 / +30 lines)
28	import org.eclipse.swt.custom.ST;	28	import org.eclipse.swt.custom.ST;
29	import org.eclipse.swt.custom.StyleRange;	29	import org.eclipse.swt.custom.StyleRange;
30	import org.eclipse.swt.custom.StyledText;	30	import org.eclipse.swt.custom.StyledText;
		31	import org.eclipse.swt.custom.StyledTextPrintMarginDecorator;
		32	import org.eclipse.swt.custom.StyledTextPrintOptions;
31	import org.eclipse.swt.custom.VerifyKeyListener;	33	import org.eclipse.swt.custom.VerifyKeyListener;
32	import org.eclipse.swt.dnd.DND;	34	import org.eclipse.swt.dnd.DND;
33	import org.eclipse.swt.events.ControlEvent;	35	import org.eclipse.swt.events.ControlEvent;
Lines 95-101 Link Here
95	public class TextViewer extends Viewer implements	97	public class TextViewer extends Viewer implements
96	ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, IEditingSupportRegistry,	98	ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, IEditingSupportRegistry,
97	ITextOperationTarget, ITextOperationTargetExtension,	99	ITextOperationTarget, ITextOperationTargetExtension,
98	IWidgetTokenOwner, IWidgetTokenOwnerExtension, IPostSelectionProvider {	100	IWidgetTokenOwner, IWidgetTokenOwnerExtension, IPostSelectionProvider, IPrintOptionsConsumer {
99		101
100	/** Internal flag to indicate the debug state. */	102	/** Internal flag to indicate the debug state. */
101	public static final boolean TRACE_ERRORS= false;	103	public static final boolean TRACE_ERRORS= false;
Lines 1394-1399 Link Here
1394	* @since 3.1	1396	* @since 3.1
1395	*/	1397	*/
1396	private IPositionUpdater fSelectionUpdater;	1398	private IPositionUpdater fSelectionUpdater;
		1399	/**
		1400	* Options provider for the <code>print()</code> method
		1401	* @since 3.2
		1402	*/
		1403	private IPrintOptionsProvider fPrintOptionsProvider;
1397		1404
1398		1405
1399	//---- Construction and disposal ------------------	1406	//---- Construction and disposal ------------------
Lines 3908-3913 Link Here
3908	PrinterData[] printerList= Printer.getPrinterList();	3915	PrinterData[] printerList= Printer.getPrinterList();
3909	return (printerList != null && printerList.length > 0);	3916	return (printerList != null && printerList.length > 0);
3910	}	3917	}
		3918
		3919	/* (non-Javadoc)
		3920	* @see org.eclipse.jface.text.IPrintOptionsConsumer#setPrintOptionProvider(org.eclipse.jface.text.IPrintOptionsProvider)
		3921	*/
		3922	public void setPrintOptionProvider(IPrintOptionsProvider provider) {
		3923	fPrintOptionsProvider = provider;
		3924	}
		3925
		3926	/* (non-Javadoc)
		3927	* @see org.eclipse.jface.text.IPrintOptionsConsumer#getPreferredLineNumberDecorator(int)
		3928	*/
		3929	public StyledTextPrintMarginDecorator getPreferredLineNumberDecorator() {
		3930	return null;
		3931	}
3911		3932
3912	/**	3933	/**
3913	* Brings up a print dialog and calls <code>printContents(Printer)</code> which	3934	* Brings up a print dialog and calls <code>printContents(Printer)</code> which
Lines 3921-3927 Link Here
3921	if (data != null) {	3942	if (data != null) {
3922		3943
3923	final Printer printer= new Printer(data);	3944	final Printer printer= new Printer(data);
3924	final Runnable styledTextPrinter= fTextWidget.print(printer);	3945	StyledTextPrintOptions options = null;
		3946	if (fPrintOptionsProvider != null)
		3947	options = fPrintOptionsProvider.getPrintOptions();
		3948	final Runnable styledTextPrinter =
		3949	options == null
		3950	? fTextWidget.print(printer)
		3951	: fTextWidget.print(printer, options);
		3952
3925		3953
3926	Thread printingThread= new Thread("Printing") { //$NON-NLS-1$	3954	Thread printingThread= new Thread("Printing") { //$NON-NLS-1$
3927	public void run() {	3955	public void run() {

Lines 18-23 Link Here

(-)projection/org/eclipse/jface/text/source/projection/ProjectionViewer.java (+9 lines)
18	import org.eclipse.swt.SWTError;	18	import org.eclipse.swt.SWTError;
19	import org.eclipse.swt.custom.ST;	19	import org.eclipse.swt.custom.ST;
20	import org.eclipse.swt.custom.StyledText;	20	import org.eclipse.swt.custom.StyledText;
		21	import org.eclipse.swt.custom.StyledTextPrintMarginDecorator;
21	import org.eclipse.swt.dnd.Clipboard;	22	import org.eclipse.swt.dnd.Clipboard;
22	import org.eclipse.swt.dnd.DND;	23	import org.eclipse.swt.dnd.DND;
23	import org.eclipse.swt.dnd.TextTransfer;	24	import org.eclipse.swt.dnd.TextTransfer;
Lines 1772-1775 Link Here
1772		1773
1773	return -1;	1774	return -1;
1774	}	1775	}
		1776
		1777	/* (non-Javadoc)
		1778	* @see org.eclipse.jface.text.source.SourceViewer#getPreferredLineNumberDecorator(int)
		1779	*/
		1780	public StyledTextPrintMarginDecorator getPreferredLineNumberDecorator() {
		1781	return new ProjectionLineNumberMarginDecorator(this);
		1782	}
		1783
1775	}	1784	}




/*******************************************************************************
 * Copyright (c) 2006 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.jface.text;

import org.eclipse.swt.custom.StyledTextPrintMarginDecorator;

/**
 * A print options consumer uses an {@link IPrintOptionsProvider} to acquire
 * print options. The class {@link TextViewer} implements this interface to
 * enable editors to set options providers.
 * 
 * @since 3.2
 */
public interface IPrintOptionsConsumer {

	/**
	 * Implementors must return an instance of
	 * <code>StyledTextPrintOptions</code> suitable for printing the current
	 * contents of this viewer's <code>StyledText</code> control.
	 * 
	 * @param provider the options provider
	 */
	public void setPrintOptionProvider(IPrintOptionsProvider provider);

	/**
	 * A consumer will have the opportunity to return an instance of their
	 * preferred <code>StyledTextPrintMarginDecorator</code> implementation.
	 * It is permissible to return <code>null</code>.
	 * 
	 * @return the preferred line number print margin decorator
	 */
	public StyledTextPrintMarginDecorator getPreferredLineNumberDecorator();
}




/*******************************************************************************
 * Copyright (c) 2006 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.jface.text.source;

import org.eclipse.jface.internal.text.JFaceTextUtil;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.swt.custom.StyledTextPrintMarginDecorator;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.TextStyle;

/**
 * A simple implementation of StyledTextPrintMarginDecorator that prints right
 * aligned line numbers. The line numbers are mapped to the document line
 * numbers.
 */
public class SourceLineNumberMarginDecorator implements
		StyledTextPrintMarginDecorator {

	private ITextViewer fTextViewer = null;

	private int fGutter = 0;

	/**
	 * Constructs a decorator with a gutter as specified.
	 * 
	 * @param viewer the viewer for line number conversion. If <code>null</code>
	 *            is passed, null is returned from {@link #getMarginText(int)}
	 */
	public SourceLineNumberMarginDecorator(ITextViewer viewer) {
		super();
		fTextViewer = viewer;

		GC gc = new GC(fTextViewer.getTextWidget());
		fGutter = gc.getAdvanceWidth(' ');
		gc.dispose();
	}

	/*
	 * (non-Javadoc)
	 */
	protected SourceLineNumberMarginDecorator(ITextViewer viewer, int gutter) {
		super();
		fTextViewer = viewer;
		fGutter = gutter;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.custom.StyledTextPrintMarginDecorator#getAlignment()
	 */
	public int getAlignment() {
		return FORCE_RIGHT;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.custom.StyledTextPrintMarginDecorator#getGutter()
	 */
	public int getGutter() {
		return fGutter;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.custom.StyledTextPrintMarginDecorator#getMarginText(int)
	 */
	public String getMarginText(int line) {
		String text = null;
		// This should not happen but degrade non-essential function gracefully.
		if (fTextViewer != null)
			text = Integer.toString(getModelLineNumber(line) + 1);
		return text;
	}

	/**
	 * @param line the widget line number
	 * @return the model line number
	 */
	protected int getModelLineNumber(int line) {
		return JFaceTextUtil.widgetLine2ModelLine(fTextViewer, line);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.custom.StyledTextPrintMarginDecorator#getMarginTextStyle()
	 */
	public TextStyle getMarginTextStyle() {
		return null;
	}

}




/*******************************************************************************
 * Copyright (c) 2006 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.jface.text;

import org.eclipse.swt.custom.StyledTextPrintOptions;

/**
 * A print options provider is used by <code>TextViewer.print()</code> to
 * retrieve the appropriate <code>StyledTextPrintOptions</code>demaps an
 * element of the viewer's model to for the active print job.
 * 
 * @since 3.2
 */
public interface IPrintOptionsProvider {
	/**
	 * Implementors must return an instance of
	 * <code>StyledTextPrintOptions</code> suitable for printing the current
	 * contents of this viewer's <code>StyledText</code> control.
	 * 
	 * @return the options
	 */
	public StyledTextPrintOptions getPrintOptions();
}




/*******************************************************************************
 * Copyright (c) 2006 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.jface.text.source.projection;

import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.source.SourceLineNumberMarginDecorator;

/**
 * An implementation of StyledTextPrintMarginDecorator that prints right aligned
 * line numbers. The line numbers are mapped to the document line numbers. If a
 * projection is collapsed a '+' annotation is printed.
 */
public class ProjectionLineNumberMarginDecorator extends
		SourceLineNumberMarginDecorator {

	/**
	 * Constructs a decorator with a gutter as specified.
	 * 
	 * @param viewer the viewer for line number conversion. If <code>null</code>
	 *            is passed, null is returned from {@link #getMarginText(int)}
	 */
	public ProjectionLineNumberMarginDecorator(ITextViewer viewer) {
		super(viewer, 0);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.custom.StyledTextPrintMarginDecorator#getMarginText(int)
	 */
	public String getMarginText(int line) {
		String text = super.getMarginText(line);
		if (text != null) {
			int nextModelLine = getModelLineNumber(line + 1);
			if (((getModelLineNumber(line) + 1) == nextModelLine)
					|| (nextModelLine == -1))
				text = text + ' ';
			else
				text = text + '+';
		}
		return text;
	}

}

Return to bug 19602

Added Link Here

(-)src/org/eclipse/jface/text/IPrintOptionsConsumer.java (+41 lines)
1	/*******************************************************************************
2	* Copyright (c) 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.jface.text;
12
13	import org.eclipse.swt.custom.StyledTextPrintMarginDecorator;
14
15	/**
16	* A print options consumer uses an {@link IPrintOptionsProvider} to acquire
17	* print options. The class {@link TextViewer} implements this interface to
18	* enable editors to set options providers.
19	*
20	* @since 3.2
21	*/
22	public interface IPrintOptionsConsumer {
23
24	/**
25	* Implementors must return an instance of
26	* <code>StyledTextPrintOptions</code> suitable for printing the current
27	* contents of this viewer's <code>StyledText</code> control.
28	*
29	* @param provider the options provider
30	*/
31	public void setPrintOptionProvider(IPrintOptionsProvider provider);
32
33	/**
34	* A consumer will have the opportunity to return an instance of their
35	* preferred <code>StyledTextPrintMarginDecorator</code> implementation.
36	* It is permissible to return <code>null</code>.
37	*
38	* @return the preferred line number print margin decorator
39	*/
40	public StyledTextPrintMarginDecorator getPreferredLineNumberDecorator();
41	}