KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > browser > IBrowserDescriptorWorkingCopy


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 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.ui.internal.browser;
12 /**
13  * A working copy of an external web browser.
14  * <p>
15  * This interface is not intended to be implemented by clients.
16  * </p>
17  * @see org.eclipse.ui.internal.browser.IWebBrowser
18  * @see IBrowserDescriptor
19  * @since 1.0
20  */
21 public interface IBrowserDescriptorWorkingCopy extends IBrowserDescriptor {
22     /**
23      * Renames this browser to the specified name. The new name cannot be <code>null</code>.
24      *
25      * @param name the new name for this browser
26      */
27     public void setName(String JavaDoc name);
28
29     /**
30      * Set the location of this browsers executable. The location must not be <code>null</code>.
31      *
32      * @param location the new location
33      */
34     public void setLocation(String JavaDoc location);
35
36     /**
37      * Set the parameters for this browser. If there are no parameters, the parameters
38      * should be null.
39      *
40      * @param params the new parameters
41      */
42     public void setParameters(String JavaDoc params);
43
44     /**
45      * Saves the changes to this working copy and returns the resulting web browser.
46      *
47      * @return the modified or created browser
48      */
49     public IBrowserDescriptor save();
50 }
Popular Tags