public Class Browser

public void addAuthenticationListener(AuthenticationListener listener)

Adds the listener to the collection of listeners who will be notified when authentication is required.

This notification occurs when a page requiring authentication is encountered.

Parameters

listener:AuthenticationListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.5

addCloseWindowListener back to summary

addCloseWindowListener	back to summary
public void addCloseWindowListener(CloseWindowListener listener) Adds the listener to the collection of listeners who will be notified when the window hosting the receiver should be closed. This notification occurs when a javascript command such as `window.close` gets executed by a `Browser`. Parameters listener:CloseWindowListener the listener which should be notified Exceptions 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

public void addCloseWindowListener(CloseWindowListener listener)

Adds the listener to the collection of listeners who will be notified when the window hosting the receiver should be closed.

This notification occurs when a javascript command such as window.close gets executed by a Browser.

Parameters

listener:CloseWindowListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

addLocationListener back to summary

addLocationListener	back to summary
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:LocationListener the listener which should be notified Exceptions 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

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:LocationListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

addOpenWindowListener back to summary

addOpenWindowListener	back to summary
public void addOpenWindowListener(OpenWindowListener listener) Adds the listener to the collection of listeners who will be notified when a new window needs to be created. This notification occurs when a javascript command such as `window.open` gets executed by a `Browser`. Parameters listener:OpenWindowListener the listener which should be notified Exceptions 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

public void addOpenWindowListener(OpenWindowListener listener)

Adds the listener to the collection of listeners who will be notified when a new window needs to be created.

This notification occurs when a javascript command such as window.open gets executed by a Browser.

Parameters

listener:OpenWindowListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

addProgressListener	back to summary
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:ProgressListener the listener which should be notified Exceptions 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:ProgressListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

addStatusTextListener	back to summary
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:StatusTextListener the listener which should be notified Exceptions 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:StatusTextListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

addTitleListener	back to summary
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:TitleListener the listener which should be notified Exceptions 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:TitleListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

addVisibilityWindowListener	back to summary
public void addVisibilityWindowListener(VisibilityWindowListener listener) Adds the listener to the collection of listeners who will be notified when a window hosting the receiver needs to be displayed or hidden. Parameters listener:VisibilityWindowListener the listener which should be notified Exceptions 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

addVisibilityWindowListener

public void addVisibilityWindowListener(VisibilityWindowListener listener)

Adds the listener to the collection of listeners who will be notified when a window hosting the receiver needs to be displayed or hidden.

Parameters

listener:VisibilityWindowListener: the listener which should be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

back back to summary

back	back to summary
public boolean back() Navigate to the previous session history item. Returns:boolean `true` if the operation was successful and `false` otherwise Exceptions 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`

public boolean back()

Navigate to the previous session history item.

Returns:boolean

true if the operation was successful and false otherwise

Exceptions

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

checkParent	back to summary
pack-priv static Composite checkParent(Composite parent)

checkStyle	back to summary
pack-priv static int checkStyle(int style) Hides org.eclipse.swt.widgets.Composite.checkStyle.

checkSubclass back to summary

checkSubclass	back to summary
protected void checkSubclass() Overrides org.eclipse.swt.widgets.Composite.checkSubclass. Doc from org.eclipse.swt.widgets.Widget.checkSubclass. Checks that this class can be subclassed. The SWT class library is intended to be subclassed only at specific, controlled points (most notably, `Composite` and `Canvas` when implementing new widgets). This method enforces this rule unless it is overridden. Important Note By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion. The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy. Annotations @Override

protected void checkSubclass()

Overrides org.eclipse.swt.widgets.Composite.checkSubclass.

Doc from org.eclipse.swt.widgets.Widget.checkSubclass.

Checks that this class can be subclassed.

The SWT class library is intended to be subclassed only at specific, controlled points (most notably, Composite and Canvas when implementing new widgets). This method enforces this rule unless it is overridden.

Important Note

By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.

The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.

Annotations

@Override

checkWidget back to summary

checkWidget	back to summary
protected void checkWidget() Overrides org.eclipse.swt.widgets.Widget.checkWidget. Doc from org.eclipse.swt.widgets.Widget.checkWidget. Throws an `SWTException` if the receiver can not be accessed by the caller. This may include both checks on the state of the receiver and more generally on the entire execution context. This method should be called by widget implementors to enforce the standard SWT invariants. Currently, it is an error to invoke any method (other than `isDisposed()`) on a widget that has had its `dispose()` method called. It is also an error to call widget methods from any thread that is different from the thread that created the widget. In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons. Annotations @Override

protected void checkWidget()

Overrides org.eclipse.swt.widgets.Widget.checkWidget.

Doc from org.eclipse.swt.widgets.Widget.checkWidget.

Throws an SWTException if the receiver can not be accessed by the caller. This may include both checks on the state of the receiver and more generally on the entire execution context. This method should be called by widget implementors to enforce the standard SWT invariants.

Currently, it is an error to invoke any method (other than isDisposed()) on a widget that has had its dispose() method called. It is also an error to call widget methods from any thread that is different from the thread that created the widget.

In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.

Annotations

@Override

clearSessions	back to summary
public static void clearSessions() Clears all session cookies from all current Browser instances. Since 3.2

clearSessions

public static void clearSessions()

Clears all session cookies from all current Browser instances.

Since: 3.2

close back to summary

close	back to summary
public boolean close() Attempts to dispose the receiver, but allows the dispose to be vetoed by the user in response to an `onbeforeunload` listener in the Browser's current page. Returns:boolean `true` if the receiver was disposed, and `false` otherwise Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.6 See Also `dispose()`

public boolean close()

Attempts to dispose the receiver, but allows the dispose to be vetoed by the user in response to an onbeforeunload listener in the Browser's current page.

Returns:boolean

true if the receiver was disposed, and false otherwise

Exceptions

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

Since

3.6

See Also

dispose()

evaluate back to summary

evaluate	back to summary
public Object evaluate(String script) throws SWTException Returns the result, if any, of executing the specified script. Evaluates 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). If the script returns a value with a supported type then a java representation of the value is returned. The supported javascript -> java mappings are: javascript null or undefined -> `null` javascript number -> `java.lang.Double` javascript string -> `java.lang.String` javascript boolean -> `java.lang.Boolean` javascript array whose elements are all of supported types -> `java.lang.Object[]` An `SWTException` is thrown if the return value has an unsupported type, or if evaluating the script causes a javascript error to be thrown. Parameters script:String the script with javascript commands Returns:Object the return value, if any, of executing the script Exceptions SWTException: ERROR_FAILED_EVALUATE when the script evaluation causes a javascript error to be thrown ERROR_INVALID_RETURN_VALUE when the script returns a value of unsupported type ERROR_THREAD_INVALID_ACCESS when called from the wrong thread ERROR_WIDGET_DISPOSED when the widget has been disposed IllegalArgumentException: ERROR_NULL_ARGUMENT - if the script is null Since 3.5 See Also `Browser#evaluate(String, boolean)`, `ProgressListener#completed(ProgressEvent)`

public Object evaluate(String script) throws SWTException

Returns the result, if any, of executing the specified script.

Evaluates 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).

If the script returns a value with a supported type then a java representation of the value is returned. The supported javascript -> java mappings are:

javascript null or undefined -> null
javascript number -> java.lang.Double
javascript string -> java.lang.String
javascript boolean -> java.lang.Boolean
javascript array whose elements are all of supported types -> java.lang.Object[]

An SWTException is thrown if the return value has an unsupported type, or if evaluating the script causes a javascript error to be thrown.

Parameters

script:String: the script with javascript commands

Returns:Object

the return value, if any, of executing the script

Exceptions

ERROR_FAILED_EVALUATE when the script evaluation causes a javascript error to be thrown
ERROR_INVALID_RETURN_VALUE when the script returns a value of unsupported type
ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
ERROR_WIDGET_DISPOSED when the widget has been disposed

ERROR_NULL_ARGUMENT - if the script is null

Since

3.5

evaluate back to summary

evaluate	back to summary
public Object evaluate(String script, boolean trusted) throws SWTException Returns the result, if any, of executing the specified script. Evaluates a script containing javascript commands. When `trusted` is `true` script is executed in the context of Chrome with Chrome security privileges. When `trusted` is `false` script is executed in the context of the current document with normal privileges. 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). If the script returns a value with a supported type then a java representation of the value is returned. The supported javascript -> java mappings are: javascript null or undefined -> `null` javascript number -> `java.lang.Double` javascript string -> `java.lang.String` javascript boolean -> `java.lang.Boolean` javascript array whose elements are all of supported types -> `java.lang.Object[]` An `SWTException` is thrown if the return value has an unsupported type, or if evaluating the script causes a javascript error to be thrown. Parameters script:String the script with javascript commands trusted:boolean `true` or `false` depending on the security context to be used Returns:Object the return value, if any, of executing the script Exceptions SWTException: ERROR_FAILED_EVALUATE when the script evaluation causes a javascript error to be thrown ERROR_INVALID_RETURN_VALUE when the script returns a value of unsupported type ERROR_THREAD_INVALID_ACCESS when called from the wrong thread ERROR_WIDGET_DISPOSED when the widget has been disposed IllegalArgumentException: ERROR_NULL_ARGUMENT - if the script is null See Also `ProgressListener#completed(ProgressEvent)`

public Object evaluate(String script, boolean trusted) throws SWTException

Returns the result, if any, of executing the specified script.

Evaluates a script containing javascript commands. When trusted is true script is executed in the context of Chrome with Chrome security privileges. When trusted is false script is executed in the context of the current document with normal privileges.

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

If the script returns a value with a supported type then a java representation of the value is returned. The supported javascript -> java mappings are:

javascript null or undefined -> null
javascript number -> java.lang.Double
javascript string -> java.lang.String
javascript boolean -> java.lang.Boolean
javascript array whose elements are all of supported types -> java.lang.Object[]

An SWTException is thrown if the return value has an unsupported type, or if evaluating the script causes a javascript error to be thrown.

Parameters

script:String: the script with javascript commands
trusted:boolean: true or false depending on the security context to be used

Returns:Object

the return value, if any, of executing the script

Exceptions

ERROR_FAILED_EVALUATE when the script evaluation causes a javascript error to be thrown
ERROR_INVALID_RETURN_VALUE when the script returns a value of unsupported type
ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
ERROR_WIDGET_DISPOSED when the widget has been disposed

ERROR_NULL_ARGUMENT - if the script is null

execute back to summary

execute	back to summary
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:String the script with javascript commands Returns:boolean `true` if the operation was successful and `false` otherwise Exceptions 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)`

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:String: the script with javascript commands

Returns:boolean

true if the operation was successful and false otherwise

Exceptions

ERROR_NULL_ARGUMENT - if the script is null

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

Since

3.1

forward back to summary

forward	back to summary
public boolean forward() Navigate to the next session history item. Returns:boolean `true` if the operation was successful and `false` otherwise Exceptions 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`

public boolean forward()

Navigate to the next session history item.

Returns:boolean

true if the operation was successful and false otherwise

Exceptions

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

getBrowserType	back to summary
public String getBrowserType() Returns the type of native browser being used by this instance. Examples: "ie", "webkit" Returns:String the type of the native browser Since 3.5

getBrowserType

public String getBrowserType()

Returns the type of native browser being used by this instance. Examples: "ie", "webkit"

Returns:String: the type of the native browser
Since: 3.5

getCookie back to summary

public static String getCookie(String name, String url)

Returns the value of a cookie that is associated with a URL. Note that cookies are shared amongst all Browser instances.

Parameters

name:String: the cookie name
url:String: the URL that the cookie is associated with

Returns:String

the cookie value, or null if no such cookie exists

Exceptions

ERROR_NULL_ARGUMENT - if the name is null
ERROR_NULL_ARGUMENT - if the url is null

Since

3.5

getJavascriptEnabled back to summary

getJavascriptEnabled	back to summary
public boolean getJavascriptEnabled() Returns `true` if javascript will be allowed to run in pages subsequently viewed in the receiver, and `false` otherwise. Note that this may not reflect the javascript enablement on the currently- viewed page if `setJavascriptEnabled()` has been invoked during its lifetime. Returns:boolean the receiver's javascript enabled state Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.5 See Also `setJavascriptEnabled`

public boolean getJavascriptEnabled()

Returns true if javascript will be allowed to run in pages subsequently viewed in the receiver, and false otherwise. Note that this may not reflect the javascript enablement on the currently- viewed page if setJavascriptEnabled() has been invoked during its lifetime.

Returns:boolean

the receiver's javascript enabled state

Exceptions

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

Since

3.5

See Also

setJavascriptEnabled

getStyle back to summary

getStyle	back to summary
public int getStyle() Overrides org.eclipse.swt.widgets.Widget.getStyle. Doc from org.eclipse.swt.widgets.Widget.getStyle. Returns the receiver's style information. Note that the value which is returned by this method may not match the value which was provided to the constructor when the receiver was created. This can occur when the underlying operating system does not support a particular combination of requested styles. For example, if the platform widget used to implement a particular SWT widget always has scroll bars, the result of calling this method would always have the `SWT.H_SCROLL` and `SWT.V_SCROLL` bits set. Returns:int the style bits Annotations @Override

public int getStyle()

Overrides org.eclipse.swt.widgets.Widget.getStyle.

Doc from org.eclipse.swt.widgets.Widget.getStyle.

Returns the receiver's style information.

Note that the value which is returned by this method may not match the value which was provided to the constructor when the receiver was created. This can occur when the underlying operating system does not support a particular combination of requested styles. For example, if the platform widget used to implement a particular SWT widget always has scroll bars, the result of calling this method would always have the SWT.H_SCROLL and SWT.V_SCROLL bits set.

Returns:int

the style bits

Annotations

@Override

getText back to summary

getText	back to summary
public String getText() Returns a string with HTML that represents the content of the current page. Returns:String HTML representing the current page or an empty `String` if this is empty. Note, the exact return value is platform dependent. For example on Windows, the returned string is the proccessed webpage with javascript executed and missing html tags added. On Linux and OS X, this returns the original HTML before the browser has processed it. Exceptions SWTException: ERROR_THREAD_INVALID_ACCESS when called from the wrong thread ERROR_WIDGET_DISPOSED when the widget has been disposed Since 3.4

public String getText()

Returns a string with HTML that represents the content of the current page.

Returns:String

HTML representing the current page or an empty String if this is empty.

Note, the exact return value is platform dependent. For example on Windows, the returned string is the proccessed webpage with javascript executed and missing html tags added. On Linux and OS X, this returns the original HTML before the browser has processed it.

Exceptions

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

Since

3.4

getUrl back to summary

getUrl	back to summary
public String getUrl() Returns the current URL. Returns:String the current URL or an empty `String` if there is no current URL Exceptions 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`

public String getUrl()

Returns the current URL.

Returns:String

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

Exceptions

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

getWebBrowser back to summary

getWebBrowser	back to summary
public Object getWebBrowser() Deprecated SWT.MOZILLA is deprecated and XULRunner as a browser renderer is no longer supported. Returns the JavaXPCOM `nsIWebBrowser` for the receiver, or `null` if it is not available. In order for an `nsIWebBrowser` to be returned all of the following must be true: the receiver's style must be `SWT.MOZILLA` the classes from JavaXPCOM >= 1.8.1.2 must be resolvable at runtime the version of the underlying XULRunner must be >= 1.8.1.2 Returns:Object the receiver's JavaXPCOM `nsIWebBrowser` or `null` Annotations @Deprecated Since 3.3

public Object getWebBrowser()

Deprecated

SWT.MOZILLA is deprecated and XULRunner as a browser renderer is no longer supported.

Returns the JavaXPCOM nsIWebBrowser for the receiver, or null if it is not available. In order for an nsIWebBrowser to be returned all of the following must be true:

the receiver's style must be SWT.MOZILLA
the classes from JavaXPCOM >= 1.8.1.2 must be resolvable at runtime
the version of the underlying XULRunner must be >= 1.8.1.2

Returns:Object

the receiver's JavaXPCOM nsIWebBrowser or null

Annotations

@Deprecated

Since

3.3

isBackEnabled back to summary

isBackEnabled	back to summary
public boolean isBackEnabled() Returns `true` if the receiver can navigate to the previous session history item, and `false` otherwise. Returns:boolean the receiver's back command enabled state Exceptions 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`

public boolean isBackEnabled()

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

Returns:boolean

the receiver's back command enabled state

Exceptions

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

isFocusControl back to summary

isFocusControl	back to summary
public boolean isFocusControl() Overrides org.eclipse.swt.widgets.Control.isFocusControl. Doc from org.eclipse.swt.widgets.Control.isFocusControl. Returns `true` if the receiver has the user-interface focus, and `false` otherwise. Returns:boolean the receiver's focus state Annotations @Override

public boolean isFocusControl()

Overrides org.eclipse.swt.widgets.Control.isFocusControl.

Doc from org.eclipse.swt.widgets.Control.isFocusControl.

Returns true if the receiver has the user-interface focus, and false otherwise.

Returns:boolean

the receiver's focus state

Annotations

@Override

isForwardEnabled back to summary

isForwardEnabled	back to summary
public boolean isForwardEnabled() Returns `true` if the receiver can navigate to the next session history item, and `false` otherwise. Returns:boolean the receiver's forward command enabled state Exceptions 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`

public boolean isForwardEnabled()

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

Returns:boolean

the receiver's forward command enabled state

Exceptions

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

refresh	back to summary
public void refresh() Refresh the current page. Exceptions SWTException: ERROR_THREAD_INVALID_ACCESS when called from the wrong thread ERROR_WIDGET_DISPOSED when the widget has been disposed Since 3.0

refresh

public void refresh()

Refresh the current page.

Exceptions

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

Since

3.0

removeAuthenticationListener	back to summary
public void removeAuthenticationListener(AuthenticationListener listener) Removes the listener from the collection of listeners who will be notified when authentication is required. Parameters listener:AuthenticationListener the listener which should no longer be notified Exceptions 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.5

removeAuthenticationListener

public void removeAuthenticationListener(AuthenticationListener listener)

Removes the listener from the collection of listeners who will be notified when authentication is required.

Parameters

listener:AuthenticationListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.5

removeCloseWindowListener	back to summary
public void removeCloseWindowListener(CloseWindowListener listener) Removes the listener from the collection of listeners who will be notified when the window hosting the receiver should be closed. Parameters listener:CloseWindowListener the listener which should no longer be notified Exceptions 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

removeCloseWindowListener

public void removeCloseWindowListener(CloseWindowListener listener)

Removes the listener from the collection of listeners who will be notified when the window hosting the receiver should be closed.

Parameters

listener:CloseWindowListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

removeLocationListener	back to summary
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:LocationListener the listener which should no longer be notified Exceptions 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

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:LocationListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

removeOpenWindowListener	back to summary
public void removeOpenWindowListener(OpenWindowListener listener) Removes the listener from the collection of listeners who will be notified when a new window needs to be created. Parameters listener:OpenWindowListener the listener which should no longer be notified Exceptions 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

removeOpenWindowListener

public void removeOpenWindowListener(OpenWindowListener listener)

Removes the listener from the collection of listeners who will be notified when a new window needs to be created.

Parameters

listener:OpenWindowListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

removeProgressListener	back to summary
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:ProgressListener the listener which should no longer be notified Exceptions 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:ProgressListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

removeStatusTextListener	back to summary
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:StatusTextListener the listener which should no longer be notified Exceptions 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:StatusTextListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

removeTitleListener	back to summary
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:TitleListener the listener which should no longer be notified Exceptions 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:TitleListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

removeVisibilityWindowListener	back to summary
public void removeVisibilityWindowListener(VisibilityWindowListener listener) Removes the listener from the collection of listeners who will be notified when a window hosting the receiver needs to be displayed or hidden. Parameters listener:VisibilityWindowListener the listener which should no longer be notified Exceptions 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

removeVisibilityWindowListener

public void removeVisibilityWindowListener(VisibilityWindowListener listener)

Removes the listener from the collection of listeners who will be notified when a window hosting the receiver needs to be displayed or hidden.

Parameters

listener:VisibilityWindowListener: the listener which should no longer be notified

Exceptions

ERROR_NULL_ARGUMENT - if the listener is null

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

Since

3.0

setCookie back to summary

public static boolean setCookie(String value, String url)

Sets a cookie on a URL. Note that cookies are shared amongst all Browser instances. The value parameter must be a cookie header string that complies with RFC 2109. The value is passed through to the native browser unchanged.

Example value strings: foo=bar (basic session cookie) foo=bar; path=/; domain=.eclipse.org (session cookie) foo=bar; expires=Tue, 01-Jan-2030 00:00:01 GMT (persistent cookie) foo=; expires=Thu, 01-Jan-1970 00:00:01 GMT (deletes cookie foo)

Parameters

value:String: the cookie value
url:String: the URL to associate the cookie with

Returns:boolean

true if the cookie was successfully set and false otherwise

Exceptions

ERROR_NULL_ARGUMENT - if the value is null
ERROR_NULL_ARGUMENT - if the url is null

Since

3.5

setJavascriptEnabled

public void setJavascriptEnabled(boolean enabled)

Sets whether javascript will be allowed to run in pages subsequently viewed in the receiver. Note that setting this value does not affect the running of javascript in the current page.

Parameters

enabled:boolean: the receiver's new javascript enabled state

Exceptions

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

Since

3.5

setText back to summary

public boolean setText(String html)

Renders a string containing HTML. The rendering of the content occurs asynchronously. The rendered page will be given trusted permissions; to render the page with untrusted permissions use setText(String html, boolean trusted) instead.

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:String: the HTML content to be rendered

Returns:boolean

true if the operation was successful and false otherwise.

Exceptions

ERROR_NULL_ARGUMENT - if the html is null

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

Since

3.0

See Also

setText(String, boolean), setUrl

setText back to summary

public boolean setText(String html, boolean trusted)

Renders a string containing HTML. The rendering of the content occurs asynchronously. The rendered page can be given either trusted or untrusted permissions.

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.

The trusted parameter affects the permissions that will be granted to the rendered page. Specifying true for trusted gives the page permissions equivalent to a page on the local file system, while specifying false for trusted gives the page permissions equivalent to a page from the internet. Page content should be specified as trusted if the invoker created it or trusts its source, since this would allow (for instance) style sheets on the local file system to be referenced. Page content should be specified as untrusted if its source is not trusted or is not known.

Parameters

html:String: the HTML content to be rendered
trusted:boolean: false if the rendered page should be granted restricted permissions and true otherwise

Returns:boolean

true if the operation was successful and false otherwise.

Exceptions

ERROR_NULL_ARGUMENT - if the html is null

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

Since

3.6

See Also

setText(String), setUrl

setUrl back to summary

public boolean setUrl(String url)

Begins loading a URL. The loading of its content occurs asynchronously.

Parameters

url:String: the URL to be loaded

Returns:boolean

true if the operation was successful and false otherwise.

Exceptions

ERROR_NULL_ARGUMENT - if the url is null

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

Since

3.0

setUrl back to summary

public boolean setUrl(String url, String postData, String[] headers)

Begins loading a URL. The loading of its content occurs asynchronously.

If the URL causes an HTTP request to be initiated then the provided postData and header arguments, if any, are sent with the request. A value in the headers argument must be a name-value pair with a colon separator in order to be sent (for example: "user-agent: custom").

Parameters

url:String: the URL to be loaded
postData:String: post data to be sent with the request, or null
headers:String[]: header lines to be sent with the request, or null

Returns:boolean

true if the operation was successful and false otherwise.

Exceptions

ERROR_NULL_ARGUMENT - if the url is null

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

Since

3.6

stop

public void stop()

Stop any loading and rendering activity.

Exceptions