2.0 Alpha 9 Release Notes

READ THIS Before You Build and Install

Webclient is distributed as a mostly-binary release. The platform-dependent native code and the core webclient java code are pre-compiled. The binary distribution includes the complete webclient and MCP Java source code. This includes the code for the sample browser, sample MCP tests, JUnit tests, and the core webclient API and implementation. The Netbeans project included with the webclient distribution has build targets for the samples, as well as the core source code.

Webclient 2.0 Alpha 9 depends on xulrunner 1.8.1.3. If you build webclient from source, you must first build xulrunner. For instructions on building xulrunner please visit http://www.mozilla.org/build/.

Installing the 2.0 Release

This section explains how to install and run webclient using the binary distribution.

  1. Un-install any existing webclient installations.

  2. Install JDK 1.5 or later from http://java.sun.com/. Older JDKs may work but you're on your own for support.

  3. The binary distribution has a NetBeans 5.5 project file to ease building and running the automated and manual tests. It also has a non-ide build.xml file that allows building and running without an IDE. You can download NetBeans 5.5 from http://www.netbeans.org/. If you want to use the non-ide build file, you need Apache Ant, which can be downloaded from http://ant.apache.org/.

  4. Make a new empty directory, called WEBCLIENT_DIST for the purposes of discussion. The rest of the instructions will guide you in populating this directory.

  5. Download the approriate xulrunner for your platform.

    Windows: http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.1.3/contrib/win32/xulrunner-1.8.1.3.en-US.win32.zip. Unpack the zip directly to WEBCLIENT_DIST. It is strongly recommended that the path to WEBCLIENT_DIST contain no spaces.

    Mac OS X: http://mediacast.sun.com/share/edburns/xulrunner-1.8.1.3.en-US.mac-pkg.dmg. Copy the XUL.Framework from the mounted Disk Image to WEBCLIENT_DIST.

  6. Download the binary at http://www.mozilla.org/projects/blackwood/webclient/bin/webclient_2_0_a9_rc3.zip and unpack it into WEBCLIENT_DIST. This zip file that contains native binaries for all supported platforms.

    At this point, you should have the following directories in WEBCLIENT_DIST:

    webclient_2_0_a9/
  bin/
  javadocs/
  lib/
  netbeans/
  non-ide/
  test/
XULRUNNER_DIST

    The contents of these directories are as follows.

    webclient_2_0_a9/bin/PLATFORM/bin
    Native binaries for each supported OS
    webclient_2_0_a9/javadocs
    JavaDocs for the public API
    webclient_2_0_a9/lib
    Jar files for the public API and implementation
    webclient_2_0_a9/netbeans
    A Netbeans 5.5 project directory that allows easily building and running the automated tests and sample app.
    webclient_2_0_a9/non-ide
    A build.xml file for building and running the webclient tests and example browser without an IDE.
    webclient_2_0_a9/test
    The source files for the automated tests and sample app.
    XULRUNNER_DIST
    The root directory of the xulrunner binary dist. The name of this directory will vary from platform to platform.

  7. IMPORTANT Before launching NetBeans or running ant, make sure the directory under XULRUNNER_DIST that contains the actual xulrunner executable has been added to the platform appropriate environment variables.

  8. If you are using NetBeans

    1. Using the same command shell where you successfully ran the xulrunner command, start NetBeans 5.5 and use the File->Open Project... dialog to open the "netbeans" directory in the WEBCLIENT_DIST/webclient_2_0_a9 directory.

    2. Go to the "Files" tab, open the "webclient" node and edit the "webclient.properties" file.

      Adjust the browser.bin.dir property to point to the absolute path to the xulrunner directory.

        Win32

        This is the directory that contains the xulrunner.exe file. It is the same directory you added to the PATH. IMPORTANT: make sure this property does not contain any spaces and any backslashes in the path are escaped. On win32, you may have to use the funky "~" syntax. For example, Program Files may become PROGRA~1 and Documents and Settings may become DOCUME~1. To see what the "~" syntax is in your case do a dir /x in the parent directory.

        For example, on my machine, browser.bin.dir is C:\\DOCUME~1\\edburns\\MYDOCU~1\\tmp\\webclient-alpha\\xulrunner.

        Mac OS X:

        This is the directory that contains the XUL library file. It is the same directory you added to the DYLD_LIBRARY_PATH.

        For example, on my machine, browser.bin.dir is /Users/edburns/Projects/chaff/XUL.framework/Versions/1.8.1.3.

    3. Save the modified webclient.properties file.

    4. Back in the Project tab, Right-click on the "webclient" entry in the tree view and choose "Build Project".

    5. Once the project builds successfully, you may "run" or "test" it using the netbeans commands.

  9. If you are using the non-ide build with ant

    1. Using the same command shell in which you executed the xulrunner command, cd to the non-ide directory and copy build.properties.sample to build.properties. Edit the file according to the environment of your system. The same constraints about spaces and backslash characters apply here, as in the above steps for NetBeans.

    2. Run ant -projecthelp to see what targets are available.

Building the 2.0 Alpha 9 Release

Build Instructions -- Cross Platform

These instructions cover how to build the java source for webclient using netbeans, included in the binary distribution. Instructions for building the native code are still pending.

  1. Install the binary, as above.

  2. Open the netbeans project and Go to the "Files" tab.

  3. Expand the webclient node in the tree viewer. Expand the build.xml node. Right click on the "compile.core. src" target and select "Run Target". This will move aside the webclient jar and compile the core sources into the build directory.

Uninstalling the 2.0 Alpha 8 Build

Uninstalling

  1. Stop any running mozilla or webclient instances

  2. Run the "clean" ant target.

Available and Unavailable Features

New Features for This Release

New package org.mozilla.mcp for easy automated testing of Ajax web applications. Please see the javadoc package description for usage instructions.

This package now includes a timeout facility

New Features from Previous Releases

The following methods are known to work. 


BrowserControlFactory.setAppData()

BrowserControlFactory.newBrowserControl()

BrowserControlFactory.deleteBrowserControl()

BrowserControlFactory.appTerminate()

BrowserControl.queryInterface() for the following interfaces

  BrowserControl.HISTORY_NAME
  BrowserControl.BROWSER_CONTROL_CANVAS_NAME
  BrowserControl.EVENT_REGISTRATION_NAME
  BrowserControl.NAVIGATION_NAME
  BrowserControl.CURRENT_PAGE_NAME

CurrentPage.getSelection()
CurrentPage.copyCurrentSelectionToSystemClipboard()
CurrentPage.copyCurrentSelectionHtmlToSystemClipboard()
CurrentPage.getCurrentURL()
CurrentPage.find()
CurrentPage.findNext()
CurrentPage.getDOM() (including getElementById())
CurrentPage.highlightSelection()
CurrentPage.selectAll()
CurrentPage.clearAllSelections()
CurrentPage.printPreview()
CurrentPage.getSource()


EventRegistration.addDocumentLoadListener() (including PageInfoListener)
EventRegistration.removeDocumentLoadListener()

History.canBack()
History.canForward()
History.back()
History.forward()

Full support for Java AWT KeyListener and MouseListener.

Navigation.loadURL()
Navigation.loadFromStream()
Navigation.refresh()
Navigation.stop()
Navigation.post()

Support for new windows popped up by the browser with chrome supplied
from Java.

Known Issues

Browser and General Issues

Printing

Printing is not yet implemented.

Plugins

You can run plugins inside webclient, but on win32, the Java plugin will not work. You must remove the java plugin. Please see the section on installing the win32 binary in this file.

Bookmarks and History

Bookmarks is not supported with XULRunner. Both the Bookmarks and History interfaces are incompletely implemented.

Profiles

If webclient is acting funny, it may be due to conflicting mozilla registry file. Follow the steps in the mozilla 1.8 release notes to remove the registry, then re-run mozilla 1.8 to generate a new registry.

Known Bugs