|
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.ITextViewerExtension;
|
|
|
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.IPainter; // packageimport
|
|
|
79 import dwtx.jface.text.IInformationControl; // packageimport
|
|
|
80 import dwtx.jface.text.IInformationControlExtension3; // packageimport
|
|
|
81 import dwtx.jface.text.ITextViewerExtension6; // packageimport
|
|
|
82 import dwtx.jface.text.IInformationControlExtension4; // packageimport
|
|
|
83 import dwtx.jface.text.DefaultLineTracker; // packageimport
|
|
|
84 import dwtx.jface.text.IDocumentInformationMappingExtension; // packageimport
|
|
|
85 import dwtx.jface.text.IRepairableDocumentExtension; // packageimport
|
|
|
86 import dwtx.jface.text.ITextHover; // packageimport
|
|
|
87 import dwtx.jface.text.FindReplaceDocumentAdapter; // packageimport
|
|
|
88 import dwtx.jface.text.ILineTracker; // packageimport
|
|
|
89 import dwtx.jface.text.Line; // 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 import dwt.custom.VerifyKeyListener;
|
|
|
162 import dwt.widgets.Control;
|
|
|
163
|
|
|
164
|
|
|
165 /**
|
|
|
166 * Extension interface for {@link dwtx.jface.text.ITextViewer}.
|
|
|
167 * <p>
|
|
|
168 * This extension interface replaces the event consumer mechanism (
|
|
|
169 * {@link dwtx.jface.text.ITextViewer#setEventConsumer(IEventConsumer)})
|
|
|
170 * with a set of methods that allow to manage a sequence of
|
|
|
171 * {@link dwt.custom.VerifyKeyListener}objects. It also adds
|
|
|
172 * <ul>
|
|
|
173 * <li>access to the control of this viewer</li>
|
|
|
174 * <li>marked region support as in emacs</li>
|
|
|
175 * <li>control of the viewer's redraw behavior by introducing
|
|
|
176 * <code>setRedraw(bool)</code>
|
|
|
177 * <li>access to the viewer's rewrite target.
|
|
|
178 * </ul>
|
|
|
179 *
|
|
|
180 * A rewrite target ({@link dwtx.jface.text.IRewriteTarget}) represents
|
|
|
181 * an facade offering the necessary methods to manipulate a document that is the
|
|
|
182 * input document of a text viewer.
|
|
|
183 *
|
|
|
184 * @since 2.0
|
|
|
185 */
|
|
|
186 public interface ITextViewerExtension {
|
|
|
187
|
|
|
188 /**
|
|
|
189 * Inserts the verify key listener at the beginning of the viewer's list of
|
|
|
190 * verify key listeners. If the listener is already registered with the
|
|
|
191 * viewer this call moves the listener to the beginning of the list.
|
|
|
192 *
|
|
|
193 * @param listener the listener to be inserted
|
|
|
194 */
|
|
|
195 void prependVerifyKeyListener(VerifyKeyListener listener);
|
|
|
196
|
|
|
197 /**
|
|
|
198 * Appends a verify key listener to the viewer's list of verify key
|
|
|
199 * listeners. If the listener is already registered with the viewer this
|
|
|
200 * call moves the listener to the end of the list.
|
|
|
201 *
|
|
|
202 * @param listener the listener to be added
|
|
|
203 */
|
|
|
204 void appendVerifyKeyListener(VerifyKeyListener listener);
|
|
|
205
|
|
|
206 /**
|
|
|
207 * Removes the verify key listener from the viewer's list of verify key listeners.
|
|
|
208 * If the listener is not registered with this viewer, this call has no effect.
|
|
|
209 *
|
|
|
210 * @param listener the listener to be removed
|
|
|
211 */
|
|
|
212 void removeVerifyKeyListener(VerifyKeyListener listener);
|
|
|
213
|
|
|
214 /**
|
|
|
215 * Returns the control of this viewer.
|
|
|
216 *
|
|
|
217 * @return the control of this viewer
|
|
|
218 */
|
|
|
219 Control getControl();
|
|
|
220
|
|
|
221 /**
|
|
|
222 * Sets a mark at the given offset or clears the mark if the specified
|
|
|
223 * offset is <code>-1</code>. If a mark is set and the selection is
|
|
|
224 * empty, cut and copy actions performed on this text viewer work on the
|
|
|
225 * region described by the positions of the mark and the cursor.
|
|
|
226 *
|
|
|
227 * @param offset the offset of the mark
|
|
|
228 */
|
|
|
229 void setMark(int offset);
|
|
|
230
|
|
|
231 /**
|
|
|
232 * Returns the position of the mark, <code>-1</code> if the mark is not set.
|
|
|
233 *
|
|
|
234 * @return the position of the mark or <code>-1</code> if no mark is set
|
|
|
235 */
|
|
|
236 int getMark();
|
|
|
237
|
|
|
238 /**
|
|
|
239 * Enables/disables the redrawing of this text viewer. This temporarily
|
|
|
240 * disconnects the viewer from its underlying
|
|
|
241 * {@link dwt.custom.StyledText}widget. While being
|
|
|
242 * disconnected only the viewer's selection may be changed using
|
|
|
243 * <code>setSelectedRange</code>. Any direct manipulation of the widget
|
|
|
244 * as well as calls to methods that change the viewer's presentation state
|
|
|
245 * (such as enabling the segmented view) are not allowed. When redrawing is
|
|
|
246 * disabled the viewer does not send out any selection or view port change
|
|
|
247 * notification. When redrawing is enabled again, a selection change
|
|
|
248 * notification is sent out for the selected range and this range is
|
|
|
249 * revealed causing a view port changed notification.
|
|
|
250 *
|
|
|
251 * @param redraw <code>true</code> to enable redrawing, <code>false</code>
|
|
|
252 * otherwise
|
|
|
253 */
|
|
|
254 void setRedraw(bool redraw);
|
|
|
255
|
|
|
256 /**
|
|
|
257 * Returns the viewer's rewrite target.
|
|
|
258 *
|
|
|
259 * @return the viewer's rewrite target
|
|
|
260 */
|
|
|
261 IRewriteTarget getRewriteTarget();
|
|
|
262 }
|
