STK Java API - Getting Help

The eclipse IDE has a fairly intuitive interface for creating and editing Java projects and comes with a help system that includes interactive tutorials. This page will therefore focus on ways of getting help on the STK X and STK Object Model components that are used in the STK Java API samples.

After installing and configuring the sample files, you can access the source code for any given project by expanding its tree and double-clicking the .java file of interest:

Getting help in the eclipse IDE

If you hover the mouse pointer over the name of an interface, method or other component, a tool tip will display with help on that component. To keep the tool tip from closing when you move the mouse, press the F2 key; then, when you are ready to close the tool tip, click the mouse anywhere on the screen.

You can also make help appear in the Javadoc tab at the bottom of the IDE. Simply click on the component of interest.

Displaying Javadocs outside the IDE

To display the Javadocs for the STK Java API outside the eclipse IDE, follow these steps:

1. Open the bin folder in the STK install directory, and right click on agi.javadocs.jar.
2. Open the agi.javadocs.jar in WinZip and extract the files to a convenient location, such as your desktop.
3. Open the folder into which you extracted the files, and double-click index.html.

The Javadocs will appear, in a format familiar to most Java users, in the web browser: