Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.swt.dnd
Class RTFTransfer

    java.lang.Object
      org.eclipse.swt.dnd.Transfer
          org.eclipse.swt.dnd.ByteArrayTransfer
              org.eclipse.swt.dnd.RTFTransfer

public class RTFTransfer
extends ByteArrayTransfer

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.

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

`

         String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}";

`

Method Summary
`static RTFTransfer` | `getInstance()` Returns the singleton instance of the RTFTransfer class.
`protected int[]` | `getTypeIds()` Returns the platform specfic ids of the data types that can be converted using this transfer agent.
`protected String[]` | `getTypeNames()` Returns the platform specfic names of the data types that can be converted using this transfer agent.
`void` | `javaToNative(Object object, TransferData transferData)` This implementation of `javaToNative` converts RTF-formatted text represented by a java `String` to a platform specific representation.
`Object` | `nativeToJava(TransferData transferData)` This implementation of `nativeToJava` converts a platform specific representation of RTF text to a java `String`.

Methods inherited from class org.eclipse.swt.dnd.ByteArrayTransfer
`getSupportedTypes, isSupportedType`

Methods inherited from class org.eclipse.swt.dnd.Transfer
`registerType`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getInstance

    public static RTFTransfer getInstance()

  Returns the singleton instance of the RTFTransfer class.

  Returns:
    the singleton instance of the RTFTransfer class

### javaToNative

    public void javaToNative(Object object,
                             TransferData transferData)

  This implementation of `javaToNative` converts RTF-formatted text represented by a java `String` to a platform specific representation. For additional information see `Transfer#javaToNative`.

  Overrides:
    `javaToNative` in class `ByteArrayTransfer`
  Parameters:
    `object` - a java `String` containing RTF text
    `transferData` - an empty `TransferData` object; this object will be filled in on return with the platform specific format of the data
  See Also:
    `Transfer.javaToNative(java.lang.Object, org.eclipse.swt.dnd.TransferData)`

### nativeToJava

    public Object nativeToJava(TransferData transferData)

  This implementation of `nativeToJava` converts a platform specific representation of RTF text to a java `String`. For additional information see `Transfer#nativeToJava`.

  Overrides:
    `nativeToJava` in class `ByteArrayTransfer`
  Parameters:
    `transferData` - the platform specific representation of the data to be been converted
  Returns:
    a java `String` containing RTF text if the conversion was successful; otherwise null
  See Also:
    `Transfer.nativeToJava(org.eclipse.swt.dnd.TransferData)`

### getTypeIds

    protected int[] getTypeIds()

  Description copied from class: `Transfer`
  Returns the platform specfic ids of the data types that can be converted using this transfer agent.

  Specified by:
    `getTypeIds` in class `Transfer`
  Returns:
    the platform specfic ids of the data types that can be converted using this transfer agent

### getTypeNames

    protected String[] getTypeNames()

  Description copied from class: `Transfer`
  Returns the platform specfic names of the data types that can be converted using this transfer agent.

  Specified by:
    `getTypeNames` in class `Transfer`
  Returns:
    the platform specfic names of the data types that can be converted using this transfer agent.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.