javax.help.search.SearchListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javahelp Show documentation

The JavaHelp API provides a platform-independent help framework.

The newest version!

/*
 * @(#)SearchListener.java	1.11 06/10/30
 * 
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 * 
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 * 
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package javax.help.search;

/**
 * Defines the interface for an object that listens to
 * changes from a SearchQuery instance.
 *
 * @author Roger D. Brinkley
 * @version	1.11	10/30/06
 */

public interface SearchListener extends java.util.EventListener
{
    /**
     * Tells the listener that matching SearchItems have been found.
     */
    void itemsFound(SearchEvent e);

    /**
     * Tells the listener that the search has started.
     */
    void searchStarted(SearchEvent e);


    /**
     * Tells the listener that the search has finished
     */
    void searchFinished(SearchEvent e);
}