diff dwtx/jface/text/IPositionUpdater.d @ 129:eb30df5ca28b

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/text/IPositionUpdater.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module dwtx.jface.text.IPositionUpdater;
+
+import dwt.dwthelper.utils;
+
+
+/**
+ * A position updater is responsible for adapting document positions. When
+ * installed on a document, the position updater updates the document's
+ * positions to changes applied to this document. Document updaters can be
+ * selective, i.e. they might only update positions of a certain category.
+ * <p>
+ * Position updaters are of primary importance for the definition of the
+ * semantics of positions.
+ * <p>
+ * Clients may implement this interface or use the standard implementation
+ * {@link dwtx.jface.text.DefaultPositionUpdater}.
+ * </p>
+ *
+ * @see dwtx.jface.text.IDocument
+ * @see dwtx.jface.text.Position
+ */
+public interface IPositionUpdater {
+
+    /**
+     * Adapts positions to the change specified by the document event.
+     * It is ensured that the document's partitioning has been adapted to
+     * this document change and that all the position updaters which have
+     * a smaller index in the document's position updater list have been called.
+     *
+     * @param event the document event describing the document change
+     */
+    void update(DocumentEvent event);
+}