Prerequisites and Conventions

ILOG JViews Framework comes with online documentation in HTML, which may be accessed through standard HTML browsers. The documentation covers the development of diagram components through the GUI and with the Java API. There are separate reference manuals on using Java Server Faces (JSF) or DHTML JavaScript for deploying an application as a thin client.

What You Need to Know

The documentation for developing with the SDK is written for Java developers. It assumes that you can write Java code and that you are familiar with your Java development environment. You must be able to manipulate files and directories, use a text editor, and compile and run Java programs and applets.

Notation Conventions

The following naming conventions apply to the API:

• The names of classes defined in the ILOG JViews library begin with Ilv, for example IlvGraphic.
• The names of classes are written as concatenated words with each initial letter capitalized. For example:

  class IlvManagerServlet;

• Code extracts and file names appear in Courier font.
• Important terms are defined in the glossary and links to the definitions are provided as appropriate in text.
• Menu commands are written as Menu>Command, for example, File>Open.

The placeholder directory <installdir> designates the directory in which you installed ILOG JViews Framework. The default name provided by the installer is C:/ILOG. Note that the JViews Framework directory name, which is jviews-framework81, is fixed.