org.eclipse.swt.browser
Class Browser

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  org.eclipse.swt.browser.Browser

All Implemented Interfaces:

Drawable

public class Browser

extends Composite

Instances of this class implement the browser user interface metaphor. It allows the user to visualize and navigate through HTML documents.

Note that although this class is a subclass of Composite, it does not make sense to set a layout on it.

IMPORTANT: This class is not intended to be subclassed.

Since:

3.0

Constructor Summary

Browser(Composite parent, int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

void	addLocationListener(LocationListener listener) Adds the listener to receive events.
void	addProgressListener(ProgressListener listener) Adds the listener to receive events.
void	addStatusTextListener(StatusTextListener listener) Adds the listener to receive events.
void	addTitleListener(TitleListener listener) Adds the listener to receive events.
boolean	back() Navigate to the previous session history item.
boolean	forward() Navigate to the next session history item.
java.lang.String	getUrl() Returns the current URL.
boolean	isBackEnabled() Returns true if the receiver can navigate to the previous session history item, and false otherwise.
boolean	isForwardEnabled() Returns true if the receiver can navigate to the next session history item, and false otherwise.
void	refresh() Refresh the current page.
void	removeLocationListener(LocationListener listener) Removes the listener.
void	removeProgressListener(ProgressListener listener) Removes the listener.
void	removeStatusTextListener(StatusTextListener listener) Removes the listener.
void	removeTitleListener(TitleListener listener) Removes the listener.
boolean	setText(java.lang.String html) Renders HTML.
boolean	setUrl(java.lang.String url) Loads a URL.
void	stop() Stop any loading and rendering activity.

Methods inherited from class org.eclipse.swt.widgets.Composite

checkSubclass, getChildren, getLayout, getTabList, layout, layout, setLayout, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addKeyListener, addMouseListener, addMouseMoveListener, addPaintListener, addTraverseListener, computeSize, computeSize, forceFocus, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getParent, getShell, getSize, getToolTipText, getVisible, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removePaintListener, removeTraverseListener, setBackground, setBounds, setBounds, setCapture, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Browser

public Browser(Composite parent,
               int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_NOT_IMPLEMENTED - if this class is not implemented

SWTError -

• ERROR_NO_HANDLES if a handle could not be obtained for browser creation

Since:

3.0

See Also:

Widget.getStyle()

Method Detail

addLocationListener

public void addLocationListener(LocationListener listener)

Adds the listener to receive events.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

addProgressListener

public void addProgressListener(ProgressListener listener)

Adds the listener to receive events.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

addStatusTextListener

public void addStatusTextListener(StatusTextListener listener)

Adds the listener to receive events.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

addTitleListener

public void addTitleListener(TitleListener listener)

Adds the listener to receive events.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

back

public boolean back()

Navigate to the previous session history item.

Returns:

true if the operation was successful and false otherwise

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

See Also:

forward()

forward

public boolean forward()

Navigate to the next session history item.

Returns:

true if the operation was successful and false otherwise

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

See Also:

back()

isBackEnabled

public boolean isBackEnabled()

Returns true if the receiver can navigate to the previous session history item, and false otherwise.

Returns:

the receiver's back command enabled state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

back()

isForwardEnabled

public boolean isForwardEnabled()

Returns true if the receiver can navigate to the next session history item, and false otherwise.

Returns:

the receiver's forward command enabled state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

forward()

getUrl

public java.lang.String getUrl()

Returns the current URL.

Returns:

the current URL or an empty String if there is no current URL

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

See Also:

setUrl(java.lang.String)

refresh

public void refresh()

Refresh the current page.

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

removeLocationListener

public void removeLocationListener(LocationListener listener)

Removes the listener.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Removes the listener.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

removeStatusTextListener

public void removeStatusTextListener(StatusTextListener listener)

Removes the listener.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

removeTitleListener

public void removeTitleListener(TitleListener listener)

Removes the listener.

Parameters:

listener - the listener

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

setText

public boolean setText(java.lang.String html)

Renders HTML.

The html parameter is Unicode encoded since it is a java String. As a result, the HTML meta tag charset should not be set. The charset is implied by the String itself.

Parameters:

html - the HTML content to be rendered

Returns:

true if the operation was successful and false otherwise.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the html is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

See Also:

setUrl(java.lang.String)

setUrl

public boolean setUrl(java.lang.String url)

Loads a URL.

Parameters:

url - the URL to be loaded

Returns:

true if the operation was successful and false otherwise.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the url is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0

See Also:

getUrl()

stop

public void stop()

Stop any loading and rendering activity.

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
• ERROR_WIDGET_DISPOSED when the widget has been disposed

Since:

3.0