KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > swt > browser > ProgressListener


1 /*******************************************************************************
2  * Copyright (c) 2003, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.swt.browser;
12
13 import org.eclipse.swt.internal.SWTEventListener;
14
15 /**
16  * This listener interface may be implemented in order to receive
17  * a {@link ProgressEvent} notification when a {@link Browser}
18  * makes a progress in loading the current URL or when the
19  * current URL has been loaded.
20  *
21  * @see Browser#addProgressListener(ProgressListener)
22  * @see Browser#removeProgressListener(ProgressListener)
23  * @see Browser#getUrl()
24  *
25  * @since 3.0
26  */
27 public interface ProgressListener extends SWTEventListener {
28     
29 /**
30  * This method is called when a progress is made during the loading of the
31  * current location.
32  * <p>
33  *
34  * <p>The following fields in the <code>ProgressEvent</code> apply:
35  * <ul>
36  * <li>(in) current the progress for the location currently being loaded
37  * <li>(in) total the maximum progress for the location currently being loaded
38  * <li>(in) widget the <code>Browser</code> whose current URL is being loaded
39  * </ul>
40  *
41  * @param event the <code>ProgressEvent</code> related to the loading of the
42  * current location of a <code>Browser</code>
43  *
44  * @since 3.0
45  */
46 public void changed(ProgressEvent event);
47     
48 /**
49  * This method is called when the current location has been completely loaded.
50  * <p>
51  *
52  * <p>The following fields in the <code>ProgressEvent</code> apply:
53  * <ul>
54  * <li>(in) widget the <code>Browser</code> whose current URL has been loaded
55  * </ul>
56  *
57  * @param event the <code>ProgressEvent</code> related to the <code>Browser</code>
58  * that has loaded its current URL.
59  *
60  * @since 3.0
61  */
62 public void completed(ProgressEvent event);
63 }
64
Popular Tags