KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jdesktop > jdic > browser > WebBrowserListener


1 /*
2  * Copyright (C) 2004 Sun Microsystems, Inc. All rights reserved. Use is
3  * subject to license terms.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the Lesser GNU General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18  * USA.
19  */
20
21 package org.jdesktop.jdic.browser;
22
23 /**
24  * The listener interface for receiving WebBrowser events. The class that is
25  * interested in processing a WebBrowser event implements this interface or
26  * inherits the <code>WebBrowserAdapter</code> abstract class.
27  * <p>
28  * The object created with that class is registered with a <code>
29  * WebBrowser</code> component, using the <code>addWebBrowserListener</code>
30  * method. When the WebBrowser event occurs, that object's corresponding method
31  * is invoked.
32  *
33  * @see WebBrowserEvent
34  * @see WebBrowser
35  *
36  * @author Kyle Yuan
37  * @version 0.1, 03/07/17
38  */
39 public interface WebBrowserListener extends java.util.EventListener JavaDoc
40 {
41     /**
42      * Invoked when a download operation is beginning.
43      *
44      * @param event the WebBrowserEvent fired.
45      */
46     void downloadStarted(WebBrowserEvent event);
47
48     /**
49      * Invoked when a download operation finishes, is halted, or fails.
50      *
51      * @param event the WebBrowserEvent fired.
52      */
53     void downloadCompleted(WebBrowserEvent event);
54
55     /**
56      * Invoked when the progress of a download operation is updated.
57      *
58      * @param event the WebBrowserEvent fired.
59      */
60     void downloadProgress(WebBrowserEvent event);
61
62     /**
63      * Invoked when an error occurs during a download operation.
64      *
65      * @param event the WebBrowserEvent fired.
66      */
67     void downloadError(WebBrowserEvent event);
68
69     /**
70      * Invoked when the document loading has been completed.
71      *
72      * @param event the WebBrowserEvent fired.
73      * @since 0.9
74      */
75     void documentCompleted(WebBrowserEvent event);
76     
77     /**
78      * Invoked when the title of a document is changed.
79      *
80      * @param event the WebBrowserEvent fired.
81      */
82     void titleChange(WebBrowserEvent event);
83
84     /**
85      * Invoked when the status bar text is changed.
86      *
87      * @param event the WebBrowserEvent fired.
88      */
89     void statusTextChange(WebBrowserEvent event);
90 }
91
Popular Tags