The Webclient public API.

The first Webclient public API call in the application must be {@link org.mozilla.webclient.BrowserControlFactory#setAppData}. If embedding a native browser, the argument must be the fully qualified path name of the binary directory for the browser. If embedding a non-native browser, null must be passed to this method. This method must be called once and only once in the lifetime of the application.

For browsers that support the concept of "profiles" it must be possible to set the current profile used for this browsing session by calling {@link org.mozilla.webclient.BrowserControlFactory#setProfile}. This call must be made before the first BrowserControl instance is created. If not specified, the "webclient" profile is used to avoid overwriting any settings in the user's profile.

Upon from return from BrowserControlFactory.setAppData(), {@link org.mozilla.webclient.BrowserControlFactory#newBrowserControl} may be used to create one or more web browser instances. The returned {@link org.mozilla.webclient.BrowserControl} may then be queried, via {@link org.mozilla.webclient.BrowserControl#queryInterface} for additional features.

When the application is done with a BrowserControl instance, it must pass the instance to {@link org.mozilla.webclient.BrowserControlFactory#deleteBrowserControl}.

When the application no longer needs the Webclient API, it must call {@link org.mozilla.webclient.BrowserControlFactory#appTerminate}.


Last modified: Wed Mar 16 19:10:03 Eastern Standard Time 2005