blob: ae137719fdc9e3e63fb5bd9c3fb7edf3ec37fa1e [file] [log] [blame]
package org.eclipse.swt.dnd;
/*
* Copyright (c) 2000, 2002 IBM Corp. All rights reserved.
* This file is made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*/
/**
* The class <code>RTFTransfer</code> provides a platform specific mechanism
* for converting text in RTF format represented as a java <code>String</code>
* to a platform specific representation of the data and vice versa. See
* <code>Transfer</code> for additional information.
*
* <p>An example of a java <code>String</code> containg RTF text is shown
* below:</p>
* <code><pre>
* String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}";
* </code></pre>
*/
public class RTFTransfer extends ByteArrayTransfer {
private static RTFTransfer _instance = new RTFTransfer();
private static final String TYPENAME1 = "text/rtf\0";
private static final int TYPEID1 = registerType(TYPENAME1);
private static final String TYPENAME2 = "TEXT/RTF\0";
private static final int TYPEID2 = registerType(TYPENAME2);
private static final String TYPENAME3 = "application/rtf\0";
private static final int TYPEID3 = registerType(TYPENAME3);
private RTFTransfer() {
}
/**
* Returns the singleton instance of the RTFTransfer class.
*
* @return the singleton instance of the RTFTransfer class
*/
public static RTFTransfer getInstance () {
return _instance;
}
/**
* This implementation of <code>javaToNative</code> converts RTF-formatted text
* represented by a java <code>String</code> to a platform specific representation.
* For additional information see <code>Transfer#javaToNative</code>.
*
* @param object a java <code>String</code> containing RTF text
* @param transferData an empty <code>TransferData</code> object; this
* object will be filled in on return with the platform specific format of the data
*/
public void javaToNative (Object object, TransferData transferData){
}
/**
* This implementation of <code>nativeToJava</code> converts a platform specific
* representation of RTF text to a java <code>String</code>.
* For additional information see <code>Transfer#nativeToJava</code>.
*
* @param transferData the platform specific representation of the data to be
* been converted
* @return a java <code>String</code> containing RTF text if the
* conversion was successful; otherwise null
*/
public Object nativeToJava(TransferData transferData){
return null;
}
protected String[] getTypeNames(){
return new String[]{TYPENAME1, TYPENAME2, TYPENAME3};
}
protected int[] getTypeIds(){
return new int[]{TYPEID1, TYPEID2, TYPEID3};
}
}