|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 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
|
|
131
|
14
|
|
151
|
15 module dwtx.jface.text.IPainter;
|
|
|
16
|
|
131
|
17 import dwtx.jface.text.IDocumentPartitioningListener; // packageimport
|
|
|
18 import dwtx.jface.text.DefaultTextHover; // packageimport
|
|
|
19 import dwtx.jface.text.AbstractInformationControl; // packageimport
|
|
|
20 import dwtx.jface.text.TextUtilities; // packageimport
|
|
|
21 import dwtx.jface.text.IInformationControlCreatorExtension; // packageimport
|
|
|
22 import dwtx.jface.text.AbstractInformationControlManager; // packageimport
|
|
|
23 import dwtx.jface.text.ITextViewerExtension2; // packageimport
|
|
|
24 import dwtx.jface.text.IDocumentPartitioner; // packageimport
|
|
|
25 import dwtx.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport
|
|
|
26 import dwtx.jface.text.ITextSelection; // packageimport
|
|
|
27 import dwtx.jface.text.Document; // packageimport
|
|
|
28 import dwtx.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport
|
|
|
29 import dwtx.jface.text.ITextListener; // packageimport
|
|
|
30 import dwtx.jface.text.BadPartitioningException; // packageimport
|
|
|
31 import dwtx.jface.text.ITextViewerExtension5; // packageimport
|
|
|
32 import dwtx.jface.text.IDocumentPartitionerExtension3; // packageimport
|
|
|
33 import dwtx.jface.text.IUndoManager; // packageimport
|
|
|
34 import dwtx.jface.text.ITextHoverExtension2; // packageimport
|
|
|
35 import dwtx.jface.text.IRepairableDocument; // packageimport
|
|
|
36 import dwtx.jface.text.IRewriteTarget; // packageimport
|
|
|
37 import dwtx.jface.text.DefaultPositionUpdater; // packageimport
|
|
|
38 import dwtx.jface.text.RewriteSessionEditProcessor; // packageimport
|
|
|
39 import dwtx.jface.text.TextViewerHoverManager; // packageimport
|
|
|
40 import dwtx.jface.text.DocumentRewriteSession; // packageimport
|
|
|
41 import dwtx.jface.text.TextViewer; // packageimport
|
|
|
42 import dwtx.jface.text.ITextViewerExtension8; // packageimport
|
|
|
43 import dwtx.jface.text.RegExMessages; // packageimport
|
|
|
44 import dwtx.jface.text.IDelayedInputChangeProvider; // packageimport
|
|
|
45 import dwtx.jface.text.ITextOperationTargetExtension; // packageimport
|
|
|
46 import dwtx.jface.text.IWidgetTokenOwner; // packageimport
|
|
|
47 import dwtx.jface.text.IViewportListener; // packageimport
|
|
|
48 import dwtx.jface.text.GapTextStore; // packageimport
|
|
|
49 import dwtx.jface.text.MarkSelection; // packageimport
|
|
|
50 import dwtx.jface.text.IDocumentPartitioningListenerExtension; // packageimport
|
|
|
51 import dwtx.jface.text.IDocumentAdapterExtension; // packageimport
|
|
|
52 import dwtx.jface.text.IInformationControlExtension; // packageimport
|
|
|
53 import dwtx.jface.text.IDocumentPartitioningListenerExtension2; // packageimport
|
|
|
54 import dwtx.jface.text.DefaultDocumentAdapter; // packageimport
|
|
|
55 import dwtx.jface.text.ITextViewerExtension3; // packageimport
|
|
|
56 import dwtx.jface.text.IInformationControlCreator; // packageimport
|
|
|
57 import dwtx.jface.text.TypedRegion; // packageimport
|
|
|
58 import dwtx.jface.text.ISynchronizable; // packageimport
|
|
|
59 import dwtx.jface.text.IMarkRegionTarget; // packageimport
|
|
|
60 import dwtx.jface.text.TextViewerUndoManager; // packageimport
|
|
|
61 import dwtx.jface.text.IRegion; // packageimport
|
|
|
62 import dwtx.jface.text.IInformationControlExtension2; // packageimport
|
|
|
63 import dwtx.jface.text.IDocumentExtension4; // packageimport
|
|
|
64 import dwtx.jface.text.IDocumentExtension2; // packageimport
|
|
|
65 import dwtx.jface.text.IDocumentPartitionerExtension2; // packageimport
|
|
|
66 import dwtx.jface.text.Assert; // packageimport
|
|
|
67 import dwtx.jface.text.DefaultInformationControl; // packageimport
|
|
|
68 import dwtx.jface.text.IWidgetTokenOwnerExtension; // packageimport
|
|
|
69 import dwtx.jface.text.DocumentClone; // packageimport
|
|
|
70 import dwtx.jface.text.DefaultUndoManager; // packageimport
|
|
|
71 import dwtx.jface.text.IFindReplaceTarget; // packageimport
|
|
|
72 import dwtx.jface.text.IAutoEditStrategy; // packageimport
|
|
|
73 import dwtx.jface.text.ILineTrackerExtension; // packageimport
|
|
|
74 import dwtx.jface.text.IUndoManagerExtension; // packageimport
|
|
|
75 import dwtx.jface.text.TextSelection; // packageimport
|
|
|
76 import dwtx.jface.text.DefaultAutoIndentStrategy; // packageimport
|
|
|
77 import dwtx.jface.text.IAutoIndentStrategy; // packageimport
|
|
|
78 import dwtx.jface.text.IInformationControl; // packageimport
|
|
|
79 import dwtx.jface.text.IInformationControlExtension3; // packageimport
|
|
|
80 import dwtx.jface.text.ITextViewerExtension6; // packageimport
|
|
|
81 import dwtx.jface.text.IInformationControlExtension4; // packageimport
|
|
|
82 import dwtx.jface.text.DefaultLineTracker; // packageimport
|
|
|
83 import dwtx.jface.text.IDocumentInformationMappingExtension; // packageimport
|
|
|
84 import dwtx.jface.text.IRepairableDocumentExtension; // packageimport
|
|
|
85 import dwtx.jface.text.ITextHover; // packageimport
|
|
|
86 import dwtx.jface.text.FindReplaceDocumentAdapter; // packageimport
|
|
|
87 import dwtx.jface.text.ILineTracker; // packageimport
|
|
|
88 import dwtx.jface.text.Line; // packageimport
|
|
|
89 import dwtx.jface.text.ITextViewerExtension; // packageimport
|
|
|
90 import dwtx.jface.text.IDocumentAdapter; // packageimport
|
|
|
91 import dwtx.jface.text.TextEvent; // packageimport
|
|
|
92 import dwtx.jface.text.BadLocationException; // packageimport
|
|
|
93 import dwtx.jface.text.AbstractDocument; // packageimport
|
|
|
94 import dwtx.jface.text.AbstractLineTracker; // packageimport
|
|
|
95 import dwtx.jface.text.TreeLineTracker; // packageimport
|
|
|
96 import dwtx.jface.text.ITextPresentationListener; // packageimport
|
|
|
97 import dwtx.jface.text.Region; // packageimport
|
|
|
98 import dwtx.jface.text.ITextViewer; // packageimport
|
|
|
99 import dwtx.jface.text.IDocumentInformationMapping; // packageimport
|
|
|
100 import dwtx.jface.text.MarginPainter; // packageimport
|
|
|
101 import dwtx.jface.text.IPaintPositionManager; // packageimport
|
|
|
102 import dwtx.jface.text.TextPresentation; // packageimport
|
|
|
103 import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport
|
|
|
104 import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport
|
|
|
105 import dwtx.jface.text.ISelectionValidator; // packageimport
|
|
|
106 import dwtx.jface.text.IDocumentExtension; // packageimport
|
|
|
107 import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport
|
|
|
108 import dwtx.jface.text.ConfigurableLineTracker; // packageimport
|
|
|
109 import dwtx.jface.text.SlaveDocumentEvent; // packageimport
|
|
|
110 import dwtx.jface.text.IDocumentListener; // packageimport
|
|
|
111 import dwtx.jface.text.PaintManager; // packageimport
|
|
|
112 import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport
|
|
|
113 import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport
|
|
|
114 import dwtx.jface.text.IDocumentExtension3; // packageimport
|
|
|
115 import dwtx.jface.text.Position; // packageimport
|
|
|
116 import dwtx.jface.text.TextMessages; // packageimport
|
|
|
117 import dwtx.jface.text.CopyOnWriteTextStore; // packageimport
|
|
|
118 import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport
|
|
|
119 import dwtx.jface.text.IPositionUpdater; // packageimport
|
|
|
120 import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport
|
|
|
121 import dwtx.jface.text.ListLineTracker; // packageimport
|
|
|
122 import dwtx.jface.text.ITextInputListener; // packageimport
|
|
|
123 import dwtx.jface.text.BadPositionCategoryException; // packageimport
|
|
|
124 import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport
|
|
|
125 import dwtx.jface.text.IInputChangedListener; // packageimport
|
|
|
126 import dwtx.jface.text.ITextOperationTarget; // packageimport
|
|
|
127 import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport
|
|
|
128 import dwtx.jface.text.ITextViewerExtension7; // packageimport
|
|
|
129 import dwtx.jface.text.IInformationControlExtension5; // packageimport
|
|
|
130 import dwtx.jface.text.IDocumentRewriteSessionListener; // packageimport
|
|
|
131 import dwtx.jface.text.JFaceTextUtil; // packageimport
|
|
|
132 import dwtx.jface.text.AbstractReusableInformationControlCreator; // packageimport
|
|
|
133 import dwtx.jface.text.TabsToSpacesConverter; // packageimport
|
|
|
134 import dwtx.jface.text.CursorLinePainter; // packageimport
|
|
|
135 import dwtx.jface.text.ITextHoverExtension; // packageimport
|
|
|
136 import dwtx.jface.text.IEventConsumer; // packageimport
|
|
|
137 import dwtx.jface.text.IDocument; // packageimport
|
|
|
138 import dwtx.jface.text.IWidgetTokenKeeper; // packageimport
|
|
|
139 import dwtx.jface.text.DocumentCommand; // packageimport
|
|
|
140 import dwtx.jface.text.TypedPosition; // packageimport
|
|
|
141 import dwtx.jface.text.IEditingSupportRegistry; // packageimport
|
|
|
142 import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport
|
|
|
143 import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport
|
|
|
144 import dwtx.jface.text.IEditingSupport; // packageimport
|
|
|
145 import dwtx.jface.text.IMarkSelection; // packageimport
|
|
|
146 import dwtx.jface.text.ISlaveDocumentManager; // packageimport
|
|
|
147 import dwtx.jface.text.DocumentEvent; // packageimport
|
|
|
148 import dwtx.jface.text.DocumentPartitioningChangedEvent; // packageimport
|
|
|
149 import dwtx.jface.text.ITextStore; // packageimport
|
|
|
150 import dwtx.jface.text.JFaceTextMessages; // packageimport
|
|
|
151 import dwtx.jface.text.DocumentRewriteSessionEvent; // packageimport
|
|
|
152 import dwtx.jface.text.SequentialRewriteTextStore; // packageimport
|
|
|
153 import dwtx.jface.text.DocumentRewriteSessionType; // packageimport
|
|
|
154 import dwtx.jface.text.TextAttribute; // packageimport
|
|
|
155 import dwtx.jface.text.ITextViewerExtension4; // packageimport
|
|
|
156 import dwtx.jface.text.ITypedRegion; // packageimport
|
|
|
157
|
|
129
|
158 import dwt.dwthelper.utils;
|
|
|
159
|
|
|
160
|
|
|
161 /**
|
|
|
162 * A painter is responsible for creating, managing, updating, and removing
|
|
|
163 * visual decorations on an <code>ITextViewer</code>'s text widget. Examples
|
|
|
164 * are the highlighting of the caret line, the print margin, or the highlighting
|
|
|
165 * of matching peer characters such as pairs of brackets.</p>
|
|
|
166 * <p>
|
|
|
167 * Clients may implement this interface.</p>
|
|
|
168 * <p>
|
|
|
169 * Painters should be registered with a
|
|
|
170 * {@link dwtx.jface.text.PaintManager}. The paint manager tracks
|
|
|
171 * several classes of events issued by an <code>ITextViewer</code> and reacts
|
|
|
172 * by appropriately invoking the registered painters.
|
|
|
173 * <p>
|
|
|
174 * Painters are either active or inactive. Usually, painters are initially
|
|
|
175 * inactive and are activated by the first call to their <code>paint</code>
|
|
|
176 * method. Painters can be deactivated by calling <code>deactivate</code>.
|
|
|
177 * Inactive painter can be reactivated by calling <code>paint</code>.
|
|
|
178 * <p>
|
|
|
179 * Painters usually have to manage state information. E.g., a painter painting a
|
|
|
180 * caret line highlight must redraw the previous and the actual caret line in
|
|
|
181 * the advent of a change of the caret position. This state information must be
|
|
|
182 * adapted to changes of the viewer's content. In order to support this common
|
|
|
183 * scenario, the <code>PaintManager</code> gives a painter access to a
|
|
|
184 * {@link dwtx.jface.text.IPaintPositionManager}. The painter can use
|
|
|
185 * this updater to manage its state information.
|
|
|
186 * <p>
|
|
|
187 *
|
|
|
188 * @see dwtx.jface.text.PaintManager
|
|
|
189 * @see dwtx.jface.text.IPaintPositionManager
|
|
|
190 * @since 2.1
|
|
|
191 */
|
|
|
192 public interface IPainter {
|
|
|
193
|
|
|
194 /**
|
|
|
195 * Constant describing the reason of a repaint request: selection changed.
|
|
|
196 */
|
|
|
197 int SELECTION= 0;
|
|
|
198 /**
|
|
|
199 * Constant describing the reason of a repaint request: text changed.
|
|
|
200 */
|
|
|
201 int TEXT_CHANGE= 1;
|
|
|
202 /**
|
|
|
203 * Constant describing the reason of a repaint request: key pressed.
|
|
|
204 */
|
|
|
205 int KEY_STROKE= 2;
|
|
|
206 /**
|
|
|
207 * Constant describing the reason of a repaint request: mouse button pressed.
|
|
|
208 */
|
|
|
209 int MOUSE_BUTTON= 4;
|
|
|
210 /**
|
|
|
211 * Constant describing the reason of a repaint request: paint manager internal change.
|
|
|
212 */
|
|
|
213 int INTERNAL= 8;
|
|
|
214 /**
|
|
|
215 * Constant describing the reason of a repaint request: paint manager or painter configuration changed.
|
|
|
216 */
|
|
|
217 int CONFIGURATION= 16;
|
|
|
218
|
|
|
219
|
|
|
220 /**
|
|
|
221 * Disposes this painter. Prior to disposing, a painter should be deactivated. A disposed
|
|
|
222 * painter can not be reactivated.
|
|
|
223 *
|
|
|
224 * @see #deactivate(bool)
|
|
|
225 */
|
|
|
226 void dispose();
|
|
|
227
|
|
|
228 /**
|
|
|
229 * Requests this painter to repaint because of the given reason. Based on
|
|
|
230 * the given reason the painter can decide whether it will repaint or not.
|
|
|
231 * If it repaints and is inactive, it will activate itself.
|
|
|
232 *
|
|
|
233 * @param reason the repaint reason, value is one of the constants defined
|
|
|
234 * in this interface
|
|
|
235 */
|
|
|
236 void paint(int reason);
|
|
|
237
|
|
|
238 /**
|
|
|
239 * Deactivates this painter. If the painter is inactive, this call does not
|
|
|
240 * have any effect. <code>redraw</code> indicates whether the painter
|
|
|
241 * should remove any decoration it previously applied. A deactivated painter
|
|
|
242 * can be reactivated by calling <code>paint</code>.
|
|
|
243 *
|
|
|
244 * @param redraw <code>true</code> if any previously applied decoration
|
|
|
245 * should be removed
|
|
|
246 * @see #paint(int)
|
|
|
247 */
|
|
|
248 void deactivate(bool redraw);
|
|
|
249
|
|
|
250 /**
|
|
|
251 * Sets the paint position manager that can be used by this painter or removes any previously
|
|
|
252 * set paint position manager.
|
|
|
253 *
|
|
|
254 * @param manager the paint position manager or <code>null</code>
|
|
|
255 */
|
|
|
256 void setPositionManager(IPaintPositionManager manager);
|
|
|
257 }
|
