Mercurial > projects > dwt2

comparison org.eclipse.jface.text/src/org/eclipse/jface/text/MarginPainter.d @ 12:bc29606a740c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
comparison
equal deleted inserted replaced
11:43904fec5dca 12:bc29606a740c
1 /*******************************************************************************
2 * Copyright (c) 2000, 2008 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 * Port to the D programming language:
11 * Frank Benoit <benoit@tionex.de>
12 *******************************************************************************/
13 module org.eclipse.jface.text.MarginPainter;
14
15 import org.eclipse.jface.text.IDocumentPartitioningListener; // packageimport
16 import org.eclipse.jface.text.DefaultTextHover; // packageimport
17 import org.eclipse.jface.text.AbstractInformationControl; // packageimport
18 import org.eclipse.jface.text.TextUtilities; // packageimport
19 import org.eclipse.jface.text.IInformationControlCreatorExtension; // packageimport
20 import org.eclipse.jface.text.AbstractInformationControlManager; // packageimport
21 import org.eclipse.jface.text.ITextViewerExtension2; // packageimport
22 import org.eclipse.jface.text.IDocumentPartitioner; // packageimport
23 import org.eclipse.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport
24 import org.eclipse.jface.text.ITextSelection; // packageimport
25 import org.eclipse.jface.text.Document; // packageimport
26 import org.eclipse.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport
27 import org.eclipse.jface.text.ITextListener; // packageimport
28 import org.eclipse.jface.text.BadPartitioningException; // packageimport
29 import org.eclipse.jface.text.ITextViewerExtension5; // packageimport
30 import org.eclipse.jface.text.IDocumentPartitionerExtension3; // packageimport
31 import org.eclipse.jface.text.IUndoManager; // packageimport
32 import org.eclipse.jface.text.ITextHoverExtension2; // packageimport
33 import org.eclipse.jface.text.IRepairableDocument; // packageimport
34 import org.eclipse.jface.text.IRewriteTarget; // packageimport
35 import org.eclipse.jface.text.DefaultPositionUpdater; // packageimport
36 import org.eclipse.jface.text.RewriteSessionEditProcessor; // packageimport
37 import org.eclipse.jface.text.TextViewerHoverManager; // packageimport
38 import org.eclipse.jface.text.DocumentRewriteSession; // packageimport
39 import org.eclipse.jface.text.TextViewer; // packageimport
40 import org.eclipse.jface.text.ITextViewerExtension8; // packageimport
41 import org.eclipse.jface.text.RegExMessages; // packageimport
42 import org.eclipse.jface.text.IDelayedInputChangeProvider; // packageimport
43 import org.eclipse.jface.text.ITextOperationTargetExtension; // packageimport
44 import org.eclipse.jface.text.IWidgetTokenOwner; // packageimport
45 import org.eclipse.jface.text.IViewportListener; // packageimport
46 import org.eclipse.jface.text.GapTextStore; // packageimport
47 import org.eclipse.jface.text.MarkSelection; // packageimport
48 import org.eclipse.jface.text.IDocumentPartitioningListenerExtension; // packageimport
49 import org.eclipse.jface.text.IDocumentAdapterExtension; // packageimport
50 import org.eclipse.jface.text.IInformationControlExtension; // packageimport
51 import org.eclipse.jface.text.IDocumentPartitioningListenerExtension2; // packageimport
52 import org.eclipse.jface.text.DefaultDocumentAdapter; // packageimport
53 import org.eclipse.jface.text.ITextViewerExtension3; // packageimport
54 import org.eclipse.jface.text.IInformationControlCreator; // packageimport
55 import org.eclipse.jface.text.TypedRegion; // packageimport
56 import org.eclipse.jface.text.ISynchronizable; // packageimport
57 import org.eclipse.jface.text.IMarkRegionTarget; // packageimport
58 import org.eclipse.jface.text.TextViewerUndoManager; // packageimport
59 import org.eclipse.jface.text.IRegion; // packageimport
60 import org.eclipse.jface.text.IInformationControlExtension2; // packageimport
61 import org.eclipse.jface.text.IDocumentExtension4; // packageimport
62 import org.eclipse.jface.text.IDocumentExtension2; // packageimport
63 import org.eclipse.jface.text.IDocumentPartitionerExtension2; // packageimport
64 import org.eclipse.jface.text.Assert; // packageimport
65 import org.eclipse.jface.text.DefaultInformationControl; // packageimport
66 import org.eclipse.jface.text.IWidgetTokenOwnerExtension; // packageimport
67 import org.eclipse.jface.text.DocumentClone; // packageimport
68 import org.eclipse.jface.text.DefaultUndoManager; // packageimport
69 import org.eclipse.jface.text.IFindReplaceTarget; // packageimport
70 import org.eclipse.jface.text.IAutoEditStrategy; // packageimport
71 import org.eclipse.jface.text.ILineTrackerExtension; // packageimport
72 import org.eclipse.jface.text.IUndoManagerExtension; // packageimport
73 import org.eclipse.jface.text.TextSelection; // packageimport
74 import org.eclipse.jface.text.DefaultAutoIndentStrategy; // packageimport
75 import org.eclipse.jface.text.IAutoIndentStrategy; // packageimport
76 import org.eclipse.jface.text.IPainter; // packageimport
77 import org.eclipse.jface.text.IInformationControl; // packageimport
78 import org.eclipse.jface.text.IInformationControlExtension3; // packageimport
79 import org.eclipse.jface.text.ITextViewerExtension6; // packageimport
80 import org.eclipse.jface.text.IInformationControlExtension4; // packageimport
81 import org.eclipse.jface.text.DefaultLineTracker; // packageimport
82 import org.eclipse.jface.text.IDocumentInformationMappingExtension; // packageimport
83 import org.eclipse.jface.text.IRepairableDocumentExtension; // packageimport
84 import org.eclipse.jface.text.ITextHover; // packageimport
85 import org.eclipse.jface.text.FindReplaceDocumentAdapter; // packageimport
86 import org.eclipse.jface.text.ILineTracker; // packageimport
87 import org.eclipse.jface.text.Line; // packageimport
88 import org.eclipse.jface.text.ITextViewerExtension; // packageimport
89 import org.eclipse.jface.text.IDocumentAdapter; // packageimport
90 import org.eclipse.jface.text.TextEvent; // packageimport
91 import org.eclipse.jface.text.BadLocationException; // packageimport
92 import org.eclipse.jface.text.AbstractDocument; // packageimport
93 import org.eclipse.jface.text.AbstractLineTracker; // packageimport
94 import org.eclipse.jface.text.TreeLineTracker; // packageimport
95 import org.eclipse.jface.text.ITextPresentationListener; // packageimport
96 import org.eclipse.jface.text.Region; // packageimport
97 import org.eclipse.jface.text.ITextViewer; // packageimport
98 import org.eclipse.jface.text.IDocumentInformationMapping; // packageimport
99 import org.eclipse.jface.text.IPaintPositionManager; // packageimport
100 import org.eclipse.jface.text.TextPresentation; // packageimport
101 import org.eclipse.jface.text.IFindReplaceTargetExtension; // packageimport
102 import org.eclipse.jface.text.ISlaveDocumentManagerExtension; // packageimport
103 import org.eclipse.jface.text.ISelectionValidator; // packageimport
104 import org.eclipse.jface.text.IDocumentExtension; // packageimport
105 import org.eclipse.jface.text.PropagatingFontFieldEditor; // packageimport
106 import org.eclipse.jface.text.ConfigurableLineTracker; // packageimport
107 import org.eclipse.jface.text.SlaveDocumentEvent; // packageimport
108 import org.eclipse.jface.text.IDocumentListener; // packageimport
109 import org.eclipse.jface.text.PaintManager; // packageimport
110 import org.eclipse.jface.text.IFindReplaceTargetExtension3; // packageimport
111 import org.eclipse.jface.text.ITextDoubleClickStrategy; // packageimport
112 import org.eclipse.jface.text.IDocumentExtension3; // packageimport
113 import org.eclipse.jface.text.Position; // packageimport
114 import org.eclipse.jface.text.TextMessages; // packageimport
115 import org.eclipse.jface.text.CopyOnWriteTextStore; // packageimport
116 import org.eclipse.jface.text.WhitespaceCharacterPainter; // packageimport
117 import org.eclipse.jface.text.IPositionUpdater; // packageimport
118 import org.eclipse.jface.text.DefaultTextDoubleClickStrategy; // packageimport
119 import org.eclipse.jface.text.ListLineTracker; // packageimport
120 import org.eclipse.jface.text.ITextInputListener; // packageimport
121 import org.eclipse.jface.text.BadPositionCategoryException; // packageimport
122 import org.eclipse.jface.text.IWidgetTokenKeeperExtension; // packageimport
123 import org.eclipse.jface.text.IInputChangedListener; // packageimport
124 import org.eclipse.jface.text.ITextOperationTarget; // packageimport
125 import org.eclipse.jface.text.IDocumentInformationMappingExtension2; // packageimport
126 import org.eclipse.jface.text.ITextViewerExtension7; // packageimport
127 import org.eclipse.jface.text.IInformationControlExtension5; // packageimport
128 import org.eclipse.jface.text.IDocumentRewriteSessionListener; // packageimport
129 import org.eclipse.jface.text.JFaceTextUtil; // packageimport
130 import org.eclipse.jface.text.AbstractReusableInformationControlCreator; // packageimport
131 import org.eclipse.jface.text.TabsToSpacesConverter; // packageimport
132 import org.eclipse.jface.text.CursorLinePainter; // packageimport
133 import org.eclipse.jface.text.ITextHoverExtension; // packageimport
134 import org.eclipse.jface.text.IEventConsumer; // packageimport
135 import org.eclipse.jface.text.IDocument; // packageimport
136 import org.eclipse.jface.text.IWidgetTokenKeeper; // packageimport
137 import org.eclipse.jface.text.DocumentCommand; // packageimport
138 import org.eclipse.jface.text.TypedPosition; // packageimport
139 import org.eclipse.jface.text.IEditingSupportRegistry; // packageimport
140 import org.eclipse.jface.text.IDocumentPartitionerExtension; // packageimport
141 import org.eclipse.jface.text.AbstractHoverInformationControlManager; // packageimport
142 import org.eclipse.jface.text.IEditingSupport; // packageimport
143 import org.eclipse.jface.text.IMarkSelection; // packageimport
144 import org.eclipse.jface.text.ISlaveDocumentManager; // packageimport
145 import org.eclipse.jface.text.DocumentEvent; // packageimport
146 import org.eclipse.jface.text.DocumentPartitioningChangedEvent; // packageimport
147 import org.eclipse.jface.text.ITextStore; // packageimport
148 import org.eclipse.jface.text.JFaceTextMessages; // packageimport
149 import org.eclipse.jface.text.DocumentRewriteSessionEvent; // packageimport
150 import org.eclipse.jface.text.SequentialRewriteTextStore; // packageimport
151 import org.eclipse.jface.text.DocumentRewriteSessionType; // packageimport
152 import org.eclipse.jface.text.TextAttribute; // packageimport
153 import org.eclipse.jface.text.ITextViewerExtension4; // packageimport
154 import org.eclipse.jface.text.ITypedRegion; // packageimport
155
156
157 import java.lang.all;
158 import java.util.Set;
159
160
161 import org.eclipse.swt.SWT;
162 import org.eclipse.swt.custom.StyledText;
163 import org.eclipse.swt.events.PaintEvent;
164 import org.eclipse.swt.events.PaintListener;
165 import org.eclipse.swt.graphics.Color;
166 import org.eclipse.swt.graphics.GC;
167 import org.eclipse.swt.graphics.Rectangle;
168
169
170 /**
171 * Paints a vertical line (margin line) after a given column respecting the text
172 * viewer's font.
173 * <p>
174 * Clients usually instantiate and configure objects of this class.</p>
175 * <p>
176 * This class is not intended to be subclassed.</p>
177 *
178 * @since 2.1
179 * @noextend This class is not intended to be subclassed by clients.
180 */
181 public class MarginPainter : IPainter, PaintListener {
182
183 /** The widget of the text viewer */
184 private StyledText fTextWidget;
185
186 /** The column after which to paint the line, default value <code>80</code> */
187 private int fMarginWidth= 80;
188 /** The color in which to paint the line */
189 private Color fColor;
190 /** The line style of the line to be painted, default value <code>SWT.LINE_SOLID</code> */
191 private int fLineStyle= SWT.LINE_SOLID;
192 /** The line width of the line to be painted, default value <code>1</code> */
193 private int fLineWidth= 0; // NOTE: 0 means width is 1 but with optimized performance
194 /** The cached x-offset of the <code>fMarginWidth</code> for the current font */
195 private int fCachedWidgetX= -1;
196 /** The active state of this painter */
197 private bool fIsActive= false;
198
199 /**
200 * Creates a new painter for the given text viewer.
201 *
202 * @param textViewer the text viewer
203 */
204 public this(ITextViewer textViewer) {
205 fTextWidget= textViewer.getTextWidget();
206 }
207
208 /**
209 * Sets the column after which to draw the margin line.
210 *
211 * @param width the column
212 */
213 public void setMarginRulerColumn(int width) {
214 fMarginWidth= width;
215 initialize();
216 }
217
218 /**
219 * Sets the line style of the margin line.
220 *
221 * @param lineStyle a <code>SWT</code> style constant describing the line style
222 */
223 public void setMarginRulerStyle(int lineStyle) {
224 fLineStyle= lineStyle;
225 }
226
227 /**
228 * Sets the line width of the margin line.
229 *
230 * @param lineWidth the line width
231 */
232 public void setMarginRulerWidth(int lineWidth) {
233 if (lineWidth is 1)
234 lineWidth= 0; // NOTE: 0 means width is 1 but with optimized performance
235 fLineWidth= lineWidth;
236 }
237
238 /**
239 * Sets the color of the margin line. Must be called before <code>paint</code> is called the first time.
240 *
241 * @param color the color
242 */
243 public void setMarginRulerColor(Color color) {
244 fColor= color;
245 }
246
247 /**
248 * Initializes this painter, by flushing and recomputing all caches and causing
249 * the widget to be redrawn. Must be called explicitly when font of text widget changes.
250 */
251 public void initialize() {
252 computeWidgetX();
253 fTextWidget.redraw();
254 }
255
256 /**
257 * Computes and remembers the x-offset of the margin column for the
258 * current widget font.
259 */
260 private void computeWidgetX() {
261 GC gc= new GC(fTextWidget);
262 int pixels= gc.getFontMetrics().getAverageCharWidth();
263 gc.dispose();
264
265 fCachedWidgetX= pixels * fMarginWidth;
266 }
267
268 /*
269 * @see IPainter#deactivate(bool)
270 */
271 public void deactivate(bool redraw) {
272 if (fIsActive) {
273 fIsActive= false;
274 fCachedWidgetX= -1;
275 fTextWidget.removePaintListener(this);
276 if (redraw)
277 fTextWidget.redraw();
278 }
279 }
280
281 /*
282 * @see IPainter#dispose()
283 */
284 public void dispose() {
285 fTextWidget= null;
286 }
287
288 /*
289 * @see IPainter#paint(int)
290 */
291 public void paint(int reason) {
292 if (!fIsActive) {
293 fIsActive= true;
294 fTextWidget.addPaintListener(this);
295 if (fCachedWidgetX is -1)
296 computeWidgetX();
297 fTextWidget.redraw();
298 } else if (CONFIGURATION is reason || INTERNAL is reason)
299 fTextWidget.redraw();
300 }
301
302 /*
303 * @see org.eclipse.swt.events.PaintListener#paintControl(org.eclipse.swt.events.PaintEvent)
304 */
305 public void paintControl(PaintEvent e) {
306 if (fTextWidget !is null) {
307 int x= fCachedWidgetX - fTextWidget.getHorizontalPixel();
308 if (x >= 0) {
309 Rectangle area= fTextWidget.getClientArea();
310 e.gc.setForeground(fColor);
311 e.gc.setLineStyle(fLineStyle);
312 e.gc.setLineWidth(fLineWidth);
313 e.gc.drawLine(x, 0, x, area.height);
314 }
315 }
316 }
317
318 /*
319 * @see org.eclipse.jface.text.IPainter#setPositionManager(org.eclipse.jface.text.IPaintPositionManager)
320 */
321 public void setPositionManager(IPaintPositionManager manager) {
322 }
323 }