01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.openide.util.datatransfer;
42:
43: import java.awt.datatransfer.*;
44:
45: import java.io.IOException;
46:
47: /** Interface for transferring multiple objects at once.
48: *
49: * @author Jaroslav Tulach
50: * @version 0.12 Dec 16, 1997
51: */
52: public interface MultiTransferObject {
53: /** Get the number of transferred elements.
54: * @return the count
55: */
56: public int getCount();
57:
58: /** Get the transferable at some index.
59: * @param index the index
60: * @return the transferable
61: */
62: public Transferable getTransferableAt(int index);
63:
64: /** Test whether a given data flavor is supported by the item at <code>index</code>.
65: *
66: * @param index the index
67: * @param flavor the flavor to test
68: * @return <CODE>true</CODE> if the flavor is supported
69: */
70: public boolean isDataFlavorSupported(int index, DataFlavor flavor);
71:
72: /** Test whether each transferred item supports at least one of these
73: * flavors. Different items may support different flavors, however.
74: * @param array array of flavors
75: * @return <code>true</code> if all items support one or more flavors
76: */
77: public boolean areDataFlavorsSupported(DataFlavor[] array);
78:
79: /** Get list of all supported flavors for the item at an index.
80: * @param i the index
81: * @return array of supported flavors
82: */
83: public DataFlavor[] getTransferDataFlavors(int i);
84:
85: /** Get transfer data for the item at some index.
86: * @param indx the index
87: * @param flavor the flavor desired
88: * @return transfer data for item at that index
89: * @throws IOException if there is an I/O problem
90: * @throws UnsupportedFlavorException if that flavor is not supported
91: */
92: public Object getTransferData(int indx, DataFlavor flavor)
93: throws UnsupportedFlavorException, IOException;
94: }
|