KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > xam > ui > search > SearchListener


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-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.modules.xml.xam.ui.search;
21
22 import java.util.EventListener JavaDoc;
23
24 /**
25  * The listener interface for receiving search-related events.
26  *
27  * @author Nathan Fiedler
28  */

29 public interface SearchListener extends EventListener JavaDoc {
30
31     /**
32      * Invoked when the user has initiated a search, but the search is
33      * not yet complete.
34      *
35      * @param event the event object.
36      */

37     void searchCommenced(SearchEvent event);
38
39     /**
40      * Invoked when the user has dismissed the search by a means managed
41      * within the search interface (e.g. pressing the Esc key).
42      *
43      * @param event the event object.
44      */

45     void searchDismissed(SearchEvent event);
46
47     /**
48      * Invoked when the search failed due to an unexpected exception. The
49      * exception should contain a detail message that explains the issue.
50      *
51      * @param event the event object.
52      */

53     void searchFailed(SearchEvent event);
54
55     /**
56      * Invoked when the the search has completed and the results are now
57      * available for display.
58      *
59      * @param event the event object.
60      */

61     void searchFinished(SearchEvent event);
62 }
63
Popular Tags