IBrowserExt


1   /*******************************************************************************
2    * Copyright (c) 2005, 2006 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  import org.eclipse.ui.browser.IWebBrowser;
14  
15  /**
16   * A 
17   * 
18   * <p>This interface is not intended to be implemented by clients.</p>
19   * 
20   * @since 1.0
21   */
22  public interface IBrowserExt {
23      /**
24       * Returns the id of this client. Each known client has a distinct id. 
25       * Ids are intended to be used internally as keys; they are not
26       * intended to be shown to end users.
27       * 
28       * @return the client id
29       */
30      public String   getId();
31  
32      /**
33       * Returns the displayable name for this client.
34       * <p>
35       * Note that this name is appropriate for the current locale.
36       * </p>
37       *
38       * @return a displayable name for this client
39       */
40      public String   getName();
41  
42      /**
43       * Returns the parameters for this browser.
44       *
45       * @return the parameters for this browser
46       */
47      public String   getParameters();
48  
49      /**
50       * Returns the browser's executable.
51       *
52       * @return the browser's executable
53       */
54      public String   getExecutable();
55      
56      /**
57       * Returns the OSs that this browser is available on.
58       *
59       * @return an array of OSs that this browser runs on
60       */
61      public String   getOS();
62      
63      /**
64       * Returns the default install locations of this browser.
65       *
66       * @return the default install locations of this browser
67       */
68      public String  [] getDefaultLocations();
69      
70      /**
71       * Checks whether the factory can work on the user system.
72       * 
73       * @return false if the factory cannot work on this system; for example the
74       *    required native browser required by browser adapters that it
75       *    creates is not installed
76       */
77      public boolean isAvailable();
78  
79      /**
80       * Obtains a new instance of a web browser.
81       * 
82       * @return instance of IBrowser
83       */
84      public IWebBrowser createBrowser(String   id, String   location, String   parameters);
85  }
86
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags