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