001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009package imagingbook.common.util;
010
011import java.awt.Toolkit;
012import java.awt.datatransfer.DataFlavor;
013import java.awt.datatransfer.StringSelection;
014import java.awt.datatransfer.Transferable;
015
016/** 
017 * Clipboard-related methods from
018 * http://examples.javacodegeeks.com/desktop-java/awt/datatransfer/getting-and-setting-text-on-the-system-clipboard/
019 * 
020 * @author WB
021 * @version 2022/11/20
022 */
023
024public abstract class Clipboard {
025        
026        private Clipboard() {}
027        
028        /**
029         * Writes a string to the system clipboard.
030         * @param str some string
031         */
032        public static void copyStringToClipboard(String str) {
033                StringSelection stringSelection = new StringSelection(str);
034                Toolkit.getDefaultToolkit().getSystemClipboard().setContents(stringSelection, null);  
035        } 
036
037        /**
038         * If a string is on the system clipboard, this method returns it; otherwise it returns null.
039         * @return the clipboard string or null
040         */
041        public static String getStringFromClipboard() { 
042                String str = null;
043                Transferable trf = Toolkit.getDefaultToolkit().getSystemClipboard().getContents(null); 
044                if (trf != null && trf.isDataFlavorSupported(DataFlavor.stringFlavor)) {
045                        try {
046                                str = (String) trf.getTransferData(DataFlavor.stringFlavor);
047                        }  catch (Exception e) {};
048                }
049                return str; 
050        }
051
052}