org.eclipse.swt.dnd

Class HTMLTransfer

java.lang.Object

org.eclipse.swt.dnd.Transfer

org.eclipse.swt.dnd.ByteArrayTransfer

org.eclipse.swt.dnd.HTMLTransfer

public class HTMLTransfer
extends ByteArrayTransfer

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.

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

     String htmlData = "
This is a paragraph of text.
";
 

See Also:

Transfer

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static HTMLTransfer	_instance
(package private) static java.lang.String	EndFragment
(package private) static java.lang.String	HEADER
(package private) static java.lang.String	HTML_FORMAT
(package private) static int	HTML_FORMATID
(package private) static java.lang.String	NUMBER
(package private) static java.lang.String	PREFIX
(package private) static java.lang.String	StartFragment
(package private) static java.lang.String	SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HTMLTransfer()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) boolean	checkHTML(java.lang.Object object)
static HTMLTransfer	getInstance() Returns the singleton instance of the HTMLTransfer class.
protected int[]	getTypeIds() Returns the platform specific ids of the data types that can be converted using this transfer agent.
protected java.lang.String[]	getTypeNames() Returns the platform specific names of the data types that can be converted using this transfer agent.
void	javaToNative(java.lang.Object object, TransferData transferData) This implementation of javaToNative converts HTML-formatted text represented by a java String to a platform specific representation.
java.lang.Object	nativeToJava(TransferData transferData) This implementation of nativeToJava converts a platform specific representation of HTML text to a java String.
protected boolean	validate(java.lang.Object object) Test that the object is of the correct format for this Transfer class.

Methods inherited from class org.eclipse.swt.dnd.ByteArrayTransfer

checkByteArray, getSupportedTypes, isSupportedType

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

getData, registerType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_instance

static HTMLTransfer _instance

HTML_FORMAT

static final java.lang.String HTML_FORMAT

See Also:

Constant Field Values

HTML_FORMATID

static final int HTML_FORMATID

NUMBER

static final java.lang.String NUMBER

See Also:

Constant Field Values

HEADER

static final java.lang.String HEADER

See Also:

Constant Field Values

PREFIX

static final java.lang.String PREFIX

See Also:

Constant Field Values

SUFFIX

static final java.lang.String SUFFIX

See Also:

Constant Field Values

StartFragment

static final java.lang.String StartFragment

See Also:

Constant Field Values

EndFragment

static final java.lang.String EndFragment

See Also:

Constant Field Values

Constructor Detail

HTMLTransfer

private HTMLTransfer()

Method Detail

getInstance

public static HTMLTransfer getInstance()

Returns the singleton instance of the HTMLTransfer class.

Returns:

the singleton instance of the HTMLTransfer class

javaToNative

public void javaToNative(java.lang.Object object,
                TransferData transferData)

This implementation of javaToNative converts HTML-formatted text represented by a java String to a platform specific representation.

Overrides:

javaToNative in class ByteArrayTransfer

Parameters:

object - a java String containing HTML text

transferData - an empty TransferData object that will be filled in on return with the platform specific format of the data

See Also:

Transfer.nativeToJava(org.eclipse.swt.dnd.TransferData)

nativeToJava

public java.lang.Object nativeToJava(TransferData transferData)

This implementation of nativeToJava converts a platform specific representation of HTML text to a java String.

Overrides:

nativeToJava in class ByteArrayTransfer

Parameters:

transferData - the platform specific representation of the data to be converted

Returns:

a java String containing HTML text if the conversion was successful; otherwise null

See Also:

Transfer.javaToNative(java.lang.Object, org.eclipse.swt.dnd.TransferData)

getTypeIds

protected int[] getTypeIds()

Description copied from class: Transfer

Returns the platform specific ids of the data types that can be converted using this transfer agent.

Specified by:

getTypeIds in class Transfer

Returns:

the platform specific ids of the data types that can be converted using this transfer agent

getTypeNames

protected java.lang.String[] getTypeNames()

Description copied from class: Transfer

Returns the platform specific names of the data types that can be converted using this transfer agent.

Specified by:

getTypeNames in class Transfer

Returns:

the platform specific names of the data types that can be converted using this transfer agent.

checkHTML

boolean checkHTML(java.lang.Object object)

validate

protected boolean validate(java.lang.Object object)

Description copied from class: Transfer

Test that the object is of the correct format for this Transfer class.

Overrides:

validate in class Transfer

Parameters:

object - a java representation of the data to be converted

Returns:

true if object is of the correct form for this transfer type