www.averstar.com

AdaJava Binding Documentation

Go to AdaJava Binding API.

  • About this Documentation
  • How to Use this Documentation
  • Overview
  • Getting Around in Frames
  • Downloading this Documentation
  • How to Use a Local Version of the Java API
  • How this Documentation was Produced
  • About this Documentation

    The purpose of this documentation is to provide a reference for writing code using the AdaJava Binding developed by Intermetrics. We took advantage of the new technologies of frames and JavaScript to produce documentation that is flexible and easy to maneuver around. The window is split into two frames. The top frame is used for the Ada version of the packages in the AdaJava binding, and they contain links to the Java API. The bottom frame is used for the corresponding section of the Java API. The links to Java in the Ada frame are denoted by the image . They make the bottom frame jump to the corresponding section in the Java API which can be found by default on the web, or can be customized to be found in a location of your choice. (See How to Use a Local Version of the Java API) This documentation was designed for use with Netscape Navigator version 2 or higher or with Microsoft Internet Explorer version 3.0 or higher, and with the Java API version 1.0.2. Because of the long filenames, a 32-bit browser must be used if the AdaJava Binding documentation files are local.

    How to Use this Documentation

    Overview

    This documentation is designed for use particularly when developing software in a mixed Ada and Java environment, for example, if you are using AppletMagic to write Ada code, but you are working with a textbook that contains examples in Java. The pages are set up in frames so both the Ada and the Java version of a package can be visible at the same time. Each page contains a menu bar at the top with the options to go to the parent package, a listing of the child packages (if there are any), the overall package listing, or to return to this index page. The title of the package is next with the full name always shown. Next, the Ada spec is shown with an option to see the Java API version of the package in the lower frame. There are hypertext links within the document to the packages that it "withs" as well as to many of the functions and objects declared in the packages. Finally, if there are child packages, they are listed next with links to the Ada version of the packages, and an option to jump the bottom frame to the Java version of the package.

    Getting Around in Frames

    Maneuvering around in frames differs in the various browsers. In Netscape 2.01, to go back or forward in the frame, you must use the right mouse button. If you use the back and forward button on the Netscape toolbar, you go back to whatever the last whole document you were looking at rather than going back in the frame. There is no method to search within the frame with Netscape 2.01. Netscape version 3.0 improved its capabilities with frames, and allows you to go back and forward in the frames using the back and forward buttons, and Edit - Find searches the current frame. Internet Explorer 3.0 uses the back and forward buttons to go back and forward within a frame.

    Searching for test inside a frame workes with Netscape 3.0, but not Netscape 2.0 or Internet Explorer, so Netscape Navigator 3.0 is recommended for using this documentation.

    Downloading this Documentation

    Save a copy the file apidoc.tar.gz to the directory of your choice.

    In UNIX, use the commands

    	gzip -d apidoc.tar.gz
    	tar xvf apidoc.tar
    
    to inflate the files, then open the file "index.htm" with your web browser.

    In Windows95, the easiest way to unzip the files is using WinZip. Open the file apidoc.tar.gz in WinZip. A dialog box will appear with the message: "Compressed file contains one file: apidoc.tar Should WinZip decompress it to a temporary folder and open it?". Click the "Yes" button, and the files will be "untarred". Save the files to the directory of your choice, then open the file index.htm using your web browser.

    How to Use a Local Version of the Java API

    To use a local version of the Java API, you must edit the file "main.htm". In the line, "var javadir=..." you'll see by default the URL for the current version of the Java API. Delete the URL and insert your own location in it's place. The location must be written in the same syntax that your browser uses for locations on the web or in a file. For example:

    Original:

    var javadir="http://java.sun.com/java.sun.com/products/JDK/CurrentRelease/api/"
    

    Modified:

    var javadir="file:/path/api/"
    
    

    How this Documentation was Produced

    The body of this documentation was produced using David A. Wheeler's ada2html. This program takes Ada code, specs or bodies, and converts it into hypertext format. This is how the cross referencing inside Ada sources was produced. A limitation of ada2html is that it does not create hypertext links between Ada95 parent and child packages, nor does it automatically handle Java pragmas (due to limitations in the GNAT cross-reference tool). The listing of the child packages, the overall package listing, and the references to the Java API were not done using the program Ada2html.


    AdaJava Binding API.

    AppletMagic® Home Page.

    AverStar Home Page

    Comments about this page? Send feedback to webmaster@averstar.com.