org.eclipse.swt.browser.LocationListener 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 LocationEvent} notification when a {@link Browser}
 * navigates to a different URL.
 *
 * @see Browser#addLocationListener(LocationListener)
 * @see Browser#removeLocationListener(LocationListener)
 *
 * @since 3.0
 */
public interface LocationListener extends SWTEventListener {

/**
 * This method is called when the current location is about to be changed.
 * 
 *
 * 
The following fields in the LocationEvent apply:
 * 

 * (in) location the location to be loaded
 * 
(in) widget the Browser whose location is changing
 * 
(in/out) doit can be set to false to prevent the location
 * from being loaded
 * 
 *
 * @param event the LocationEvent that specifies the location
 * to be loaded by a Browser
 *
 * @since 3.0
 */
public void changing(LocationEvent event);

/**
 * This method is called when the current location is changed.
 * 
 *
 * 
The following fields in the LocationEvent apply:
 * 

 * (in) location the current location
 * 
(in) top true if the location opens in the top frame or
 * false otherwise
 * 
(in) widget the Browser whose location has changed
 * 
 *
 * @param event the LocationEvent that specifies  the new
 * location of a Browser
 *
 * @since 3.0
 */
public void changed(LocationEvent event);

}