|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 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.IInformationControlExtension5;
|
|
|
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.MarginPainter; // packageimport
|
|
|
100 import dwtx.jface.text.IPaintPositionManager; // packageimport
|
|
|
101 import dwtx.jface.text.TextPresentation; // packageimport
|
|
|
102 import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport
|
|
|
103 import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport
|
|
|
104 import dwtx.jface.text.ISelectionValidator; // packageimport
|
|
|
105 import dwtx.jface.text.IDocumentExtension; // packageimport
|
|
|
106 import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport
|
|
|
107 import dwtx.jface.text.ConfigurableLineTracker; // packageimport
|
|
|
108 import dwtx.jface.text.SlaveDocumentEvent; // packageimport
|
|
|
109 import dwtx.jface.text.IDocumentListener; // packageimport
|
|
|
110 import dwtx.jface.text.PaintManager; // packageimport
|
|
|
111 import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport
|
|
|
112 import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport
|
|
|
113 import dwtx.jface.text.IDocumentExtension3; // packageimport
|
|
|
114 import dwtx.jface.text.Position; // packageimport
|
|
|
115 import dwtx.jface.text.TextMessages; // packageimport
|
|
|
116 import dwtx.jface.text.CopyOnWriteTextStore; // packageimport
|
|
|
117 import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport
|
|
|
118 import dwtx.jface.text.IPositionUpdater; // packageimport
|
|
|
119 import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport
|
|
|
120 import dwtx.jface.text.ListLineTracker; // packageimport
|
|
|
121 import dwtx.jface.text.ITextInputListener; // packageimport
|
|
|
122 import dwtx.jface.text.BadPositionCategoryException; // packageimport
|
|
|
123 import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport
|
|
|
124 import dwtx.jface.text.IInputChangedListener; // packageimport
|
|
|
125 import dwtx.jface.text.ITextOperationTarget; // packageimport
|
|
|
126 import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport
|
|
|
127 import dwtx.jface.text.ITextViewerExtension7; // 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
|
|
|
161 import dwt.DWT;
|
|
|
162 import dwt.graphics.Point;
|
|
|
163 import dwt.widgets.Control;
|
|
|
164 import dwtx.jface.resource.JFaceResources;
|
|
|
165
|
|
|
166
|
|
|
167 /**
|
|
|
168 * Extension interface for {@link dwtx.jface.text.IInformationControl}.
|
|
|
169 * Adds API
|
|
|
170 * <ul>
|
|
|
171 * <li>to test the visibility of the control,</li>
|
|
|
172 * <li>to test whether another control is a child of the information control,</li>
|
|
|
173 * <li>to compute size constraints based on the information control's main font and</li>
|
|
|
174 * <li>to return a control creator for an enriched version of this information control.</li>
|
|
|
175 * </ul>
|
|
|
176 *
|
|
|
177 * <p>
|
|
|
178 * <b>Important:</b> Enriching this information control only works properly if
|
|
|
179 * {@link IInformationControl#isFocusControl()} is implemented like this (<code>fShell</code>
|
|
|
180 * is the control's shell):
|
|
|
181 *
|
|
|
182 * <pre>
|
|
|
183 * return fShell.getDisplay().getActiveShell() is fShell
|
|
|
184 * </pre>
|
|
|
185 * Likewise,
|
|
|
186 * {@link IInformationControl#addFocusListener(dwt.events.FocusListener)}
|
|
|
187 * should install listeners for {@link DWT#Activate} and {@link DWT#Deactivate}
|
|
|
188 * on the shell and forward events to the focus listeners. Clients are
|
|
|
189 * encouraged to subclass {@link AbstractInformationControl}, which does this
|
|
|
190 * for free.
|
|
|
191 * </p>
|
|
|
192 *
|
|
|
193 * @see dwtx.jface.text.IInformationControl
|
|
|
194 * @since 3.4
|
|
|
195 */
|
|
|
196 public interface IInformationControlExtension5 {
|
|
|
197
|
|
|
198 /**
|
|
|
199 * Tests whether the given control is this information control
|
|
|
200 * or a child of this information control.
|
|
|
201 *
|
|
|
202 * @param control the control to test
|
|
|
203 * @return <code>true</code> iff the given control is this information control
|
|
|
204 * or a child of this information control
|
|
|
205 */
|
|
|
206 public bool containsControl(Control control);
|
|
|
207
|
|
|
208 /**
|
|
|
209 * @return <code>true</code> iff the information control is currently visible
|
|
|
210 */
|
|
|
211 public abstract bool isVisible();
|
|
|
212
|
|
|
213 /**
|
|
|
214 * Computes the width- and height constraints of the information control in
|
|
|
215 * pixels, based on the given width and height in characters. Implementors
|
|
|
216 * should use the main font of the information control to do the
|
|
|
217 * characters-to-pixels conversion. This is typically the
|
|
|
218 * {@link JFaceResources#getDialogFont() dialog font}.
|
|
|
219 *
|
|
|
220 * @param widthInChars the width constraint in number of characters
|
|
|
221 * @param heightInChars the height constraint in number of characters
|
|
|
222 * @return a point with width and height in pixels, or <code>null</code>
|
|
|
223 * to use the subject control's font to calculate the size
|
|
|
224 */
|
|
|
225 public Point computeSizeConstraints(int widthInChars, int heightInChars);
|
|
|
226
|
|
|
227 /**
|
|
|
228 * Returns the rich information control creator for this information control.
|
|
|
229 * <p>
|
|
|
230 * The returned information control creator is used to create an enriched version of this
|
|
|
231 * information control, e.g. when the mouse is moved into this control and it needs to be
|
|
|
232 * {@link ITextViewerExtension8#setHoverEnrichMode(dwtx.jface.text.ITextViewerExtension8.EnrichMode) enriched}
|
|
|
233 * or when it needs to be made sticky for other reasons.
|
|
|
234 * </p>
|
|
|
235 * <p>
|
|
|
236 * The returned information control creator must create information controls
|
|
|
237 * that implement {@link IInformationControlExtension3} and {@link IInformationControlExtension2},
|
|
|
238 * and whose {@link IInformationControlExtension2#setInput(Object)} accepts all inputs that are
|
|
|
239 * also supported by this information control.
|
|
|
240 * </p>
|
|
|
241 * <p>
|
|
|
242 * Note that automatic enriching of this information control works only if it also implements
|
|
|
243 * {@link IInformationControlExtension3}.
|
|
|
244 * </p>
|
|
|
245 * <p>
|
|
|
246 * This method may be called frequently, so implementors should ensure it returns quickly,
|
|
|
247 * e.g. by caching the returned creator.
|
|
|
248 * </p>
|
|
|
249 *
|
|
|
250 * @return the information presenter control creator or <code>null</code> to disable enriching
|
|
|
251 */
|
|
|
252 IInformationControlCreator getInformationPresenterControlCreator();
|
|
|
253
|
|
|
254 }
|
