diff dwtx/jface/text/source/projection/IProjectionPosition.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/source/projection/IProjectionPosition.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * 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.source.projection.IProjectionPosition;
+
+import dwt.dwthelper.utils;
+
+import dwtx.jface.text.BadLocationException;
+import dwtx.jface.text.IDocument;
+import dwtx.jface.text.IRegion;
+
+
+/**
+ * An <code>IProjectionPosition</code> is a position that is associated with a
+ * <code>ProjectionAnnotation</code> and that is able to compute its collapsed
+ * regions. That is, if a <code>Position</code> implements this interface,
+ * <code>ProjectionViewer</code> will delegate to the
+ * {@link #computeProjectionRegions(IDocument) computeProjectionRegions} method
+ * when determining the document regions that should be collapsed for a certain
+ * <code>ProjectionAnnotation</code>.
+ *
+ * @since 3.1
+ */
+public interface IProjectionPosition {
+
+    /**
+     * Returns an array of regions that should be collapsed when the annotation
+     * belonging to this position is collapsed. May return null instead of
+     * an empty array.
+     *
+     * @param document the document that this position is attached to
+     * @return the foldable regions for this position
+     * @throws BadLocationException if accessing the document fails
+     */
+    IRegion[] computeProjectionRegions(IDocument document) throws BadLocationException;
+
+    /**
+     * Returns the offset of the caption (the anchor region) of this projection
+     * position. The returned offset is relative to the receivers offset into
+     * the document.
+     *
+     * @param document the document that this position is attached to
+     * @return the caption offset relative to the position's offset
+     * @throws BadLocationException if accessing the document fails
+     */
+    int computeCaptionOffset(IDocument document) throws BadLocationException;
+
+}