PATCH-1559330: PHPDoc comments are garbled in function hover. Applied patch .
[phpeclipse.git] / net.sourceforge.phpeclipse.webbrowser / src / net / sourceforge / phpeclipse / webbrowser / IWebBrowserEditorInput.java
1 /**
2  * Copyright (c) 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  �*
8  * Contributors:
9  *    IBM - Initial API and implementation
10  */
11 package net.sourceforge.phpeclipse.webbrowser;
12
13 import java.net.URL;
14
15 import org.eclipse.ui.IEditorInput;
16
17 /**
18  * The editor input for the Web browser editor. If the integrated Web browser
19  * exists for this platform, (and the user has chosen to use it) this
20  * information will be used to populate the Web browser. If not, this
21  * information will be used to launch an external Web browser.
22  */
23 public interface IWebBrowserEditorInput extends IEditorInput {
24         /**
25          * Returns true if this page can reuse the browser that the given input is
26          * being displayed in, or false if it should open up in a new page.
27          * 
28          * @param input
29          *            net.sourceforge.phpeclipse.webbrowser.IWebBrowserEditorInput
30          * @return boolean
31          */
32         public boolean canReplaceInput(IWebBrowserEditorInput input);
33
34         /**
35          * Returns the url that should be displayed in the browser.
36          * 
37          * @return java.net.URL
38          */
39         public URL getURL();
40
41         /**
42          * Returns true if the Web statusbar should be shown.
43          * 
44          * @return boolean
45          */
46         public boolean isStatusbarVisible();
47
48         /**
49          * Returns true if the Web toolbar should be shown.
50          * 
51          * @return boolean
52          */
53         public boolean isToolbarVisible();
54 }