changeset 31:51d06982c550

LocalSelectionTransfer
author Frank Benoit <benoit@tionex.de>
date Thu, 03 Apr 2008 19:27:28 +0200
parents 913f0fd3b347
children 5802cda3813d
files dwtx/jface/util/LocalSelectionTransfer.d
diffstat 1 files changed, 180 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/util/LocalSelectionTransfer.d	Thu Apr 03 19:27:28 2008 +0200
@@ -0,0 +1,180 @@
+/*******************************************************************************
+ * Copyright (c) 2005, 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.util.LocalSelectionTransfer;
+
+import dwtx.jface.util.Policy;
+
+import dwt.dnd.ByteArrayTransfer;
+import dwt.dnd.TransferData;
+import dwtx.core.runtime.IStatus;
+import dwtx.core.runtime.Status;
+import dwtx.jface.resource.JFaceResources;
+import dwtx.jface.viewers.ISelection;
+
+import dwt.dwthelper.utils;
+import tango.text.convert.Format;
+
+/**
+ * A LocalSelectionTransfer may be used for drag and drop operations
+ * within the same instance of Eclipse.
+ * The selection is made available directly for use in the DropTargetListener.
+ * dropAccept method. The DropTargetEvent passed to dropAccept does not contain
+ * the drop data. The selection may be used for validation purposes so that the
+ * drop can be aborted if appropriate.
+ *
+ * This class is not intended to be subclassed.
+ *
+ * @since 3.2
+ */
+public class LocalSelectionTransfer : ByteArrayTransfer {
+
+    // First attempt to create a UUID for the type name to make sure that
+    // different Eclipse applications use different "types" of
+    // <code>LocalSelectionTransfer</code>
+    private static const String TYPE_NAME;
+
+    private static const int TYPEID;
+
+    private static const LocalSelectionTransfer INSTANCE;
+
+    private ISelection selection;
+
+    private long selectionSetTime;
+
+    static this(){
+        TYPE_NAME = Format("local-selection-transfer-format{}", System.currentTimeMillis()); //$NON-NLS-1$;
+        TYPEID = registerType(TYPE_NAME);
+        INSTANCE = new LocalSelectionTransfer();
+    }
+
+    /**
+     * Only the singleton instance of this class may be used.
+     */
+    protected this() {
+        // do nothing
+    }
+
+    /**
+     * Returns the singleton.
+     *
+     * @return the singleton
+     */
+    public static LocalSelectionTransfer getTransfer() {
+        return INSTANCE;
+    }
+
+    /**
+     * Returns the local transfer data.
+     *
+     * @return the local transfer data
+     */
+    public ISelection getSelection() {
+        return selection;
+    }
+
+    /**
+     * Tests whether native drop data matches this transfer type.
+     *
+     * @param result result of converting the native drop data to Java
+     * @return true if the native drop data does not match this transfer type.
+     *  false otherwise.
+     */
+    private bool isInvalidNativeType(Object result) {
+        return !(cast(ArrayWrapperByte)result )
+                || !TYPE_NAME.equals(cast(char[])(cast(ArrayWrapperByte) result).array);
+    }
+
+    /**
+     * Returns the type id used to identify this transfer.
+     *
+     * @return the type id used to identify this transfer.
+     */
+    protected int[] getTypeIds() {
+        return [ TYPEID ];
+    }
+
+    /**
+     * Returns the type name used to identify this transfer.
+     *
+     * @return the type name used to identify this transfer.
+     */
+    protected String[] getTypeNames() {
+        return [ TYPE_NAME ];
+    }
+
+    /**
+     * Overrides dwt.dnd.ByteArrayTransfer#javaToNative(Object,
+     * TransferData).
+     * Only encode the transfer type name since the selection is read and
+     * written in the same process.
+     *
+     * @see dwt.dnd.ByteArrayTransfer#javaToNative(java.lang.Object, dwt.dnd.TransferData)
+     */
+    public void javaToNative(Object object, TransferData transferData) {
+        auto check = new ArrayWrapperByte( cast(byte[])TYPE_NAME );
+        super.javaToNative(check, transferData);
+    }
+
+    /**
+     * Overrides dwt.dnd.ByteArrayTransfer#nativeToJava(TransferData).
+     * Test if the native drop data matches this transfer type.
+     *
+     * @see dwt.dnd.ByteArrayTransfer#nativeToJava(TransferData)
+     */
+    public Object nativeToJava(TransferData transferData) {
+        Object result = super.nativeToJava(transferData);
+        if (isInvalidNativeType(result)) {
+            Policy.getLog().log(new Status(
+                            IStatus.ERROR,
+                            Policy.JFACE,
+                            IStatus.ERROR,
+                            JFaceResources.getString("LocalSelectionTransfer.errorMessage"), null)); //$NON-NLS-1$
+        }
+        return cast(Object) selection;
+    }
+
+    /**
+     * Sets the transfer data for local use.
+     *
+     * @param s the transfer data
+     */
+    public void setSelection(ISelection s) {
+        selection = s;
+    }
+
+    /**
+     * Returns the time when the selection operation
+     * this transfer is associated with was started.
+     *
+     * @return the time when the selection operation has started
+     *
+     * @see dwt.events.TypedEvent#time
+     */
+    public long getSelectionSetTime() {
+        return selectionSetTime;
+    }
+
+    /**
+     * Sets the time when the selection operation this
+     * transfer is associated with was started.
+     * If assigning this from an DWT event, be sure to use
+     * <code>setSelectionTime(event.time & 0xFFFF)</code>
+     *
+     * @param time the time when the selection operation was started
+     *
+     * @see dwt.events.TypedEvent#time
+     */
+    public void setSelectionSetTime(long time) {
+        selectionSetTime = time;
+    }
+}