diff dwtx/jface/text/hyperlink/IHyperlinkPresenter.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/hyperlink/IHyperlinkPresenter.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,80 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2008 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.hyperlink.IHyperlinkPresenter;
+
+import dwt.dwthelper.utils;
+
+import dwtx.jface.text.ITextViewer;
+
+
+/**
+ * A hyperlink presenter shows hyperlinks on the installed text viewer
+ * and allows to pick one on of the hyperlinks.
+ * <p>
+ * In order to provide backward compatibility for clients of <code>IHyperlinkDetector</code>, extension
+ * interfaces are used to provide a means of evolution. The following extension interfaces exist:
+ * <ul>
+ * <li>{@link IHyperlinkPresenterExtension} since version 3.4,
+ *      adds the ability to query  whether the currently shown hyperlinks
+ *      can be hidden.
+ * </li>
+ * </ul></p>
+ * <p>
+ * Clients may implement this interface. A default implementation is provided
+ * through {@link dwtx.jface.text.hyperlink.DefaultHyperlinkPresenter}.
+ * </p>
+ *
+ * @see IHyperlinkPresenterExtension
+ * @since 3.1
+ */
+public interface IHyperlinkPresenter {
+
+    /**
+     * Tells whether this presenter is able to handle
+     * more than one hyperlink.
+     *
+     * @return <code>true</code> if this presenter can handle more than one hyperlink
+     */
+    bool canShowMultipleHyperlinks();
+
+    /**
+     * Tells this hyperlink presenter to show the given
+     * hyperlinks on the installed text viewer.
+     *
+     * @param hyperlinks the hyperlinks to show
+     * @throws IllegalArgumentException if
+     *          <ul>
+     *              <li><code>hyperlinks</code> is empty</li>
+     *              <li>{@link #canShowMultipleHyperlinks()} returns <code>false</code> and <code>hyperlinks</code> contains more than one element</li>
+     *          </ul>
+     */
+    void showHyperlinks(IHyperlink[] hyperlinks) throws IllegalArgumentException;
+
+    /**
+     * Tells this hyperlink presenter to hide the hyperlinks
+     * requested to be shown by {@link #showHyperlinks(IHyperlink[])}.
+     */
+    void hideHyperlinks();
+
+    /**
+     * Installs this hyperlink presenter on the given text viewer.
+     *
+     * @param textViewer the text viewer
+     */
+    void install(ITextViewer textViewer);
+
+    /**
+     * Uninstalls this hyperlink presenter.
+     */
+    void uninstall();
+}