Using the API documentation
Documentation for the application programming interface (API) is located on the MIPAV web site <http://mipav.cit.nih.gov/>. You can use the documentation directly on the web site. However, if your internet access is limited or slow, you can download, install, and use either a zipped version of the documentation on a Windows workstation or a tar version on a UNIX workstation.
</font></div>
Contents
To access the API documentation via the internet
1 Go to the MIPAV web site:< http://mipav.cit.nih.gov/>.
</font></div>
2 Click Development in the links on the left side of the page. The Development page appears. See Figure 2.
3 Here, use the following links: MIPAV APIand MIPAV XML based Formats.
To download and install the API documentation on a Windows workstation,
1 Under Documentation for download, select a zip-formatted version. Save the file to a directory of your choice.
2 Go to the directory, double-click api.zip, and extract the files. Extraction creates a directory named "api" under the directory you chose to place the files.
3 Open the api directory, and double-click index.html.
To download and install the API documentation on a UNIX workstation,
1 Under Documentation for download, select a tar.gz-formatted version. Save the file to a directory of your choice.
2 Go to the directory, double-click api.tar.gz, and extract the files. Extraction creates a catalogue named "api" under the directory you chose to place the files.
3 Open theapi directory, and double-click index.html. The API documentation appears in your browser.
Viewing MIPAV API documentation online
On the Development page, click the Application Programming Interface JavaDoc link <http://mipav.cit.nih.gov/documentation/api/index.html>. The API documentation page appears displaying the following three frames:
Top left frame -Shows all of the Java packages for the MIPAV application. When you select the All Classes link at the top of this frame, all of the classes in MIPAV appear in alphabetical order in the bottom left frame. If you select a particular package, the bottom left frame displays only the classes that pertain to the selected package.
Bottom left frame' -Lists either all of the classes in the MIPAV application or all of the classes in a selected package.
Right frame -Displays information based on the command that you select in the menu at the top of the frame:
Overview -Lists all of the packages in the MIPAV application
Package -Lists and summarizes all of the classes and interfaces in the package
Class or Interface -Lists descriptions, summary tables, and detailed member descriptions
Tree -Displays a hierarchy of the class or package
Index -Provides an alphabetical list of all classes, interfaces, constructors, methods, and fields
Help-Provides help for the API documentation
Several links appear beneath the menu.
Prev and Next -These links take you to the next or previous class, interface, package, or related page.
Frames and No Frames links -These links show and hide the HTML frames. All pages are available with or without frames. See Figure 3.
Overview page
The Overview page is the page that initially appears when you gain access to the API documentation. This page displays a list of all of the packages in MIPAV. The Overview menu becomes available after you move to another page. To return to the Overview page from the any other page, click Overview. The Overview page appears and displays a list of all of the packages in MIPAV.
Package page
When you select one of the packages listed on the Overview page, the Package page appears. This page provides a summary of each interface (if any), class, and exception (if any) in the package. When you click an interface or class, the Interface page or the Class page appears. Clicking an exception displays the Exception page. See Figure 4.
Interface or Class pages
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer. See also Figure 4.
Exception page
Tree (Class Hierarchy) page
Each hierarchy page contains a list of classes, interfaces, and exceptions (if any). The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
Deprecated API page
Index
Help page