Mercurial > projects > dwt-addons
annotate dwtx/jface/text/DocumentEvent.d @ 159:7926b636c282
...
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Wed, 27 Aug 2008 01:57:58 +0200 |
| parents | eb21d3dfc767 |
| children | 3678e4f1a766 |
| rev | line source |
|---|---|
| 129 | 1 /******************************************************************************* |
| 2 * Copyright (c) 2000, 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 | |
| 131 | 14 |
| 151 | 15 module dwtx.jface.text.DocumentEvent; |
| 16 | |
| 159 | 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 | |
| 131 | 63 import dwtx.jface.text.IDocumentExtension4; // packageimport |
| 159 | 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.ITextViewerExtension; // packageimport | |
| 91 // import dwtx.jface.text.IDocumentAdapter; // packageimport | |
| 92 // import dwtx.jface.text.TextEvent; // packageimport | |
| 93 // import dwtx.jface.text.BadLocationException; // packageimport | |
| 94 // import dwtx.jface.text.AbstractDocument; // packageimport | |
| 95 // import dwtx.jface.text.AbstractLineTracker; // packageimport | |
| 96 // import dwtx.jface.text.TreeLineTracker; // packageimport | |
| 97 // import dwtx.jface.text.ITextPresentationListener; // packageimport | |
| 98 // import dwtx.jface.text.Region; // packageimport | |
| 99 // import dwtx.jface.text.ITextViewer; // packageimport | |
| 100 // import dwtx.jface.text.IDocumentInformationMapping; // packageimport | |
| 101 // import dwtx.jface.text.MarginPainter; // packageimport | |
| 102 // import dwtx.jface.text.IPaintPositionManager; // packageimport | |
| 103 // import dwtx.jface.text.TextPresentation; // packageimport | |
| 104 // import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport | |
| 105 // import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport | |
| 106 // import dwtx.jface.text.ISelectionValidator; // packageimport | |
| 107 // import dwtx.jface.text.IDocumentExtension; // packageimport | |
| 108 // import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport | |
| 109 // import dwtx.jface.text.ConfigurableLineTracker; // packageimport | |
| 110 // import dwtx.jface.text.SlaveDocumentEvent; // packageimport | |
| 111 // import dwtx.jface.text.IDocumentListener; // packageimport | |
| 112 // import dwtx.jface.text.PaintManager; // packageimport | |
| 113 // import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport | |
| 114 // import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport | |
| 115 // import dwtx.jface.text.IDocumentExtension3; // packageimport | |
| 116 // import dwtx.jface.text.Position; // packageimport | |
| 117 // import dwtx.jface.text.TextMessages; // packageimport | |
| 118 // import dwtx.jface.text.CopyOnWriteTextStore; // packageimport | |
| 119 // import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport | |
| 120 // import dwtx.jface.text.IPositionUpdater; // packageimport | |
| 121 // import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport | |
| 122 // import dwtx.jface.text.ListLineTracker; // packageimport | |
| 123 // import dwtx.jface.text.ITextInputListener; // packageimport | |
| 124 // import dwtx.jface.text.BadPositionCategoryException; // packageimport | |
| 125 // import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport | |
| 126 // import dwtx.jface.text.IInputChangedListener; // packageimport | |
| 127 // import dwtx.jface.text.ITextOperationTarget; // packageimport | |
| 128 // import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport | |
| 129 // import dwtx.jface.text.ITextViewerExtension7; // packageimport | |
| 130 // import dwtx.jface.text.IInformationControlExtension5; // packageimport | |
| 131 // import dwtx.jface.text.IDocumentRewriteSessionListener; // packageimport | |
| 132 // import dwtx.jface.text.JFaceTextUtil; // packageimport | |
| 133 // import dwtx.jface.text.AbstractReusableInformationControlCreator; // packageimport | |
| 134 // import dwtx.jface.text.TabsToSpacesConverter; // packageimport | |
| 135 // import dwtx.jface.text.CursorLinePainter; // packageimport | |
| 136 // import dwtx.jface.text.ITextHoverExtension; // packageimport | |
| 137 // import dwtx.jface.text.IEventConsumer; // packageimport | |
| 131 | 138 import dwtx.jface.text.IDocument; // packageimport |
| 159 | 139 // import dwtx.jface.text.IWidgetTokenKeeper; // packageimport |
| 140 // import dwtx.jface.text.DocumentCommand; // packageimport | |
| 141 // import dwtx.jface.text.TypedPosition; // packageimport | |
| 142 // import dwtx.jface.text.IEditingSupportRegistry; // packageimport | |
| 143 // import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport | |
| 144 // import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport | |
| 145 // import dwtx.jface.text.IEditingSupport; // packageimport | |
| 146 // import dwtx.jface.text.IMarkSelection; // packageimport | |
| 147 // import dwtx.jface.text.ISlaveDocumentManager; // 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 | |
| 131 | 157 |
| 129 | 158 import dwt.dwthelper.utils; |
| 159 | |
| 160 import dwtx.core.runtime.Assert; | |
| 161 | |
| 162 | |
| 163 /** | |
| 164 * Specification of changes applied to documents. All changes are represented as | |
| 165 * replace commands, i.e. specifying a document range whose text gets replaced | |
| 166 * with different text. In addition to this information, the event also contains | |
| 167 * the changed document. | |
| 168 * | |
| 169 * @see dwtx.jface.text.IDocument | |
| 170 */ | |
| 171 public class DocumentEvent { | |
| 150 | 172 |
| 129 | 173 /** |
| 174 * Debug option for asserting that text is not null. | |
| 175 * If the <code>dwtx.text/debug/DocumentEvent/assertTextNotNull</code> | |
| 176 * system property is <code>true</code> | |
| 150 | 177 * |
| 129 | 178 * @since 3.3 |
| 179 */ | |
| 159 | 180 private static bool ASSERT_TEXT_NOT_NULL_init = false; |
| 181 private static bool ASSERT_TEXT_NOT_NULL_; | |
| 182 private static bool ASSERT_TEXT_NOT_NULL(){ | |
| 183 if( !ASSERT_TEXT_NOT_NULL_init ){ | |
| 184 ASSERT_TEXT_NOT_NULL_init = true; | |
| 185 ASSERT_TEXT_NOT_NULL_= Boolean.getBoolean("dwtx.text/debug/DocumentEvent/assertTextNotNull"); //$NON-NLS-1$ | |
| 186 } | |
| 187 return ASSERT_TEXT_NOT_NULL_; | |
| 188 } | |
| 129 | 189 |
| 190 /** The changed document */ | |
| 191 public IDocument fDocument; | |
| 192 /** The document offset */ | |
| 193 public int fOffset; | |
| 194 /** Length of the replaced document text */ | |
| 195 public int fLength; | |
| 196 /** Text inserted into the document */ | |
| 197 public String fText= ""; //$NON-NLS-1$ | |
| 198 /** | |
| 199 * The modification stamp of the document when firing this event. | |
| 200 * @since 3.1 and public since 3.3 | |
| 201 */ | |
| 202 public long fModificationStamp; | |
| 203 | |
| 204 /** | |
| 205 * Creates a new document event. | |
| 206 * | |
| 207 * @param doc the changed document | |
| 208 * @param offset the offset of the replaced text | |
| 209 * @param length the length of the replaced text | |
| 210 * @param text the substitution text | |
| 211 */ | |
|
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
212 public this(IDocument doc, int offset, int length, String text) { |
| 129 | 213 |
| 214 Assert.isNotNull(doc); | |
| 215 Assert.isTrue(offset >= 0); | |
| 216 Assert.isTrue(length >= 0); | |
| 217 | |
| 150 | 218 if (ASSERT_TEXT_NOT_NULL) |
| 129 | 219 Assert.isNotNull(text); |
| 220 | |
| 221 fDocument= doc; | |
| 222 fOffset= offset; | |
| 223 fLength= length; | |
| 224 fText= text; | |
| 225 | |
| 138 | 226 if ( cast(IDocumentExtension4)fDocument ) |
| 134 | 227 fModificationStamp= (cast(IDocumentExtension4)fDocument).getModificationStamp(); |
| 129 | 228 else |
| 229 fModificationStamp= IDocumentExtension4.UNKNOWN_MODIFICATION_STAMP; | |
| 230 } | |
| 231 | |
| 232 /** | |
| 233 * Creates a new, not initialized document event. | |
| 234 */ | |
|
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
235 public this() { |
| 129 | 236 } |
| 237 | |
| 238 /** | |
| 239 * Returns the changed document. | |
| 240 * | |
| 241 * @return the changed document | |
| 242 */ | |
| 243 public IDocument getDocument() { | |
| 244 return fDocument; | |
| 245 } | |
| 246 | |
| 247 /** | |
| 248 * Returns the offset of the change. | |
| 249 * | |
| 250 * @return the offset of the change | |
| 251 */ | |
| 252 public int getOffset() { | |
| 253 return fOffset; | |
| 254 } | |
| 255 | |
| 256 /** | |
| 257 * Returns the length of the replaced text. | |
| 258 * | |
| 259 * @return the length of the replaced text | |
| 260 */ | |
| 261 public int getLength() { | |
| 262 return fLength; | |
| 263 } | |
| 264 | |
| 265 /** | |
| 266 * Returns the text that has been inserted. | |
| 267 * | |
| 268 * @return the text that has been inserted | |
| 269 */ | |
| 270 public String getText() { | |
| 271 return fText; | |
| 272 } | |
| 273 | |
| 274 /** | |
| 275 * Returns the document's modification stamp at the | |
| 276 * time when this event was sent. | |
| 277 * | |
| 278 * @return the modification stamp or {@link IDocumentExtension4#UNKNOWN_MODIFICATION_STAMP}. | |
| 279 * @see IDocumentExtension4#getModificationStamp() | |
| 280 * @since 3.1 | |
| 281 */ | |
| 282 public long getModificationStamp() { | |
| 283 return fModificationStamp; | |
| 284 } | |
| 150 | 285 |
| 129 | 286 /* |
| 287 * @see java.lang.Object#toString() | |
| 288 * @since 3.4 | |
| 289 */ | |
| 290 public String toString() { | |
| 291 StringBuffer buffer= new StringBuffer(); | |
| 292 buffer.append("offset: " ); //$NON-NLS-1$ | |
| 293 buffer.append(fOffset); | |
| 294 buffer.append(", length: " ); //$NON-NLS-1$ | |
| 295 buffer.append(fLength); | |
| 296 buffer.append(", timestamp: " ); //$NON-NLS-1$ | |
| 297 buffer.append(fModificationStamp); | |
| 298 buffer.append("\ntext:>" ); //$NON-NLS-1$ | |
| 299 buffer.append(fText); | |
| 300 buffer.append("<\n" ); //$NON-NLS-1$ | |
| 301 return buffer.toString(); | |
| 302 } | |
| 303 } |