org.eclipse.ui.browser.IWebBrowser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2005, 2012 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.ui.browser;

import java.net.URL;
import org.eclipse.ui.PartInitException;

/**
 * An opened Web browser instance (either internal or external).
 * 
 * This interface is not intended to be implemented by clients.
 * 
 *
 * @since 3.1
 * @see IWorkbenchBrowserSupport
 * @noimplement This interface is not intended to be implemented by clients.
 */

public interface IWebBrowser {
	/**
	 * Returns the unique identifier of this browser. If an id has been supplied
	 * to the browser support when the instance was created, it will be used.
	 * Otherwise, a generated id will be provided to the browser that is
	 * guaranteed to be unique.
	 *
	 * @return a unique identifier of this browser instance
	 */
	String getId();

	/**
	 * Opens a URL on this Web browser instance.
	 * 
	 * NOTE This method must be called from the current UI thread
	 * 
	 *
	 * @param url
	 *            the URL to display
	 * @exception PartInitException
	 *                if the browser fails to navigate to the provided url for
	 *                any reason
	 */
	void openURL(URL url) throws PartInitException;

	/**
	 * Closes this browser instance.
	 * 
	 * NOTE This method must be called from the current UI thread
	 * 
	 *
	 * @return true if the browser was closed or false
	 *         if the operation failed or is not supported.
	 */
	boolean close();

}