blob: 3dba0b73db0d7e2093f7229f6e39b4e63e55610f [file] [log] [blame]
package org.eclipse.swt.dnd;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved
*/
/**
* The <code>RTFTransfer</code> class is used to transfer text with the RTF format
* in a drag and drop operation.
*/
public class RTFTransfer extends ByteArrayTransfer {
private static final String CF_RTF_NAME = "Rich Text Format";
private static final int CF_RTF = registerType(CF_RTF_NAME);
private static RTFTransfer _instance = new RTFTransfer();
private RTFTransfer() {}
/**
* Returns the singleton instance of the RTFTransfer class.
*
* @return the singleton instance of the RTFTransfer class
*/
public static RTFTransfer getInstance () {
return _instance;
}
/**
* Converts a RTF-formatted Java String to a platform specific representation.
* <p>
* On a successful conversion, the transferData.result field will be set as follows:
* <ul>
* <li>Windows: OLE.S_OK
* <li>Motif: 0
* </ul>
* If this transfer agent is unable to perform the conversion,
* the transferData.result field will be set to a failure value as follows:
* <ul>
* <li>Windows: OLE.DV_E_TYMED
* <li>Motif: 1
* </ul></p>
*
* @param object a Java String containing the data to be transferred
* @param transferData an empty TransferData object; this object will be filled in on return
* with the platform specific format of the data
*/
public void javaToNative (Object object, TransferData transferData){
if (object == null || !(object instanceof String)) return;
// CF_RTF is stored as a null terminated byte array
// create a byte array from object
String text = (String) object+'\0';
// pass byte array on to super to convert to native
super.javaToNative(text.getBytes(), transferData);
}
/**
* Converts a platform specific representation of a string to a Java String.
*
* @param transferData the platform specific representation of the data that has been transferred
* @return a Java String containing the transferred data if the conversion was successful;
* otherwise null
*/
public Object nativeToJava(TransferData transferData){
// get byte array from super
byte[] buffer = (byte[])super.nativeToJava(transferData);
if (buffer == null) return null;
// convert byte array to a string
String string = new String(buffer);
// remove null terminator
int index = string.indexOf("\0");
string = string.substring(0, index);
return string;
}
protected int[] getTypeIds(){
return new int[] {CF_RTF};
}
protected String[] getTypeNames(){
return new String[] {"CF_RTF"};
}
}