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