Browser

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 <code>Composite</code>, it does not make sense to set a layout on it. <dl> <dt>Styles:</dt> <dd>MOZILLA</dd> <dt>Events:</dt> <dd>CloseWindowListener, LocationListener, OpenWindowListener, ProgressListener, StatusTextListener, TitleListener, VisibilityWindowListener</dd> </dl> IMPORTANT: This class is not intended to be subclassed.

@since 3.0

class Browser : Composite {

WebBrowser webBrowser;

int userStyle;

String PACKAGE_PREFIX;

String NO_INPUT_METHOD;

this(Composite parent, int style);

static void clearSessions();

void addCloseWindowListener(CloseWindowListener listener);

void addLocationListener(LocationListener listener);

void addOpenWindowListener(OpenWindowListener listener);

void addProgressListener(ProgressListener listener);

void addStatusTextListener(StatusTextListener listener);

void addTitleListener(TitleListener listener);

void addVisibilityWindowListener(VisibilityWindowListener listener);

bool back();

bool execute(String script);

bool forward();

String getText();

String getUrl();

Object getWebBrowser();

bool isBackEnabled();

bool isForwardEnabled();

void refresh();

void removeCloseWindowListener(CloseWindowListener listener);

void removeLocationListener(LocationListener listener);

void removeOpenWindowListener(OpenWindowListener listener);

void removeProgressListener(ProgressListener listener);

void removeStatusTextListener(StatusTextListener listener);

void removeTitleListener(TitleListener listener);

void removeVisibilityWindowListener(VisibilityWindowListener listener);

bool setText(String html);

bool setUrl(String url);

void stop();

}

Constructors

this this(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 <code>SWT</code> which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Members

Functions

addCloseWindowListener 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 <code>window.close</code> gets executed by a <code>Browser</code>.
addLocationListener 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 {@link #setUrl(String)} or when the user activates a hyperlink.
addOpenWindowListener 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 <code>window.open</code> gets executed by a <code>Browser</code>.
addProgressListener 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.
addStatusTextListener 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.
addTitleListener 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.
addVisibilityWindowListener 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.
back bool back(): Navigate to the previous session history item.
execute bool execute(String script): Execute the specified script.
forward bool forward(): Navigate to the next session history item.
getText String getText(): Returns a string with HTML that represents the content of the current page.
getUrl String getUrl(): Returns the current URL.
getWebBrowser Object getWebBrowser(): Returns the JavaXPCOM <code>nsIWebBrowser</code> for the receiver, or <code>null</code> if it is not available. In order for an <code>nsIWebBrowser</code> to be returned all of the following must be true: <ul> <li>the receiver's style must be <code>SWT.MOZILLA</code></li> <li>the classes from JavaXPCOM >= 1.8.1.2 must be resolvable at runtime</li> <li>the version of the underlying XULRunner must be >= 1.8.1.2</li> </ul>
isBackEnabled bool isBackEnabled(): Returns <code>true</code> if the receiver can navigate to the previous session history item, and <code>false</code> otherwise.
isForwardEnabled bool isForwardEnabled(): Returns <code>true</code> if the receiver can navigate to the next session history item, and <code>false</code> otherwise.
refresh void refresh(): Refresh the current page.
removeCloseWindowListener 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.
removeLocationListener 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.
removeOpenWindowListener void removeOpenWindowListener(OpenWindowListener listener): Removes the listener from the collection of listeners who will be notified when a new window needs to be created.
removeProgressListener 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.
removeStatusTextListener void removeStatusTextListener(StatusTextListener listener): Removes the listener from the collection of listeners who will be notified when the status text is changed.
removeTitleListener 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.
removeVisibilityWindowListener 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.
setText bool setText(String html): Renders HTML.
setUrl bool setUrl(String url): Loads a URL.
stop void stop(): Stop any loading and rendering activity.

Static functions

clearSessions void clearSessions(): Clears all session cookies from all current Browser instances.

Inherited Members

From Composite

changed void changed(Control[] changed): Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver. If an ancestor does not have a layout, it is skipped.
getBackgroundMode int getBackgroundMode(): Returns the receiver's background drawing mode. This will be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERTIT_FORCE</code>.
getChildren Control[] getChildren(): Returns a (possibly empty) array containing the receiver's children. Children are returned in the order that they are drawn. The topmost control appears at the beginning of the array. Subsequent controls draw beneath this control and appear later in the array. Note: This is not the actual structure used by the receiver to maintain its list of children, so modifying the array will not affect the receiver.
getLayout Layout getLayout(): Returns layout which is associated with the receiver, or null if one has not been set.
getLayoutDeferred bool getLayoutDeferred(): Returns <code>true</code> if the receiver has deferred the performing of layout, and <code>false</code> otherwise.
getTabList Control[] getTabList(): Gets the (possibly empty) tabbing order for the control.
isLayoutDeferred bool isLayoutDeferred(): Returns <code>true</code> if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts. Otherwise, <code>false</code> is returned.
layout void layout(): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing. This is equivalent to calling <code>layout(true)</code>. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the argument is <code>true</code> the layout must not rely on any information it has cached about the immediate children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing. If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed, bool all): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the changed argument is <code>true</code> the layout must not rely on any information it has cached about its children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the all argument is <code>true</code> the layout will cascade down through all child widgets in the receiver's widget tree, regardless of whether the child has changed size. The changed argument is applied to all layouts. If the all argument is <code>false</code>, the layout will not cascade down through all child widgets in the receiver's widget tree. However, if a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(Control[] changed): Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver. The layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
setBackgroundMode void setBackgroundMode(int mode): Sets the background drawing mode to the argument which should be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERIT_FORCE</code>.
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null.
setLayoutDeferred void setLayoutDeferred(bool defer): If the argument is <code>true</code>, causes subsequent layout operations in the receiver or any of its children to be ignored. No layout of any kind can occur in the receiver or any of its children until the flag is set to false. Layout operations that occurred while the flag was <code>true</code> are remembered and when the flag is set to <code>false</code>, the layout operations are performed in an optimized manner. Nested calls to this method are stacked.
setTabList void setTabList(Control[] tabList): Sets the tabbing order for the specified controls to match the order that they occur in the argument list.