1 /*

     2  * Copyright (c) 2016, 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.io.File;

    29 import java.util.List;

    30 

    31 

    32 /**

    33  * Event sent when the app is asked to open a list of files.

    34  *

    35  * @see OpenFilesHandler#openFiles

    36  *

    37  * @since 9

    38  */

    39 public final class OpenFilesEvent extends FilesEvent {

    40     private static final long serialVersionUID = -3982871005867718956L;

    41     final String searchTerm;

    42 

    43     /**

    44      * Constructs an {@code OpenFilesEvent}

    45      * @param files files

    46      * @param searchTerm searchTerm

    47      */

    48     public OpenFilesEvent(final List<File> files, final String searchTerm) {

    49         super(files);

    50         this.searchTerm = searchTerm == null

    51                             ? ""

    52                             : searchTerm;

    53     }

    54 

    55     /**

    56      * Gets the search term. The platform may optionally provide the search

    57      * term that was used to find the files. This is for example the case

    58      * on Mac OS X, when the files were opened using the Spotlight search

    59      * menu or a Finder search window.

    60      *

    61      * This is useful for highlighting the search term in the documents when

    62      * they are opened.

    63      *

    64      * @return the search term used to find the files

    65      */

    66     public String getSearchTerm() {

    67         return searchTerm;

    68     }

    69 

    70 }