org.eclipse.swt.browser.ProgressListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2003, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.browser;

import org.eclipse.swt.internal.SWTEventListener;

/**
 * This listener interface may be implemented in order to receive
 * a {@link ProgressEvent} notification when a {@link Browser}
 * makes a progress in loading the current URL or when the
 * current URL has been loaded.
 *
 * @see Browser#addProgressListener(ProgressListener)
 * @see Browser#removeProgressListener(ProgressListener)
 * @see Browser#getUrl()
 *
 * @since 3.0
 */
public interface ProgressListener extends SWTEventListener {

/**
 * This method is called when a progress is made during the loading of the
 * current location.
 * 
 *
 * 
The following fields in the ProgressEvent apply:
 * 

 * (in) current the progress for the location currently being loaded
 * 
(in) total the maximum progress for the location currently being loaded
 * 
(in) widget the Browser whose current URL is being loaded
 * 
 *
 * @param event the ProgressEvent related to the loading of the
 * current location of a Browser
 *
 * @since 3.0
 */
public void changed(ProgressEvent event);

/**
 * This method is called when the current location has been completely loaded.
 * 
 *
 * 
The following fields in the ProgressEvent apply:
 * 

 * (in) widget the Browser whose current URL has been loaded
 * 
 *
 * @param event the ProgressEvent related to the Browser
 * that has loaded its current URL.
 *
 * @since 3.0
 */
public void completed(ProgressEvent event);
}