org.eclipse.help.ui.browser
Interface IBrowser

public interface IBrowser

Represents a web browser that can be used by clients to display documents for the given URLs.

Since:

2.0

Method Summary

void	close() Closes the browser.
void	displayURL(String url) Displays document with the given URL, and makes the browser visible.
boolean	isCloseSupported() Queries the browser if close method is supported.
boolean	isSetLocationSupported() Queries the browser if setLocation method is supported.
boolean	isSetSizeSupported() Queries the browser if setSize method is supported.
void	setLocation(int x, int y) Causes browser to be moved to the specified location.
void	setSize(int width, int height) Causes browser to be resized to the specified size.

Method Detail

close

public void close()

Closes the browser.

isCloseSupported

public boolean isCloseSupported()

Queries the browser if close method is supported.

Returns:

true if the method is fully implemented

displayURL

public void displayURL(String url)

Displays document with the given URL, and makes the browser visible. This method starts the browser if necessary.

Parameters:

url - the URL to display in the browser

isSetLocationSupported

public boolean isSetLocationSupported()

Queries the browser if setLocation method is supported.

Returns:

true if the method is fully implemented

isSetSizeSupported

public boolean isSetSizeSupported()

Queries the browser if setSize method is supported.

Returns:

true if the method is fully implemented

setLocation

public void setLocation(int x,
                        int y)

Causes 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

Parameters:

x - horizontal coordinates of the left-top external corner

y - vertical coordinates of the left-top external corner

setSize

public void setSize(int width,
                    int height)

Causes 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.

Parameters:

width - width in pixels

height - height in pixels external corner