diff options
author | Carolyn MacLeod <carolyn> | 2008-06-04 20:45:22 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2008-06-04 20:45:22 +0000 |
commit | 45b394fe10eb1852268eed201cf431c4774b5428 (patch) | |
tree | 00ccb791c8930d127177c0034c8ee92863d9cedc /bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt | |
parent | 5ccbc836d63be99bd6e1cf9e6c2cc8027488f31c (diff) | |
download | eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.tar.gz eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.tar.xz eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.zip |
After Javadoc Bash for 3.4RC4
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt')
16 files changed, 51 insertions, 5 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ByteArrayTransfer.java index 7a1e4aa3af..3a947db409 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -116,6 +116,8 @@ import org.eclipse.swt.internal.photon.*; * } * } * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public abstract class ByteArrayTransfer extends Transfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Clipboard.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Clipboard.java index 0b8dfe8e0f..9acf4863fa 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Clipboard.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Clipboard.java @@ -21,6 +21,10 @@ import org.eclipse.swt.internal.photon.*; * application to another or within an application. * * <p>IMPORTANT: This class is <em>not</em> intended to be subclassed.</p> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#clipboard">Clipboard snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ClipboardExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class Clipboard { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DragSource.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DragSource.java index 5368e677ed..aa229861c0 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DragSource.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DragSource.java @@ -89,6 +89,10 @@ import org.eclipse.swt.widgets.*; * <dt><b>Styles</b></dt> <dd>DND.DROP_NONE, DND.DROP_COPY, DND.DROP_MOVE, DND.DROP_LINK</dd> * <dt><b>Events</b></dt> <dd>DND.DragStart, DND.DragSetData, DND.DragEnd</dd> * </dl> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#dnd">Drag and Drop snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: DNDExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class DragSource extends Widget { @@ -195,6 +199,7 @@ public DragSource(Control control, int style) { * </ul> * * @see DragSourceListener + * @see #getDragListeners * @see #removeDragListener * @see DragSourceEvent */ @@ -235,6 +240,9 @@ public Control getControl () { * operation is in progress, by sending it one of the messages defined in * the <code>DragSourceListener</code> interface. * + * @return the listeners who will be notified when a drag and drop + * operation is in progress + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -303,7 +311,7 @@ private void onDispose() { * Removes the listener from the collection of listeners who will * be notified when a drag and drop operation is in progress. * - * @param listener the listener which should be notified + * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> @@ -315,6 +323,7 @@ private void onDispose() { * * @see DragSourceListener * @see #addDragListener + * @see #getDragListeners */ public void removeDragListener(DragSourceListener listener) { if (listener == null) DND.error (SWT.ERROR_NULL_ARGUMENT); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DropTarget.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DropTarget.java index 6118307606..6b6da41906 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DropTarget.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/DropTarget.java @@ -64,6 +64,10 @@ import org.eclipse.swt.widgets.*; * <dt><b>Events</b></dt> <dd>DND.DragEnter, DND.DragLeave, DND.DragOver, DND.DragOperationChanged, * DND.DropAccept, DND.Drop </dd> * </dl> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#dnd">Drag and Drop snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: DNDExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class DropTarget extends Widget { @@ -167,6 +171,7 @@ public DropTarget(Control control, int style) { * </ul> * * @see DropTargetListener + * @see #getDropListeners * @see #removeDropListener * @see DropTargetEvent */ @@ -210,6 +215,9 @@ public Control getControl () { * operation is in progress, by sending it one of the messages defined in * the <code>DropTargetListener</code> interface. * + * @return the listeners who will be notified when a drag and drop + * operation is in progress + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -277,7 +285,7 @@ void onDispose () { * Removes the listener from the collection of listeners who will * be notified when a drag and drop operation is in progress. * - * @param listener the listener which should be notified + * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> @@ -289,6 +297,7 @@ void onDispose () { * * @see DropTargetListener * @see #addDropListener + * @see #getDropListeners */ public void removeDropListener(DropTargetListener listener) { if (listener == null) DND.error (SWT.ERROR_NULL_ARGUMENT); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/FileTransfer.java index 770621fde5..d2ab481986 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/FileTransfer.java @@ -30,6 +30,8 @@ import org.eclipse.swt.internal.Converter; * fileData[0] = file1.getAbsolutePath(); * fileData[1] = file2.getAbsolutePath(); * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class FileTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/HTMLTransfer.java index 101c3c1436..64ce6bf82b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/HTMLTransfer.java @@ -25,6 +25,8 @@ import org.eclipse.swt.internal.photon.OS; * <code><pre> * String htmlData = "<p>This is a paragraph of text.</p>"; * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class HTMLTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ImageTransfer.java index f88090675c..0aba6cd562 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/ImageTransfer.java @@ -23,6 +23,10 @@ package org.eclipse.swt.dnd; * Image image = new Image("C:\temp\img1.gif"); * ImageData imgData = image.getImageData(); * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * + * @since 3.4 */ public class ImageTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/RTFTransfer.java index 47608ae7dd..bcccfe957f 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/RTFTransfer.java @@ -26,6 +26,8 @@ import org.eclipse.swt.internal.photon.OS; * <code><pre> * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class RTFTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDragSourceEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDragSourceEffect.java index 416864d6f5..634c82ac1c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDragSourceEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDragSourceEffect.java @@ -26,6 +26,7 @@ import org.eclipse.swt.widgets.*; * * @see DragSourceEffect * @see DragSourceEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDropTargetEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDropTargetEffect.java index ab075d16b3..ccc99a269a 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDropTargetEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TableDropTargetEffect.java @@ -38,6 +38,7 @@ import org.eclipse.swt.widgets.*; * * @see DropTargetAdapter * @see DropTargetEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TextTransfer.java index a5a4a9513a..69a89c36fa 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TextTransfer.java @@ -27,6 +27,7 @@ import org.eclipse.swt.internal.photon.OS; * </code></pre> * * @see Transfer + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class TextTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Transfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Transfer.java index d71ba64cbf..05629c8f1e 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Transfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/Transfer.java @@ -22,6 +22,9 @@ package org.eclipse.swt.dnd; * ByteArrayTransfer class.</p> * * @see ByteArrayTransfer + * @see <a href="http://www.eclipse.org/swt/snippets/#dnd">Drag and Drop snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: DNDExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public abstract class Transfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TransferData.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TransferData.java index ca25599073..f98ef33f3e 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TransferData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TransferData.java @@ -24,6 +24,8 @@ package org.eclipse.swt.dnd; * <p>You should only need to become familiar with the fields in this class if you * are implementing a Transfer subclass and you are unable to subclass the * ByteArrayTransfer class.</p> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class TransferData { /** diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDragSourceEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDragSourceEffect.java index 97cd46f444..0d6d6d9949 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDragSourceEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDragSourceEffect.java @@ -25,6 +25,7 @@ import org.eclipse.swt.widgets.*; * * @see DragSourceEffect * @see DragSourceEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDropTargetEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDropTargetEffect.java index 71536f846c..d8ae6e6d96 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDropTargetEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/TreeDropTargetEffect.java @@ -41,6 +41,7 @@ import org.eclipse.swt.widgets.*; * * @see DropTargetAdapter * @see DropTargetEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/URLTransfer.java index 8f1bbc007c..0beb83de4c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/photon/org/eclipse/swt/dnd/URLTransfer.java @@ -21,8 +21,10 @@ package org.eclipse.swt.dnd; * below:</p> * * <code><pre> - * String urlData = "http://www.eclipse.org"; + * String url = "http://www.eclipse.org"; * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class URLTransfer extends ByteArrayTransfer { @@ -55,8 +57,8 @@ public void javaToNative (Object object, TransferData transferData){ * For additional information see <code>Transfer#nativeToJava</code>. * * @param transferData the platform specific representation of the data to be - * been converted - * @return a java <code>String[]</code> containing a URL if the + * converted + * @return a java <code>String</code> containing a URL if the * conversion was successful; otherwise null */ public Object nativeToJava(TransferData transferData){ |