1 /* 2 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.awt.desktop; 27 28 import java.awt.Desktop; 29 import java.awt.GraphicsEnvironment; 30 import java.awt.HeadlessException; 31 import java.io.File; 32 import java.util.List; 33 34 /** 35 * Event sent when the app is asked to open a list of files. 36 * 37 * @see OpenFilesHandler#openFiles 38 * @since 9 39 */ 40 public final class OpenFilesEvent extends FilesEvent { 41 42 /** 43 * Use serialVersionUID from JDK 9 for interoperability. 44 */ 45 private static final long serialVersionUID = -3982871005867718956L; 46 47 /** 48 * The search term used to find the files. 49 */ 50 final String searchTerm; 51 52 /** 53 * Constructs an {@code OpenFilesEvent}. 54 * 55 * @param files the list of files 56 * @param searchTerm the search term 57 * @throws HeadlessException if {@link GraphicsEnvironment#isHeadless()} 58 * returns {@code true} 59 * @throws UnsupportedOperationException if Desktop API is not supported on 60 * the current platform 61 * @see Desktop#isDesktopSupported() 62 * @see java.awt.GraphicsEnvironment#isHeadless 63 */ 64 public OpenFilesEvent(final List<File> files, final String searchTerm) { 65 super(files); 66 this.searchTerm = searchTerm == null 67 ? "" 68 : searchTerm; 69 } 70 71 /** 72 * Gets the search term. The platform may optionally provide the search term 73 * that was used to find the files. This is for example the case on Mac OS 74 * X, when the files were opened using the Spotlight search menu or a Finder 75 * search window. 76 * <p> 77 * This is useful for highlighting the search term in the documents when 78 * they are opened. 79 * 80 * @return the search term used to find the files 81 */ 82 public String getSearchTerm() { 83 return searchTerm; 84 } 85 }