KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > swt > dnd > TransferData


1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.swt.dnd;
12
13  
14 /**
15  * The <code>TransferData</code> class is a platform specific data structure for
16  * describing the type and the contents of data being converted by a transfer agent.
17  *
18  * <p>As an application writer, you do not need to know the specifics of
19  * TransferData. TransferData instances are passed to a subclass of Transfer
20  * and the Transfer object manages the platform specific issues.
21  * You can ask a Transfer subclass if it can handle this data by calling
22  * Transfer.isSupportedType(transferData).</p>
23  *
24  * <p>You should only need to become familiar with the fields in this class if you
25  * are implementing a Transfer subclass and you are unable to subclass the
26  * ByteArrayTransfer class.</p>
27  */
28 public class TransferData {
29     /**
30      * The type is a unique identifier of a system format or user defined format.
31      * (Warning: This field is platform dependent)
32      * <p>
33      * <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
34      * public API. It is marked public only so that it can be shared
35      * within the packages provided by SWT. It is not available on all
36      * platforms and should never be accessed from application code.
37      * </p>
38      */
39     public int type;
40     
41     // attributes specific to set/get
42 int length;
43     int format;
44     int pValue;
45
46     /**
47      * The result field contains the result of converting a
48      * java data type into a platform specific value.
49      * (Warning: This field is platform dependent)
50      * <p>
51      * <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
52      * public API. It is marked public only so that it can be shared
53      * within the packages provided by SWT. It is not available on all
54      * platforms and should never be accessed from application code.
55      * </p>
56      * <p>The value of result is 1 if the conversion was successful.
57      * The value of result is 0 if the conversion failed.</p>
58      */
59     int result;
60     
61 }
62
Popular Tags