diff dwtx/jface/text/contentassist/CompletionProposal.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/contentassist/CompletionProposal.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,137 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2006 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.contentassist.CompletionProposal;
+
+import dwt.dwthelper.utils;
+
+
+
+
+import dwt.graphics.Image;
+import dwt.graphics.Point;
+import dwtx.core.runtime.Assert;
+import dwtx.jface.text.BadLocationException;
+import dwtx.jface.text.IDocument;
+
+
+/**
+ * The standard implementation of the <code>ICompletionProposal</code> interface.
+ */
+public final class CompletionProposal : ICompletionProposal {
+
+    /** The string to be displayed in the completion proposal popup. */
+    private String fDisplayString;
+    /** The replacement string. */
+    private String fReplacementString;
+    /** The replacement offset. */
+    private int fReplacementOffset;
+    /** The replacement length. */
+    private int fReplacementLength;
+    /** The cursor position after this proposal has been applied. */
+    private int fCursorPosition;
+    /** The image to be displayed in the completion proposal popup. */
+    private Image fImage;
+    /** The context information of this proposal. */
+    private IContextInformation fContextInformation;
+    /** The additional info of this proposal. */
+    private String fAdditionalProposalInfo;
+
+    /**
+     * Creates a new completion proposal based on the provided information. The replacement string is
+     * considered being the display string too. All remaining fields are set to <code>null</code>.
+     *
+     * @param replacementString the actual string to be inserted into the document
+     * @param replacementOffset the offset of the text to be replaced
+     * @param replacementLength the length of the text to be replaced
+     * @param cursorPosition the position of the cursor following the insert relative to replacementOffset
+     */
+    public CompletionProposal(String replacementString, int replacementOffset, int replacementLength, int cursorPosition) {
+        this(replacementString, replacementOffset, replacementLength, cursorPosition, null, null, null, null);
+    }
+
+    /**
+     * Creates a new completion proposal. All fields are initialized based on the provided information.
+     *
+     * @param replacementString the actual string to be inserted into the document
+     * @param replacementOffset the offset of the text to be replaced
+     * @param replacementLength the length of the text to be replaced
+     * @param cursorPosition the position of the cursor following the insert relative to replacementOffset
+     * @param image the image to display for this proposal
+     * @param displayString the string to be displayed for the proposal
+     * @param contextInformation the context information associated with this proposal
+     * @param additionalProposalInfo the additional information associated with this proposal
+     */
+    public CompletionProposal(String replacementString, int replacementOffset, int replacementLength, int cursorPosition, Image image, String displayString, IContextInformation contextInformation, String additionalProposalInfo) {
+        Assert.isNotNull(replacementString);
+        Assert.isTrue(replacementOffset >= 0);
+        Assert.isTrue(replacementLength >= 0);
+        Assert.isTrue(cursorPosition >= 0);
+
+        fReplacementString= replacementString;
+        fReplacementOffset= replacementOffset;
+        fReplacementLength= replacementLength;
+        fCursorPosition= cursorPosition;
+        fImage= image;
+        fDisplayString= displayString;
+        fContextInformation= contextInformation;
+        fAdditionalProposalInfo= additionalProposalInfo;
+    }
+
+    /*
+     * @see ICompletionProposal#apply(IDocument)
+     */
+    public void apply(IDocument document) {
+        try {
+            document.replace(fReplacementOffset, fReplacementLength, fReplacementString);
+        } catch (BadLocationException x) {
+            // ignore
+        }
+    }
+
+    /*
+     * @see ICompletionProposal#getSelection(IDocument)
+     */
+    public Point getSelection(IDocument document) {
+        return new Point(fReplacementOffset + fCursorPosition, 0);
+    }
+
+    /*
+     * @see ICompletionProposal#getContextInformation()
+     */
+    public IContextInformation getContextInformation() {
+        return fContextInformation;
+    }
+
+    /*
+     * @see ICompletionProposal#getImage()
+     */
+    public Image getImage() {
+        return fImage;
+    }
+
+    /*
+     * @see ICompletionProposal#getDisplayString()
+     */
+    public String getDisplayString() {
+        if (fDisplayString !is null)
+            return fDisplayString;
+        return fReplacementString;
+    }
+
+    /*
+     * @see ICompletionProposal#getAdditionalProposalInfo()
+     */
+    public String getAdditionalProposalInfo() {
+        return fAdditionalProposalInfo;
+    }
+}