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 *
39 * @since 9
40 */
41 public final class OpenFilesEvent extends FilesEvent {
42
43 private static final long serialVersionUID = -3982871005867718956L;
44 final String searchTerm;
45
46 /**
47 * Constructs an {@code OpenFilesEvent}.
48 *
49 * @param files the list of files
50 * @param searchTerm the search term
51 * @throws HeadlessException if {@link GraphicsEnvironment#isHeadless()}
52 * returns {@code true}
53 * @throws UnsupportedOperationException if Desktop API is not supported on
54 * the current platform
55 * @see Desktop#isDesktopSupported()
56 * @see java.awt.GraphicsEnvironment#isHeadless
57 */
58 public OpenFilesEvent(final List<File> files, final String searchTerm) {
59 super(files);
60 this.searchTerm = searchTerm == null
61 ? ""
62 : searchTerm;
63 }
64
65 /**
66 * Gets the search term. The platform may optionally provide the search
67 * term that was used to find the files. This is for example the case
68 * on Mac OS X, when the files were opened using the Spotlight search
69 * menu or a Finder search window.
70 * <p>
71 * This is useful for highlighting the search term in the documents when
72 * they are opened.
73 *
74 * @return the search term used to find the files
75 */
76 public String getSearchTerm() {
77 return searchTerm;
78 }
79 }
|
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 }
|