KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openide > util > datatransfer > PasteType


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19 package org.openide.util.datatransfer;
20
21 import org.openide.util.HelpCtx;
22 import org.openide.util.NbBundle;
23
24 import java.awt.datatransfer.*;
25
26 import java.io.IOException JavaDoc;
27
28
29 /** Clipboard operation providing one kind of paste action. Used by
30 * <a HREF="@org-openide-nodes/org/openide/nodes.Node#getPasteTypes">Node.getPasteTypes</a>.
31 *
32 * @author Petr Hamernik
33 */
34 public abstract class PasteType extends Object JavaDoc implements HelpCtx.Provider {
35     /** Display name for the paste action. This should be
36     * presented as an item in a menu.
37     *
38     * @return the name of the action
39     */
40     public String JavaDoc getName() {
41         return NbBundle.getBundle(PasteType.class).getString("Paste");
42     }
43
44     /** Help content for the action.
45     * @return the help context
46     */
47     public HelpCtx getHelpCtx() {
48         return HelpCtx.DEFAULT_HELP;
49     }
50
51     /** Perform the paste action.
52     * @return transferable which should be inserted into the clipboard after the
53     * paste action. It can be <code>null</code>, meaning that the clipboard content
54     * is not affected. Use e.g. {@link ExTransferable#EMPTY} to clear it.
55     * @throws IOException if something fails
56     */
57     public abstract Transferable paste() throws IOException JavaDoc;
58
59     /* JST: Originally designed for dnd and it now uses getDropType () of a node.
60     *
61     * Perform the paste action at an index.
62     * @see NewType#createAt(int)
63     * @param indx index to insert into, can be ignored if not supported
64     * @return new transferable to be inserted into the clipboard
65     * public Transferable pasteAt (int indx) throws IOException {
66       return paste ();
67     }
68     */
69 }
70
Popular Tags