blob: d9c5cfb50cc54f7b26ac1e0995af010284ba2f8d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.browser;
/**
* Represents a web browser that can be used by clients to display documents for
* the given URLs.
*
* @since 2.1
*/
public interface IBrowser {
/**
* Closes the browser.
*/
public void close();
/**
* Queries the browser if close method is supported.
*
* @return true if the method is fully implemented
*/
public boolean isCloseSupported();
/**
* Displays document with the given URL, and makes the browser visible. This
* method starts the browser if necessary.
*
* @param url
* the URL to display in the browser
*/
public void displayURL(String url) throws Exception;
/**
* Queries the browser if setLocation method is supported.
*
* @return true if the method is fully implemented
*/
public boolean isSetLocationSupported();
/**
* Queries the browser if setSize method is supported.
*
* @return true if the method is fully implemented
*/
public boolean isSetSizeSupported();
/**
* Causes the browser to be moved to the specified location. If the actual
* browser is not visible, the next time it becomes visible, it will be
* shown at the give location
*
* @param x
* horizontal coordinates of the left-top external corner
* @param y
* vertical coordinates of the left-top external corner
*/
public void setLocation(int x, int y);
/**
* Causes the browser to be resized to the specified size. If the actual
* browser is not visible, the next time it becomes visible, it will be
* shown with the give size.
*
* @param width
* width in pixels
* @param height
* height in pixels external corner
*/
public void setSize(int width, int height);
}
|
