From cbaebd8f0308e9c01a70019c73135ef68cbb4fa3 Mon Sep 17 00:00:00 2001 From: Carolyn MacLeod Date: Wed, 4 Jun 2008 21:41:36 +0000 Subject: After Javadoc Bash for 3.4RC4 --- .../org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../carbon/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../carbon/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../carbon/org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../carbon/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../carbon/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../carbon/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../cocoa/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../cocoa/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../cocoa/org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../cocoa/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../cocoa/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../cocoa/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../emulated/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../emulated/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../emulated/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../emulated/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../emulated/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../gtk/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../gtk/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../gtk/org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../gtk/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../gtk/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../gtk/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../motif/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../motif/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../motif/org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../motif/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../motif/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../motif/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../photon/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../photon/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../photon/org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../photon/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../photon/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../photon/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../wpf/org/eclipse/swt/dnd/ByteArrayTransfer.java | 26 ++++++++----------- .../wpf/org/eclipse/swt/dnd/FileTransfer.java | 25 +++++++++--------- .../wpf/org/eclipse/swt/dnd/HTMLTransfer.java | 22 ++++++++-------- .../wpf/org/eclipse/swt/dnd/ImageTransfer.java | 30 ++++++++++------------ .../wpf/org/eclipse/swt/dnd/RTFTransfer.java | 22 ++++++++-------- .../wpf/org/eclipse/swt/dnd/TextTransfer.java | 9 +++---- .../wpf/org/eclipse/swt/dnd/URLTransfer.java | 29 ++++++++++----------- .../org/eclipse/swt/widgets/ProgressBar.java | 16 +++++++++--- .../cocoa/org/eclipse/swt/widgets/ProgressBar.java | 16 +++++++++--- .../gtk/org/eclipse/swt/widgets/ProgressBar.java | 16 +++++++++--- .../motif/org/eclipse/swt/widgets/ProgressBar.java | 16 +++++++++--- .../org/eclipse/swt/widgets/ProgressBar.java | 16 +++++++++--- .../wpf/org/eclipse/swt/widgets/ProgressBar.java | 16 +++++++++--- 55 files changed, 611 insertions(+), 626 deletions(-) diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ByteArrayTransfer.java index bb4585bc4c..d47fc52a73 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -14,8 +14,7 @@ package org.eclipse.swt.dnd; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -115,7 +114,7 @@ package org.eclipse.swt.dnd; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -140,14 +139,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { if (!checkByteArray(object) && !isSupportedType(transferData)) { @@ -164,14 +162,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/FileTransfer.java index ba7123a7b8..79aa5c6146 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/FileTransfer.java @@ -20,7 +20,6 @@ import org.eclipse.swt.internal.carbon.*; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -33,7 +32,7 @@ import org.eclipse.swt.internal.carbon.*; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -58,13 +57,13 @@ public static FileTransfer getInstance () { * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkFile(object) || !isSupportedType(transferData)) { @@ -126,12 +125,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/HTMLTransfer.java index 142ea24c08..638a39e287 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/HTMLTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.carbon.OS; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -25,7 +24,7 @@ import org.eclipse.swt.internal.carbon.OS; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -47,11 +46,12 @@ public static HTMLTransfer getInstance () { /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkHTML(object) || !isSupportedType(transferData)) { @@ -71,12 +71,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ImageTransfer.java index 51155adce7..467bfc1b9c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/ImageTransfer.java @@ -18,19 +18,17 @@ import org.eclipse.swt.widgets.*; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -57,12 +55,12 @@ public static ImageTransfer getInstance() { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkImage(object) || !isSupportedType(transferData)) { @@ -117,12 +115,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.data == null) diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/RTFTransfer.java index a60bf238db..7558bc66ef 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/RTFTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.carbon.CFRange; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -26,7 +25,7 @@ import org.eclipse.swt.internal.carbon.CFRange; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -48,11 +47,12 @@ public static RTFTransfer getInstance () { /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkRTF(object) || !isSupportedType(transferData)) { @@ -86,12 +86,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/TextTransfer.java index 4ff2324d09..1b323e44e9 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/TextTransfer.java @@ -26,7 +26,6 @@ import org.eclipse.swt.internal.carbon.OS; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -54,10 +53,10 @@ public static TextTransfer getInstance () { * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData) { if (!checkText(object) || !isSupportedType(transferData)) { @@ -109,7 +108,7 @@ public void javaToNative (Object object, TransferData transferData) { * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/URLTransfer.java index a1e97aac13..af8fcc62d3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/carbon/org/eclipse/swt/dnd/URLTransfer.java @@ -1,18 +1,16 @@ /******************************************************************************* * Copyright (c) 20007 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 *******************************************************************************/ package org.eclipse.swt.dnd; import org.eclipse.swt.internal.carbon.*; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { static URLTransfer _instance = new URLTransfer(); static final String URL = "url "; //$NON-NLS-1$ static final int URL_ID = registerType(URL); static final String URLN = "urln"; //$NON-NLS-1$ static final int URLN_ID = registerType(URLN); private URLTransfer() {} /** * Returns the singleton instance of the URLTransfer class. * @@ -20,18 +18,19 @@ */ public static URLTransfer getInstance () { return _instance; } /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkURL(object) || !isSupportedType(transferData)) { DND.error(DND.ERROR_INVALID_DATA); } transferData.result = -1; String url = (String)object; int count = url.length(); char[] chars = new char[count]; url.getChars(0, count, chars, 0); int cfstring = OS.CFStringCreateWithCharacters(OS.kCFAllocatorDefault, chars, count); if (cfstring == 0) return; try { CFRange range = new CFRange(); range.length = chars.length; int encoding = OS.kCFStringEncodingUTF8; int[] size = new int[1]; int numChars = OS.CFStringGetBytes(cfstring, range, encoding, (byte)'?', true, null, 0, size); if (numChars == 0 || size[0] == 0) return; byte[] buffer = new byte[size[0]]; numChars = OS.CFStringGetBytes(cfstring, range, encoding, (byte)'?', true, buffer, size [0], size); if (numChars == 0) return; transferData.data = new byte[][] {buffer}; transferData.result = 0; } finally { OS.CFRelease(cfstring); } } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; if (transferData.data.length == 0) return null; byte[] buffer = transferData.data[0]; int encoding = OS.kCFStringEncodingUTF8; int cfstring = OS.CFStringCreateWithBytes(OS.kCFAllocatorDefault, buffer, buffer.length, encoding, true); if (cfstring == 0) return null; char[] unescapedChars = new char[] {'%'}; int unescapedStr = OS.CFStringCreateWithCharacters(0, unescapedChars, unescapedChars.length); int str = OS.CFURLCreateStringByReplacingPercentEscapes(OS.kCFAllocatorDefault, cfstring, unescapedStr); OS.CFRelease(unescapedStr); OS.CFRelease(cfstring); if (str == 0) return null; try { int length = OS.CFStringGetLength(str); if (length == 0) return null; char[] chars = new char[length]; CFRange range = new CFRange(); range.length = length; OS.CFStringGetCharacters(str, range, chars); return new String(chars); } finally { OS.CFRelease(str); } } protected int[] getTypeIds(){ return new int[] {URL_ID, URLN_ID}; } protected String[] getTypeNames(){ return new String[] {URL, URLN}; } boolean checkURL(Object object) { return object != null && (object instanceof String) && ((String)object).length() > 0; } protected boolean validate(Object object) { return checkURL(object); } } \ No newline at end of file diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ByteArrayTransfer.java index bb4585bc4c..d47fc52a73 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -14,8 +14,7 @@ package org.eclipse.swt.dnd; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -115,7 +114,7 @@ package org.eclipse.swt.dnd; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -140,14 +139,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { if (!checkByteArray(object) && !isSupportedType(transferData)) { @@ -164,14 +162,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/FileTransfer.java index ba7123a7b8..79aa5c6146 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/FileTransfer.java @@ -20,7 +20,6 @@ import org.eclipse.swt.internal.carbon.*; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -33,7 +32,7 @@ import org.eclipse.swt.internal.carbon.*; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -58,13 +57,13 @@ public static FileTransfer getInstance () { * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkFile(object) || !isSupportedType(transferData)) { @@ -126,12 +125,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/HTMLTransfer.java index 142ea24c08..638a39e287 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/HTMLTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.carbon.OS; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -25,7 +24,7 @@ import org.eclipse.swt.internal.carbon.OS; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -47,11 +46,12 @@ public static HTMLTransfer getInstance () { /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkHTML(object) || !isSupportedType(transferData)) { @@ -71,12 +71,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ImageTransfer.java index 51155adce7..467bfc1b9c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/ImageTransfer.java @@ -18,19 +18,17 @@ import org.eclipse.swt.widgets.*; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -57,12 +55,12 @@ public static ImageTransfer getInstance() { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkImage(object) || !isSupportedType(transferData)) { @@ -117,12 +115,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.data == null) diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/RTFTransfer.java index a60bf238db..7558bc66ef 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/RTFTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.carbon.CFRange; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -26,7 +25,7 @@ import org.eclipse.swt.internal.carbon.CFRange; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -48,11 +47,12 @@ public static RTFTransfer getInstance () { /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkRTF(object) || !isSupportedType(transferData)) { @@ -86,12 +86,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/TextTransfer.java index 6b0f1de269..dad30d6420 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/TextTransfer.java @@ -26,7 +26,6 @@ import org.eclipse.swt.internal.carbon.OS; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -52,10 +51,10 @@ public static TextTransfer getInstance () { * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData) { if (!checkText(object) || !isSupportedType(transferData)) { @@ -106,7 +105,7 @@ public void javaToNative (Object object, TransferData transferData) { * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/URLTransfer.java index 7330434d6d..01c4161f27 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/cocoa/org/eclipse/swt/dnd/URLTransfer.java @@ -1,18 +1,16 @@ /******************************************************************************* * Copyright (c) 20007 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 *******************************************************************************/ package org.eclipse.swt.dnd; import org.eclipse.swt.internal.carbon.*; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { static URLTransfer _instance = new URLTransfer(); static final String URL = "url "; //$NON-NLS-1$ static final int URL_ID = registerType(URL); static final String URLN = "urln"; //$NON-NLS-1$ static final int URLN_ID = registerType(URLN); private URLTransfer() {} /** * Returns the singleton instance of the URLTransfer class. * @@ -20,18 +18,19 @@ */ public static URLTransfer getInstance () { return _instance; } /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkURL(object) || !isSupportedType(transferData)) { DND.error(DND.ERROR_INVALID_DATA); } transferData.result = -1; String url = (String)object; int count = url.length(); char[] chars = new char[count]; url.getChars(0, count, chars, 0); int cfstring = OS.CFStringCreateWithCharacters(OS.kCFAllocatorDefault, chars, count); if (cfstring == 0) return; try { CFRange range = new CFRange(); range.length = chars.length; int encoding = OS.CFStringGetSystemEncoding(); int[] size = new int[1]; int numChars = OS.CFStringGetBytes(cfstring, range, encoding, (byte)'?', true, null, 0, size); if (numChars == 0 || size[0] == 0) return; byte[] buffer = new byte[size[0]]; numChars = OS.CFStringGetBytes(cfstring, range, encoding, (byte)'?', true, buffer, size [0], size); if (numChars == 0) return; transferData.data = new byte[][] {buffer}; transferData.result = 0; } finally { OS.CFRelease(cfstring); } } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.data == null) return null; if (transferData.data.length == 0) return null; byte[] buffer = transferData.data[0]; int encoding = OS.CFStringGetSystemEncoding(); int cfstring = OS.CFStringCreateWithBytes(OS.kCFAllocatorDefault, buffer, buffer.length, encoding, true); if (cfstring == 0) return null; try { int length = OS.CFStringGetLength(cfstring); if (length == 0) return null; char[] chars = new char[length]; CFRange range = new CFRange(); range.length = length; OS.CFStringGetCharacters(cfstring, range, chars); return new String(chars); } finally { OS.CFRelease(cfstring); } } protected int[] getTypeIds(){ return new int[] {URL_ID, URLN_ID}; } protected String[] getTypeNames(){ return new String[] {URL, URLN}; } boolean checkURL(Object object) { return object != null && (object instanceof String) && ((String)object).length() > 0; } protected boolean validate(Object object) { return checkURL(object); } } \ No newline at end of file diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ByteArrayTransfer.java index fac09a7296..fce2e5783d 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -14,8 +14,7 @@ package org.eclipse.swt.dnd; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -115,7 +114,7 @@ package org.eclipse.swt.dnd; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -129,14 +128,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { } @@ -144,14 +142,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/FileTransfer.java index 16b6400da4..e2a5395398 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/FileTransfer.java @@ -17,7 +17,6 @@ package org.eclipse.swt.dnd; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -30,7 +29,7 @@ package org.eclipse.swt.dnd; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -47,13 +46,13 @@ public static FileTransfer getInstance () { * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { } @@ -61,12 +60,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/HTMLTransfer.java index dc6472ccf2..6b77424171 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/HTMLTransfer.java @@ -13,8 +13,7 @@ package org.eclipse.swt.dnd; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -23,7 +22,7 @@ package org.eclipse.swt.dnd; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -46,23 +45,24 @@ public static HTMLTransfer getInstance () { /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ } /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ImageTransfer.java index 0aba6cd562..2ba21c041b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/ImageTransfer.java @@ -12,19 +12,17 @@ package org.eclipse.swt.dnd; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -44,12 +42,12 @@ public static ImageTransfer getInstance () { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { } @@ -57,12 +55,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/RTFTransfer.java index e1dd9f0b89..b3a4179ac0 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/RTFTransfer.java @@ -14,8 +14,7 @@ package org.eclipse.swt.dnd; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -24,7 +23,7 @@ package org.eclipse.swt.dnd; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -49,23 +48,24 @@ public static RTFTransfer getInstance () { /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ } /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TextTransfer.java index 99f74110e3..eb3f21d681 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TextTransfer.java @@ -24,7 +24,6 @@ package org.eclipse.swt.dnd; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -51,10 +50,10 @@ public static TextTransfer getInstance () { * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ } @@ -65,7 +64,7 @@ public void javaToNative (Object object, TransferData transferData){ * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/URLTransfer.java index 0beb83de4c..d0cfe6e279 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/URLTransfer.java @@ -13,18 +13,16 @@ package org.eclipse.swt.dnd; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { @@ -42,24 +40,25 @@ public static URLTransfer getInstance () { /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java index f077436964..8ec57d7d51 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.gtk.*; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -116,7 +115,7 @@ import org.eclipse.swt.internal.gtk.*; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -141,14 +140,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { transferData.result = 0; @@ -169,14 +167,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { if ( !isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java index 7106f12d0a..a592b56699 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java @@ -18,7 +18,6 @@ import org.eclipse.swt.internal.gtk.*; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -31,7 +30,7 @@ import org.eclipse.swt.internal.gtk.*; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -55,13 +54,13 @@ public static FileTransfer getInstance () { * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { transferData.result = 0; @@ -115,12 +114,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if ( !isSupportedType(transferData) || transferData.pValue == 0 || transferData.length <= 0 ) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java index 65a149334e..67f62dec66 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.gtk.*; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -25,7 +24,7 @@ import org.eclipse.swt.internal.gtk.*; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -49,11 +48,12 @@ public static HTMLTransfer getInstance () { /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ transferData.result = 0; @@ -77,12 +77,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if ( !isSupportedType(transferData) || transferData.pValue == 0 ) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java index 360244a3e0..d030689b23 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java @@ -18,19 +18,17 @@ import org.eclipse.swt.widgets.*; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -75,12 +73,12 @@ public static ImageTransfer getInstance () { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkImage(object) || !isSupportedType(transferData)) { @@ -127,12 +125,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { ImageData imgData = null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java index f3de70bcbd..1941ebbf80 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.gtk.*; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -26,7 +25,7 @@ import org.eclipse.swt.internal.gtk.*; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -52,11 +51,12 @@ public static RTFTransfer getInstance () { /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ transferData.result = 0; @@ -77,12 +77,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if ( !isSupportedType(transferData) || transferData.pValue == 0 ) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java index 988351b5ed..80a6015460 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java @@ -26,7 +26,6 @@ import org.eclipse.swt.internal.gtk.*; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -54,10 +53,10 @@ public static TextTransfer getInstance () { * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData) { transferData.result = 0; @@ -107,7 +106,7 @@ public void javaToNative (Object object, TransferData transferData) { * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java index 6dedda0e7d..7797370620 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java @@ -15,18 +15,16 @@ import org.eclipse.swt.internal.gtk.*; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { @@ -50,11 +48,12 @@ public static URLTransfer getInstance () { /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ transferData.result = 0; @@ -76,14 +75,14 @@ public void javaToNative (Object object, TransferData transferData){ } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ByteArrayTransfer.java index 1b1b9a8747..670f73862a 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.motif.*; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -116,7 +115,7 @@ import org.eclipse.swt.internal.motif.*; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -141,14 +140,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { transferData.result = 0; @@ -168,14 +166,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java index 6a9771654e..233b9ac609 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java @@ -19,7 +19,6 @@ import org.eclipse.swt.internal.motif.*; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -32,7 +31,7 @@ import org.eclipse.swt.internal.motif.*; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -57,13 +56,13 @@ public static FileTransfer getInstance () { * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { transferData.result = 0; @@ -90,12 +89,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/HTMLTransfer.java index 35ccb70d75..f8054f1700 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/HTMLTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.motif.*; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -25,7 +24,7 @@ import org.eclipse.swt.internal.motif.*; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -49,11 +48,12 @@ public static HTMLTransfer getInstance () { /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ transferData.result = 0; @@ -77,12 +77,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if ( !isSupportedType(transferData) || transferData.pValue == 0 ) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ImageTransfer.java index f180f5fa8a..6a6fe5612f 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/ImageTransfer.java @@ -17,19 +17,17 @@ import org.eclipse.swt.widgets.Display; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -54,12 +52,12 @@ public static ImageTransfer getInstance () { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkImage(object) || !isSupportedType(transferData)) { @@ -81,12 +79,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/RTFTransfer.java index 5c634a6e86..00b822b9f1 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/RTFTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.motif.*; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -26,7 +25,7 @@ import org.eclipse.swt.internal.motif.*; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -52,11 +51,12 @@ public static RTFTransfer getInstance () { /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ transferData.result = 0; @@ -77,12 +77,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if ( !isSupportedType(transferData) || transferData.pValue == 0 ) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/TextTransfer.java index 197d6bf2c5..dfd8b7e478 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/TextTransfer.java @@ -28,7 +28,6 @@ import org.eclipse.swt.internal.motif.XTextProperty; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -54,10 +53,10 @@ public static TextTransfer getInstance () { * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData) { transferData.result = 0; @@ -109,7 +108,7 @@ public void javaToNative (Object object, TransferData transferData) { * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/URLTransfer.java index 40ed0699a5..95379c6880 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/URLTransfer.java @@ -15,18 +15,16 @@ import org.eclipse.swt.internal.motif.*; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { @@ -51,11 +49,12 @@ public static URLTransfer getInstance () { /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ transferData.result = 0; @@ -77,14 +76,14 @@ public void javaToNative (Object object, TransferData transferData){ } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if ( !isSupportedType(transferData) || transferData.pValue == 0 ) return null; 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 3a947db409..a6e20dc5b6 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 @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.photon.*; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -117,7 +116,7 @@ import org.eclipse.swt.internal.photon.*; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -141,14 +140,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData){ if (!checkByteArray(object) || !isSupportedType(transferData)) { @@ -164,14 +162,12 @@ protected void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData){ 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 d2ab481986..0b1fa27e9b 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 @@ -18,7 +18,6 @@ import org.eclipse.swt.internal.Converter; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -31,7 +30,7 @@ import org.eclipse.swt.internal.Converter; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -52,13 +51,13 @@ public static FileTransfer getInstance () { * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkFile(object) || !isSupportedType(transferData)) { @@ -80,12 +79,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { 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 64ce6bf82b..9426e60498 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 @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.photon.OS; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -26,7 +25,7 @@ import org.eclipse.swt.internal.photon.OS; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -47,11 +46,12 @@ public static HTMLTransfer getInstance () { /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkHTML(object) || !isSupportedType(transferData)) { @@ -64,12 +64,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ 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 0aba6cd562..2ba21c041b 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 @@ -12,19 +12,17 @@ package org.eclipse.swt.dnd; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -44,12 +42,12 @@ public static ImageTransfer getInstance () { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { } @@ -57,12 +55,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { return null; 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 bcccfe957f..691fd43690 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 @@ -17,8 +17,7 @@ import org.eclipse.swt.internal.photon.OS; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -27,7 +26,7 @@ import org.eclipse.swt.internal.photon.OS; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -48,11 +47,12 @@ public static RTFTransfer getInstance () { /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkRTF(object) || !isSupportedType(transferData)) { @@ -65,12 +65,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ 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 69a89c36fa..da5f66d4f3 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,7 +27,6 @@ import org.eclipse.swt.internal.photon.OS; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -50,10 +49,10 @@ public static TextTransfer getInstance () { * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkText(object) || !isSupportedType(transferData)) { @@ -70,7 +69,7 @@ public void javaToNative (Object object, TransferData transferData){ * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ 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 0beb83de4c..d0cfe6e279 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 @@ -13,18 +13,16 @@ package org.eclipse.swt.dnd; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { @@ -42,24 +40,25 @@ public static URLTransfer getInstance () { /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ByteArrayTransfer.java index 1e5bbfb085..3643bb1f89 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.wpf.*; /** * The class ByteArrayTransfer provides a platform specific * mechanism for converting a java byte[] to a platform - * specific representation of the byte array and vice versa. See - * Transfer for additional information. + * specific representation of the byte array and vice versa. * *

ByteArrayTransfer is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -117,7 +116,7 @@ import org.eclipse.swt.internal.wpf.*; * } * * - * @see Sample code and further information + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -155,14 +154,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of javaToNative converts a java - * byte[] to a platform specific representation. For additional - * information see Transfer#javaToNative. - * - * @see Transfer#javaToNative + * byte[] to a platform specific representation. * * @param object a java byte[] containing the data to be converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { if (!checkByteArray(object) || !isSupportedType(transferData)) { @@ -181,14 +179,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of a byte array to a java byte[]. - * For additional information see Transfer#nativeToJava. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java byte[] containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java byte[] containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { if ( !isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/FileTransfer.java index ebf9a927f3..83ca6dab2f 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/FileTransfer.java @@ -18,7 +18,6 @@ import org.eclipse.swt.internal.wpf.*; * platform specific representation of the data and vice versa. * Each String in the array contains the absolute path for a single * file or directory. - * See Transfer for additional information. * *

An example of a java String[] containing a list of files is shown * below:

@@ -31,7 +30,7 @@ import org.eclipse.swt.internal.wpf.*; * fileData[1] = file2.getAbsolutePath(); * * - * @see Sample code and further information + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -73,13 +72,13 @@ protected int[] getTypeIds(){ * This implementation of javaToNative converts a list of file names * represented by a java String[] to a platform specific representation. * Each String in the array contains the absolute path for a single - * file or directory. For additional information see - * Transfer#javaToNative. + * file or directory. + * + * @param object a java String[] containing the file names to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @param object a java String[] containing the file names to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkFile(object) || !isSupportedType(transferData)) { @@ -102,12 +101,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of nativeToJava converts a platform specific * representation of a list of file names to a java String[]. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String[] containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String[] containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/HTMLTransfer.java index 3949fefb0b..462ab89bd3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/HTMLTransfer.java @@ -15,8 +15,7 @@ import org.eclipse.swt.internal.wpf.*; /** * The class HTMLTransfer provides a platform specific mechanism * for converting text in HTML format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing HTML text is shown * below:

@@ -25,7 +24,7 @@ import org.eclipse.swt.internal.wpf.*; * String htmlData = "

This is a paragraph of text.

"; * * - * @see Sample code and further information + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -62,11 +61,12 @@ protected int[] getTypeIds(){ /** * This implementation of javaToNative converts HTML-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing HTML text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkHTML(object) || !isSupportedType(transferData)) { @@ -78,12 +78,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of nativeToJava converts a platform specific * representation of HTML text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ImageTransfer.java index 173d9d4f30..cbd3a8cff3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/ImageTransfer.java @@ -16,19 +16,17 @@ import org.eclipse.swt.internal.wpf.OS; /** * The class ImageTransfer provides a platform specific mechanism - * for converting a Image represented as a java ImageData to a + * for converting an Image represented as a java ImageData to a * platform specific representation of the data and vice versa. - * See Transfer for additional information. * - *

An example of a java ImageData is shown - * below:

+ *

An example of a java ImageData is shown below:

* * 
- *     Image image = new Image("C:\temp\img1.gif");
+ *     Image image = new Image(display, "C:\temp\img1.gif");
  *	   ImageData imgData = image.getImageData();
  *
* - * @see Sample code and further information + * @see Transfer * * @since 3.4 */ @@ -58,12 +56,12 @@ public static ImageTransfer getInstance () { /** * This implementation of javaToNative converts an ImageData object represented * by java ImageData to a platform specific representation. - * For additional information see Transfer#javaToNative. * - * @param object a java ImageData containing the ImageData to be - * converted - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java ImageData containing the ImageData to be converted + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkImage(object) || !isSupportedType(transferData)) { @@ -79,12 +77,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of an image to java ImageData. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java ImageData of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java ImageData of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/RTFTransfer.java index 0d07c6b906..36dbbe8921 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/RTFTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.wpf.*; /** * The class RTFTransfer provides a platform specific mechanism * for converting text in RTF format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. + * to a platform specific representation of the data and vice versa. * *

An example of a java String containing RTF text is shown * below:

@@ -26,7 +25,7 @@ import org.eclipse.swt.internal.wpf.*; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * * - * @see Sample code and further information + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -63,11 +62,12 @@ protected int[] getTypeIds(){ /** * This implementation of javaToNative converts RTF-formatted text * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing RTF text - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData) { if (!checkRTF(object) || !isSupportedType(transferData)) { @@ -79,12 +79,12 @@ public void javaToNative (Object object, TransferData transferData) { /** * This implementation of nativeToJava converts a platform specific * representation of RTF text to a java String. - * For additional information see Transfer#nativeToJava. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java String containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/TextTransfer.java index 591a840ec9..cb69118ce6 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/TextTransfer.java @@ -26,7 +26,6 @@ import org.eclipse.swt.internal.wpf.*; * * * @see Transfer - * @see Sample code and further information */ public class TextTransfer extends ByteArrayTransfer { @@ -65,10 +64,10 @@ protected int[] getTypeIds(){ * represented by a java String to a platform specific representation. * * @param object a java String containing text - * @param transferData an empty TransferData object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData) { if (!checkText(object) || !isSupportedType(transferData)) { @@ -84,7 +83,7 @@ public void javaToNative (Object object, TransferData transferData) { * @param transferData the platform specific representation of the data to be converted * @return a java String containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/URLTransfer.java index 5075979876..df701b8276 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/wpf/org/eclipse/swt/dnd/URLTransfer.java @@ -15,18 +15,16 @@ import org.eclipse.swt.internal.wpf.OS; /** * The class URLTransfer provides a platform specific mechanism * for converting text in URL format represented as a java String - * to a platform specific representation of the data and vice versa. See - * Transfer for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - *

An example of a java String containing a URL is shown - * below:

+ *

An example of a java String containing a URL is shown below:

* * 
  *     String url = "http://www.eclipse.org";
  *
* - * @see Sample code and further information + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { @@ -48,11 +46,12 @@ public static URLTransfer getInstance () { /** * This implementation of javaToNative converts a URL * represented by a java String to a platform specific representation. - * For additional information see Transfer#javaToNative. * * @param object a java String containing a URL - * @param transferData an empty TransferData object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty TransferData object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkURL(object) || !isSupportedType(transferData)) { @@ -73,14 +72,14 @@ public void javaToNative (Object object, TransferData transferData){ } /** - * This implementation of nativeToJava converts a platform specific - * representation of a URL to a java String. - * For additional information see Transfer#nativeToJava. + * This implementation of nativeToJava converts a platform + * specific representation of a URL to a java String. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java String containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java String containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pValue == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java index 3562de653a..462d4bee82 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java @@ -153,8 +153,12 @@ public int getSelection () { } /** - * Returns the state of the receiver. The value will be one of - * NORMAL, ERROR or PAUSED. + * Returns the state of the receiver. The value will be one of: + * * * @return the state * @@ -240,8 +244,12 @@ public void setSelection (int value) { } /** - * Sets the state of the receiver. The state is be one of - * NORMAL, ERROR or PAUSED. + * Sets the state of the receiver. The state must be one of these values: + * * * @param state the new state * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java index ad6aab97db..df11c79494 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java @@ -156,8 +156,12 @@ public int getSelection () { } /** - * Returns the state of the receiver. The value will be one of - * NORMAL, ERROR or PAUSED. + * Returns the state of the receiver. The value will be one of: + * * * @return the state * @@ -229,8 +233,12 @@ public void setSelection (int value) { } /** - * Sets the state of the receiver. The state is be one of - * NORMAL, ERROR or PAUSED. + * Sets the state of the receiver. The state must be one of these values: + * * * @param state the new state * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java index 3ea95df354..4cf744707b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java @@ -139,8 +139,12 @@ public int getSelection () { } /** - * Returns the state of the receiver. The value will be one of - * NORMAL, ERROR or PAUSED. + * Returns the state of the receiver. The value will be one of: + * * * @return the state * @@ -245,8 +249,12 @@ public void setSelection (int value) { } /** - * Sets the state of the receiver. The state is be one of - * NORMAL, ERROR or PAUSED. + * Sets the state of the receiver. The state must be one of these values: + * * * @param state the new state * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/ProgressBar.java index ce33f375ba..9dc714ea30 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/ProgressBar.java @@ -196,8 +196,12 @@ public int getSelection () { return minimum + (foreground != -1 ? 0 : sliderSize); } /** - * Returns the state of the receiver. The value will be one of - * NORMAL, ERROR or PAUSED. + * Returns the state of the receiver. The value will be one of: + * * * @return the state * @@ -318,8 +322,12 @@ public void setSelection (int value) { update (); } /** - * Sets the state of the receiver. The state is be one of - * NORMAL, ERROR or PAUSED. + * Sets the state of the receiver. The state must be one of these values: + * * * @param state the new state * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ProgressBar.java index 9475bb6bbe..ded5b8f57c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ProgressBar.java @@ -177,8 +177,12 @@ public int getSelection () { } /** - * Returns the state of the receiver. The value will be one of - * NORMAL, ERROR or PAUSED. + * Returns the state of the receiver. The value will be one of: + * * * @return the state * @@ -254,8 +258,12 @@ public void setSelection (int value) { } /** - * Sets the state of the receiver. The state is be one of - * NORMAL, ERROR or PAUSED. + * Sets the state of the receiver. The state must be one of these values: + * * * @param state the new state * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/wpf/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/wpf/org/eclipse/swt/widgets/ProgressBar.java index b5908e9fb0..52fa2fe3ea 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/wpf/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/wpf/org/eclipse/swt/widgets/ProgressBar.java @@ -148,8 +148,12 @@ public int getSelection () { } /** - * Returns the state of the receiver. The value will be one of - * NORMAL, ERROR or PAUSED. + * Returns the state of the receiver. The value will be one of: + * * * @return the state * @@ -232,8 +236,12 @@ public void setSelection (int value) { } /** - * Sets the state of the receiver. The state is be one of - * NORMAL, ERROR or PAUSED. + * Sets the state of the receiver. The state must be one of these values: + * * * @param state the new state * -- cgit