Mercurial > projects > dwt-addons
annotate dwtx/jface/text/source/AnnotationModelEvent.d @ 162:1a5b8f8129df
...
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Mon, 08 Sep 2008 00:51:37 +0200 |
| parents | f70d9508c95c |
| children |
| rev | line source |
|---|---|
| 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 module dwtx.jface.text.source.AnnotationModelEvent; | |
| 14 | |
| 131 | 15 import dwtx.jface.text.source.ISharedTextColors; // packageimport |
| 16 import dwtx.jface.text.source.ILineRange; // packageimport | |
| 17 import dwtx.jface.text.source.IAnnotationPresentation; // packageimport | |
| 18 import dwtx.jface.text.source.IVerticalRulerInfoExtension; // packageimport | |
| 19 import dwtx.jface.text.source.ICharacterPairMatcher; // packageimport | |
| 20 import dwtx.jface.text.source.TextInvocationContext; // packageimport | |
| 21 import dwtx.jface.text.source.LineChangeHover; // packageimport | |
| 22 import dwtx.jface.text.source.IChangeRulerColumn; // packageimport | |
| 23 import dwtx.jface.text.source.IAnnotationMap; // packageimport | |
| 24 import dwtx.jface.text.source.IAnnotationModelListenerExtension; // packageimport | |
| 25 import dwtx.jface.text.source.ISourceViewerExtension2; // packageimport | |
| 26 import dwtx.jface.text.source.IAnnotationHover; // packageimport | |
| 27 import dwtx.jface.text.source.ContentAssistantFacade; // packageimport | |
| 28 import dwtx.jface.text.source.IAnnotationAccess; // packageimport | |
| 29 import dwtx.jface.text.source.IVerticalRulerExtension; // packageimport | |
| 30 import dwtx.jface.text.source.IVerticalRulerColumn; // packageimport | |
| 31 import dwtx.jface.text.source.LineNumberRulerColumn; // packageimport | |
| 32 import dwtx.jface.text.source.MatchingCharacterPainter; // packageimport | |
| 33 import dwtx.jface.text.source.IAnnotationModelExtension; // packageimport | |
| 34 import dwtx.jface.text.source.ILineDifferExtension; // packageimport | |
| 35 import dwtx.jface.text.source.DefaultCharacterPairMatcher; // packageimport | |
| 36 import dwtx.jface.text.source.LineNumberChangeRulerColumn; // packageimport | |
| 37 import dwtx.jface.text.source.IAnnotationAccessExtension; // packageimport | |
| 38 import dwtx.jface.text.source.ISourceViewer; // packageimport | |
| 39 import dwtx.jface.text.source.AnnotationModel; // packageimport | |
| 40 import dwtx.jface.text.source.ILineDifferExtension2; // packageimport | |
| 41 import dwtx.jface.text.source.IAnnotationModelListener; // packageimport | |
| 42 import dwtx.jface.text.source.IVerticalRuler; // packageimport | |
| 43 import dwtx.jface.text.source.DefaultAnnotationHover; // packageimport | |
| 44 import dwtx.jface.text.source.SourceViewer; // packageimport | |
| 45 import dwtx.jface.text.source.SourceViewerConfiguration; // packageimport | |
| 46 import dwtx.jface.text.source.AnnotationBarHoverManager; // packageimport | |
| 47 import dwtx.jface.text.source.CompositeRuler; // packageimport | |
| 48 import dwtx.jface.text.source.ImageUtilities; // packageimport | |
| 49 import dwtx.jface.text.source.VisualAnnotationModel; // packageimport | |
| 50 import dwtx.jface.text.source.IAnnotationModel; // packageimport | |
| 51 import dwtx.jface.text.source.ISourceViewerExtension3; // packageimport | |
| 52 import dwtx.jface.text.source.ILineDiffInfo; // packageimport | |
| 53 import dwtx.jface.text.source.VerticalRulerEvent; // packageimport | |
| 54 import dwtx.jface.text.source.ChangeRulerColumn; // packageimport | |
| 55 import dwtx.jface.text.source.ILineDiffer; // packageimport | |
| 56 import dwtx.jface.text.source.AnnotationColumn; // packageimport | |
| 57 import dwtx.jface.text.source.AnnotationRulerColumn; // packageimport | |
| 58 import dwtx.jface.text.source.IAnnotationHoverExtension; // packageimport | |
| 59 import dwtx.jface.text.source.AbstractRulerColumn; // packageimport | |
| 60 import dwtx.jface.text.source.ISourceViewerExtension; // packageimport | |
| 61 import dwtx.jface.text.source.AnnotationMap; // packageimport | |
| 62 import dwtx.jface.text.source.IVerticalRulerInfo; // packageimport | |
| 63 import dwtx.jface.text.source.IAnnotationModelExtension2; // packageimport | |
| 64 import dwtx.jface.text.source.LineRange; // packageimport | |
| 65 import dwtx.jface.text.source.IAnnotationAccessExtension2; // packageimport | |
| 66 import dwtx.jface.text.source.VerticalRuler; // packageimport | |
| 67 import dwtx.jface.text.source.JFaceTextMessages; // packageimport | |
| 68 import dwtx.jface.text.source.IOverviewRuler; // packageimport | |
| 69 import dwtx.jface.text.source.Annotation; // packageimport | |
| 70 import dwtx.jface.text.source.IVerticalRulerListener; // packageimport | |
| 71 import dwtx.jface.text.source.ISourceViewerExtension4; // packageimport | |
| 72 import dwtx.jface.text.source.AnnotationPainter; // packageimport | |
| 73 import dwtx.jface.text.source.IAnnotationHoverExtension2; // packageimport | |
| 74 import dwtx.jface.text.source.OverviewRuler; // packageimport | |
| 75 import dwtx.jface.text.source.OverviewRulerHoverManager; // packageimport | |
| 76 | |
| 77 | |
| 129 | 78 import dwt.dwthelper.utils; |
| 79 | |
| 80 | |
|
153
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
143
diff
changeset
|
81 import dwtx.dwtxhelper.Collection; |
|
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
143
diff
changeset
|
82 |
|
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
143
diff
changeset
|
83 |
|
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
143
diff
changeset
|
84 |
| 129 | 85 |
| 86 import dwtx.jface.text.Position; | |
| 87 | |
| 88 | |
| 89 /** | |
| 90 * Specification of changes applied to annotation models. The event carries the | |
| 91 * changed annotation model as well as added, removed, and modified annotations. | |
| 92 * <p> | |
| 93 * An event can be sealed. Afterwards it can not be modified. Thus, the normal | |
| 94 * process is that an empty event is created, filled with the changed | |
| 95 * information, and before it is sent to the listeners, the event is sealed. | |
| 96 * | |
| 97 * @see dwtx.jface.text.source.IAnnotationModel | |
| 98 * @see dwtx.jface.text.source.IAnnotationModelListenerExtension | |
| 99 * @since 2.0 | |
| 100 */ | |
| 101 public class AnnotationModelEvent { | |
| 102 | |
| 103 /** The model this event refers to. */ | |
| 104 private IAnnotationModel fAnnotationModel; | |
| 105 /** | |
| 106 * The added annotations. | |
| 107 * @since 3.0 | |
| 108 */ | |
| 162 | 109 private Set fAddedAnnotations; |
| 129 | 110 /** |
| 111 * The removed annotations. | |
| 112 * @since 3.0 | |
| 113 */ | |
| 162 | 114 private Map fRemovedAnnotations; |
| 129 | 115 /** |
| 116 * The changed annotations. | |
| 117 * @since 3.0 | |
| 118 */ | |
| 162 | 119 private Set fChangedAnnotations; |
| 129 | 120 /** |
| 121 * Indicates that this event does not contain detailed information. | |
| 122 * @since 3.0 | |
| 123 */ | |
| 124 private bool fIsWorldChange; | |
| 125 /** | |
| 126 * The modification stamp. | |
| 127 * @since 3.0 | |
| 128 */ | |
| 129 private Object fModificationStamp; | |
| 130 | |
| 131 /** | |
| 132 * Creates a new annotation model event for the given model. | |
| 133 * | |
| 134 * @param model the model | |
| 135 */ | |
|
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
136 public this(IAnnotationModel model) { |
| 129 | 137 this(model, true); |
| 138 } | |
| 139 | |
| 140 /** | |
| 141 * Creates a new annotation model event for the given model. | |
| 142 * | |
| 143 * @param model the model | |
| 144 * @param isWorldChange <code>true</code> if world change | |
| 145 * @since 3.0 | |
| 146 */ | |
|
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
147 public this(IAnnotationModel model, bool isWorldChange) { |
| 162 | 148 fAddedAnnotations= new HashSet(); |
| 149 fRemovedAnnotations= new HashMap(); | |
| 150 fChangedAnnotations= new HashSet(); | |
| 151 | |
| 129 | 152 fAnnotationModel= model; |
| 153 fIsWorldChange= isWorldChange; | |
| 154 } | |
| 155 | |
| 156 /** | |
| 157 * Returns the model this event refers to. | |
| 158 * | |
| 159 * @return the model this events belongs to | |
| 160 */ | |
| 161 public IAnnotationModel getAnnotationModel() { | |
| 162 return fAnnotationModel; | |
| 163 } | |
| 164 | |
| 165 /** | |
| 166 * Adds the given annotation to the set of annotations that are reported as | |
| 167 * being added from the model. If this event is considered a world change, | |
| 168 * it is no longer so after this method has successfully finished. | |
| 169 * | |
| 170 * @param annotation the added annotation | |
| 171 * @since 3.0 | |
| 172 */ | |
| 173 public void annotationAdded(Annotation annotation) { | |
| 174 fAddedAnnotations.add(annotation); | |
| 175 fIsWorldChange= false; | |
| 176 } | |
| 177 | |
| 178 /** | |
| 179 * Returns the added annotations. | |
| 180 * | |
| 181 * @return the added annotations | |
| 182 * @since 3.0 | |
| 183 */ | |
| 184 public Annotation[] getAddedAnnotations() { | |
| 185 int size= fAddedAnnotations.size(); | |
| 186 Annotation[] added= new Annotation[size]; | |
| 187 fAddedAnnotations.toArray(added); | |
| 188 return added; | |
| 189 } | |
| 190 | |
| 191 /** | |
| 192 * Adds the given annotation to the set of annotations that are reported as | |
| 193 * being removed from the model. If this event is considered a world | |
| 194 * change, it is no longer so after this method has successfully finished. | |
| 195 * | |
| 196 * @param annotation the removed annotation | |
| 197 * @since 3.0 | |
| 198 */ | |
| 199 public void annotationRemoved(Annotation annotation) { | |
| 200 annotationRemoved(annotation, null); | |
| 201 } | |
| 202 | |
| 203 /** | |
| 204 * Adds the given annotation to the set of annotations that are reported as | |
| 205 * being removed from the model. If this event is considered a world | |
| 206 * change, it is no longer so after this method has successfully finished. | |
| 207 * | |
| 208 * @param annotation the removed annotation | |
| 209 * @param position the position of the removed annotation | |
| 210 * @since 3.0 | |
| 211 */ | |
| 212 public void annotationRemoved(Annotation annotation, Position position) { | |
| 213 fRemovedAnnotations.put(annotation, position); | |
| 214 fIsWorldChange= false; | |
| 215 } | |
| 216 | |
| 217 /** | |
| 218 * Returns the removed annotations. | |
| 219 * | |
| 220 * @return the removed annotations | |
| 221 * @since 3.0 | |
| 222 */ | |
| 223 public Annotation[] getRemovedAnnotations() { | |
| 224 int size= fRemovedAnnotations.size(); | |
| 225 Annotation[] removed= new Annotation[size]; | |
| 226 fRemovedAnnotations.keySet().toArray(removed); | |
| 227 return removed; | |
| 228 } | |
| 229 | |
| 230 /** | |
| 231 * Returns the position of the removed annotation at that point in time | |
| 232 * when the annotation has been removed. | |
| 233 * | |
| 234 * @param annotation the removed annotation | |
| 235 * @return the position of the removed annotation or <code>null</code> | |
| 236 * @since 3.0 | |
| 237 */ | |
| 238 public Position getPositionOfRemovedAnnotation(Annotation annotation) { | |
| 134 | 239 return cast(Position) fRemovedAnnotations.get(annotation); |
| 129 | 240 } |
| 241 | |
| 242 /** | |
| 243 * Adds the given annotation to the set of annotations that are reported as | |
| 244 * being changed from the model. If this event is considered a world | |
| 245 * change, it is no longer so after this method has successfully finished. | |
| 246 * | |
| 247 * @param annotation the changed annotation | |
| 248 * @since 3.0 | |
| 249 */ | |
| 250 public void annotationChanged(Annotation annotation) { | |
| 251 fChangedAnnotations.add(annotation); | |
| 252 fIsWorldChange= false; | |
| 253 } | |
| 254 | |
| 255 /** | |
| 256 * Returns the changed annotations. | |
| 257 * | |
| 258 * @return the changed annotations | |
| 259 * @since 3.0 | |
| 260 */ | |
| 261 public Annotation[] getChangedAnnotations() { | |
| 262 int size= fChangedAnnotations.size(); | |
| 263 Annotation[] changed= new Annotation[size]; | |
| 264 fChangedAnnotations.toArray(changed); | |
| 265 return changed; | |
| 266 } | |
| 267 | |
| 268 /** | |
| 269 * Returns whether this annotation model event is empty or not. If this | |
| 270 * event represents a world change, this method returns <code>false</code> | |
| 271 * although the event does not carry any added, removed, or changed | |
| 272 * annotations. | |
| 273 * | |
| 274 * @return <code>true</code> if this event is empty | |
| 275 * @since 3.0 | |
| 276 */ | |
| 277 public bool isEmpty() { | |
| 278 return !fIsWorldChange && fAddedAnnotations.isEmpty() && fRemovedAnnotations.isEmpty() && fChangedAnnotations.isEmpty(); | |
| 279 } | |
| 280 | |
| 281 /** | |
| 282 * Returns whether this annotation model events contains detailed | |
| 283 * information about the modifications applied to the event annotation | |
| 284 * model or whether it represents a world change. I.e. everything in the | |
| 285 * model might have changed. | |
| 286 * | |
| 287 * @return <code>true</code> if world change, <code>false</code> otherwise | |
| 288 * @since 3.0 | |
| 289 */ | |
| 290 public bool isWorldChange() { | |
| 291 return fIsWorldChange; | |
| 292 } | |
| 293 | |
| 294 /** | |
| 295 * Marks this event as world change according to the given flag. | |
| 296 * | |
| 297 * @param isWorldChange <code>true</code> if this event is a world change, <code>false</code> otherwise | |
| 298 * @since 3.0 | |
| 299 */ | |
| 300 void markWorldChange(bool isWorldChange) { | |
| 301 fIsWorldChange= isWorldChange; | |
| 302 } | |
| 303 | |
| 304 /** | |
| 305 * Returns whether this annotation model event is still valid. | |
| 306 * | |
| 307 * @return <code>true</code> if this event is still valid, <code>false</code> otherwise | |
| 308 * @since 3.0 | |
| 309 */ | |
| 310 public bool isValid() { | |
| 143 | 311 if (fModificationStamp !is null && cast(IAnnotationModelExtension)fAnnotationModel ) { |
| 134 | 312 IAnnotationModelExtension extension= cast(IAnnotationModelExtension) fAnnotationModel; |
| 129 | 313 return fModificationStamp is extension.getModificationStamp(); |
| 314 } | |
| 315 return true; | |
| 316 } | |
| 317 | |
| 318 /** | |
| 319 * Seals this event. Any direct modification to the annotation model after the event has been sealed | |
| 320 * invalidates this event. | |
| 321 * | |
| 322 * @since 3.0 | |
| 323 */ | |
| 324 public void markSealed() { | |
| 138 | 325 if ( cast(IAnnotationModelExtension)fAnnotationModel ) { |
| 134 | 326 IAnnotationModelExtension extension= cast(IAnnotationModelExtension) fAnnotationModel; |
| 129 | 327 fModificationStamp= extension.getModificationStamp(); |
| 328 } | |
| 329 } | |
| 330 } |