Eclipse eRCP
Release 1.1

org.eclipse.swt.browser
Class Browser

java.lang.Object
  extended byorg.eclipse.swt.widgets.Widget
      extended byorg.eclipse.swt.widgets.Control
          extended byorg.eclipse.swt.widgets.Scrollable
              extended byorg.eclipse.swt.widgets.Composite
                  extended byorg.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.

Events:
LocationListener, ProgressListener, StatusTextListener, TitleListener

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 the collection of listeners who will be notified when the current location has changed or is about to change.
 void addProgressListener(ProgressListener listener)
          Adds the listener to the collection of listeners who will be notified when a progress is made during the loading of the current URL or when the loading of the current URL has been completed.
 void addStatusTextListener(StatusTextListener listener)
          Adds the listener to the collection of listeners who will be notified when the status text is changed.
 void addTitleListener(TitleListener listener)
          Adds the listener to the collection of listeners who will be notified when the title of the current document is available or has changed.
 boolean back()
          Navigate to the previous session history item.
 boolean execute(String script)
          Executes the specified script.
 boolean forward()
          Navigate to the next session history item.
 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 from the collection of listeners who will be notified when the current location is changed or about to be changed.
 void removeProgressListener(ProgressListener listener)
          Removes the listener from the collection of listeners who will be notified when a progress is made during the loading of the current URL or when the loading of the current URL has been completed.
 void removeStatusTextListener(StatusTextListener listener)
          Removes the listener from the collection of listeners who will be notified when the status text is changed.
 void removeTitleListener(TitleListener listener)
          Removes the listener from the collection of listeners who will be notified when the title of the current document is available or has changed.
 boolean setText(String html)
          Renders a string containing HTML.
 boolean setUrl(String url)
          Begins loading a URL.
 void stop()
          Stop any loading and rendering activity.
 
Methods inherited from class org.eclipse.swt.widgets.Composite
checkSubclass, getBackgroundMode, getChildren, getLayout, getTabList, layout, layout, setBackgroundMode, 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, getBackgroundImage, 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, setBackgroundImage, 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:
IllegalArgumentException -
SWTException -
SWTError -
Since:
3.0
See Also:
Widget.getStyle()
Method Detail

addLocationListener

public void addLocationListener(LocationListener listener)
Adds the listener to the collection of listeners who will be notified when the current location has changed or is about to change.

This notification typically occurs when the application navigates to a new location with setUrl(String) or when the user activates a hyperlink.

Parameters:
listener - the listener which should be notified
Throws:
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 the collection of listeners who will be notified when a progress is made during the loading of the current URL or when the loading of the current URL has been completed.

Parameters:
listener - the listener which should be notified
Throws:
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 the collection of listeners who will be notified when the status text is changed.

The status text is typically displayed in the status bar of a browser application.

Parameters:
listener - the listener which should be notified
Throws:
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 the collection of listeners who will be notified when the title of the current document is available or has changed.

Parameters:
listener - the listener which should be notified
Throws:
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()

execute

public boolean execute(String script)
Executes the specified script.

Executes a script containing javascript commands in the context of the current document. If document-defined functions or properties are accessed by the script then this method should not be invoked until the document has finished loading (ProgressListener.completed() gives notification of this).

Parameters:
script - the script with javascript commands
Returns:
true if the operation was successful and false otherwise
Throws:
IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the script is null
SWTException -
  • ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
  • ERROR_WIDGET_DISPOSED when the widget has been disposed
Since:
3.1
See Also:
ProgressListener.completed(ProgressEvent)

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 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 from the collection of listeners who will be notified when the current location is changed or about to be changed.

Parameters:
listener - the listener which should no longer be notified
Throws:
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 from the collection of listeners who will be notified when a progress is made during the loading of the current URL or when the loading of the current URL has been completed.

Parameters:
listener - the listener which should no longer be notified
Throws:
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 from the collection of listeners who will be notified when the status text is changed.

Parameters:
listener - the listener which should no longer be notified
Throws:
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 from the collection of listeners who will be notified when the title of the current document is available or has changed.

Parameters:
listener - the listener which should no longer be notified
Throws:
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(String html)
Renders a string containing HTML. The rendering of the content occurs asynchronously.

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:
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(String url)
Begins loading a URL. The loading of its content occurs asynchronously.

Parameters:
url - the URL to be loaded
Returns:
true if the operation was successful and false otherwise.
Throws:
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

Eclipse eRCP
Release 1.1